decode.qlook module#

auto(dems: Path, /, **options: Any) → Path[source]#

Quick-look at an observation with auto-selected command.

The used command will be selected based on the observation name stored as the observation attribute in an input DEMS file.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • **options (Any) – Options for the selected command. See the command help for all available options.

Returns:

Absolute path of the saved file.

Return type:

Path

daisy(dems: Path, /, *, include_mkid_ids: Sequence[int] | None = None, exclude_mkid_ids: Sequence[int] | None = None, min_frequency: str | None = None, max_frequency: str | None = None, data_type: Literal['auto', 'brightness', 'df/f'] = 'auto', rolling_time: int = 200, source_radius: str = '60 arcsec', chan_weight: Literal['uniform', 'std', 'std/tx'] = 'std/tx', pwv: Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0'] = '5.0', skycoord_grid: str = '6 arcsec', skycoord_units: str = 'arcsec', format: str = 'png', outdir: Path = PosixPath('.'), overwrite: bool = False, suffix: str = 'daisy', debug: bool = False, **options: Any) → Path[source]#

Quick-look at a daisy scan observation.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • include_mkid_ids (Sequence[int] | None) – MKID IDs to be included in analysis. Defaults to all MKID IDs.

  • exclude_mkid_ids (Sequence[int] | None) – MKID IDs to be excluded in analysis. Defaults to no MKID IDs.

  • min_frequency (str | None) – Minimum frequency to be included in analysis. Defaults to no minimum frequency bound.

  • max_frequency (str | None) – Maximum frequency to be included in analysis. Defaults to no maximum frequency bound.

  • data_type (Literal['auto', 'brightness', 'df/f']) – Data type of the input DEMS file. Defaults to the long_name attribute in it.

  • rolling_time (int) – Moving window size.

  • source_radius (str) – Radius of the on-source area. Other areas are considered off-source in sky subtraction.

  • chan_weight (Literal['uniform', 'std', 'std/tx']) – Weighting method along the channel axis. uniform: Uniform weight (i.e. no channel dependence). std: Inverse square of temporal standard deviation of sky. std/tx: Same as std but std is divided by the atmospheric transmission calculated by the ATM model.

  • pwv (Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0']) – PWV in units of mm. Only used for the calculation of the atmospheric transmission when chan_weight is std/tx.

  • skycoord_grid (str) – Grid size of the sky coordinate axes.

  • skycoord_units (str) – Units of the sky coordinate axes.

  • format (str) – Output image format of quick-look result.

  • outdir (Path) – Output directory for the quick-look result.

  • overwrite (bool) – Whether to overwrite the output if it exists.

  • suffix (str) – Suffix that precedes the file extension.

  • debug (bool) – Whether to print detailed logs for debugging.

  • **options (Any) – Other options for saving the output (e.g. dpi).

Returns:

Absolute path of the saved file.

Return type:

Path

pswsc(dems: Path, /, *, include_mkid_ids: Sequence[int] | None = None, exclude_mkid_ids: Sequence[int] | None = None, min_frequency: str | None = None, max_frequency: str | None = None, data_type: Literal['auto', 'brightness', 'df/f'] = 'auto', frequency_units: str = 'GHz', format: str = 'png', outdir: Path = PosixPath('.'), overwrite: bool = False, suffix: str = 'pswsc', debug: bool = False, **options: Any) → Path[source]#

Quick-look at a PSW observation with sky chopper.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • include_mkid_ids (Sequence[int] | None) – MKID IDs to be included in analysis. Defaults to all MKID IDs.

  • exclude_mkid_ids (Sequence[int] | None) – MKID IDs to be excluded in analysis. Defaults to no MKID IDs.

  • min_frequency (str | None) – Minimum frequency to be included in analysis. Defaults to no minimum frequency bound.

  • max_frequency (str | None) – Maximum frequency to be included in analysis. Defaults to no maximum frequency bound.

  • data_type (Literal['auto', 'brightness', 'df/f']) – Data type of the input DEMS file. Defaults to the long_name attribute in it.

  • frequency_units (str) – Units of the frequency axis.

  • format (str) – Output data format of the quick-look result.

  • outdir (Path) – Output directory for the quick-look result.

  • overwrite (bool) – Whether to overwrite the output if it exists.

  • suffix (str) – Suffix that precedes the file extension.

  • debug (bool) – Whether to print detailed logs for debugging.

  • **options (Any) – Other options for saving the output (e.g. dpi).

Returns:

Absolute path of the saved file.

Return type:

Path

raster(dems: Path, /, *, include_mkid_ids: Sequence[int] | None = None, exclude_mkid_ids: Sequence[int] | None = None, min_frequency: str | None = None, max_frequency: str | None = None, data_type: Literal['auto', 'brightness', 'df/f'] = 'auto', chan_weight: Literal['uniform', 'std', 'std/tx'] = 'std/tx', pwv: Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0'] = '5.0', skycoord_grid: str = '6 arcsec', skycoord_units: str = 'arcsec', format: str = 'png', outdir: Path = PosixPath('.'), overwrite: bool = False, suffix: str = 'raster', debug: bool = False, **options: Any) → Path[source]#

Quick-look at a raster scan observation.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • include_mkid_ids (Sequence[int] | None) – MKID IDs to be included in analysis. Defaults to all MKID IDs.

  • exclude_mkid_ids (Sequence[int] | None) – MKID IDs to be excluded in analysis. Defaults to no MKID IDs.

  • min_frequency (str | None) – Minimum frequency to be included in analysis. Defaults to no minimum frequency bound.

  • max_frequency (str | None) – Maximum frequency to be included in analysis. Defaults to no maximum frequency bound.

  • data_type (Literal['auto', 'brightness', 'df/f']) – Data type of the input DEMS file. Defaults to the long_name attribute in it.

  • chan_weight (Literal['uniform', 'std', 'std/tx']) – Weighting method along the channel axis. uniform: Uniform weight (i.e. no channel dependence). std: Inverse square of temporal standard deviation of sky. std/tx: Same as std but std is divided by the atmospheric transmission calculated by the ATM model.

  • pwv (Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0']) – PWV in units of mm. Only used for the calculation of the atmospheric transmission when chan_weight is std/tx.

  • skycoord_grid (str) – Grid size of the sky coordinate axes.

  • skycoord_units (str) – Units of the sky coordinate axes.

  • format (str) – Output image format of quick-look result.

  • outdir (Path) – Output directory for the quick-look result.

  • overwrite (bool) – Whether to overwrite the output if it exists.

  • suffix (str) – Suffix that precedes the file extension.

  • debug (bool) – Whether to print detailed logs for debugging.

  • **options (Any) – Other options for saving the output (e.g. dpi).

Returns:

Absolute path of the saved file.

Return type:

Path

skydip(dems: Path, /, *, include_mkid_ids: Sequence[int] | None = None, exclude_mkid_ids: Sequence[int] | None = None, min_frequency: str | None = None, max_frequency: str | None = None, data_type: Literal['auto', 'brightness', 'df/f'] = 'auto', chan_weight: Literal['uniform', 'std', 'std/tx'] = 'std/tx', pwv: Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0'] = '5.0', format: str = 'png', outdir: Path = PosixPath('.'), overwrite: bool = False, suffix: str = 'skydip', debug: bool = False, **options: Any) → Path[source]#

Quick-look at a skydip observation.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • include_mkid_ids (Sequence[int] | None) – MKID IDs to be included in analysis. Defaults to all MKID IDs.

  • exclude_mkid_ids (Sequence[int] | None) – MKID IDs to be excluded in analysis. Defaults to no MKID IDs.

  • min_frequency (str | None) – Minimum frequency to be included in analysis. Defaults to no minimum frequency bound.

  • max_frequency (str | None) – Maximum frequency to be included in analysis. Defaults to no maximum frequency bound.

  • data_type (Literal['auto', 'brightness', 'df/f']) – Data type of the input DEMS file. Defaults to the long_name attribute in it.

  • chan_weight (Literal['uniform', 'std', 'std/tx']) – Weighting method along the channel axis. uniform: Uniform weight (i.e. no channel dependence). std: Inverse square of temporal standard deviation of sky. std/tx: Same as std but std is divided by the atmospheric transmission calculated by the ATM model.

  • pwv (Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0']) – PWV in units of mm. Only used for the calculation of the atmospheric transmission when chan_weight is std/tx.

  • format (str) – Output image format of quick-look result.

  • outdir (Path) – Output directory for the quick-look result.

  • overwrite (bool) – Whether to overwrite the output if it exists.

  • suffix (str) – Suffix that precedes the file extension.

  • debug (bool) – Whether to print detailed logs for debugging.

  • **options (Any) – Other options for saving the output (e.g. dpi).

Returns:

Absolute path of the saved file.

Return type:

Path

still(dems: Path, /, *, include_mkid_ids: Sequence[int] | None = None, exclude_mkid_ids: Sequence[int] | None = None, min_frequency: str | None = None, max_frequency: str | None = None, data_type: Literal['auto', 'brightness', 'df/f'] = 'auto', chan_weight: Literal['uniform', 'std', 'std/tx'] = 'std/tx', pwv: Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0'] = '5.0', format: str = 'png', outdir: Path = PosixPath('.'), overwrite: bool = False, suffix: str = 'still', debug: bool = False, **options: Any) → Path[source]#

Quick-look at a still observation.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • include_mkid_ids (Sequence[int] | None) – MKID IDs to be included in analysis. Defaults to all MKID IDs.

  • exclude_mkid_ids (Sequence[int] | None) – MKID IDs to be excluded in analysis. Defaults to no MKID IDs.

  • min_frequency (str | None) – Minimum frequency to be included in analysis. Defaults to no minimum frequency bound.

  • max_frequency (str | None) – Maximum frequency to be included in analysis. Defaults to no maximum frequency bound.

  • data_type (Literal['auto', 'brightness', 'df/f']) – Data type of the input DEMS file. Defaults to the long_name attribute in it.

  • chan_weight (Literal['uniform', 'std', 'std/tx']) – Weighting method along the channel axis. uniform: Uniform weight (i.e. no channel dependence). std: Inverse square of temporal standard deviation of sky. std/tx: Same as std but std is divided by the atmospheric transmission calculated by the ATM model.

  • pwv (Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0']) – PWV in units of mm. Only used for the calculation of the atmospheric transmission when chan_weight is std/tx.

  • format (str) – Output data format of the quick-look result.

  • outdir (Path) – Output directory for the quick-look result.

  • overwrite (bool) – Whether to overwrite the output if it exists.

  • suffix (str) – Suffix that precedes the file extension.

  • debug (bool) – Whether to print detailed logs for debugging.

  • **options (Any) – Other options for saving the output (e.g. dpi).

Returns:

Absolute path of the saved file.

Return type:

Path

xscan(dems: Path, /, *, include_mkid_ids: Sequence[int] | None = None, exclude_mkid_ids: Sequence[int] | None = None, min_frequency: str | None = None, max_frequency: str | None = None, data_type: Literal['auto', 'brightness', 'df/f'] = 'auto', chan_weight: Literal['uniform', 'std', 'std/tx'] = 'std/tx', pwv: Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0'] = '5.0', format: str = 'png', outdir: Path = PosixPath('.'), overwrite: bool = False, suffix: str = 'zscan', debug: bool = False, **options: Any) → Path[source]#

Quick-look at an observation of subref X-axis focus scan.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • include_mkid_ids (Sequence[int] | None) – MKID IDs to be included in analysis. Defaults to all MKID IDs.

  • exclude_mkid_ids (Sequence[int] | None) – MKID IDs to be excluded in analysis. Defaults to no MKID IDs.

  • min_frequency (str | None) – Minimum frequency to be included in analysis. Defaults to no minimum frequency bound.

  • max_frequency (str | None) – Maximum frequency to be included in analysis. Defaults to no maximum frequency bound.

  • data_type (Literal['auto', 'brightness', 'df/f']) – Data type of the input DEMS file. Defaults to the long_name attribute in it.

  • chan_weight (Literal['uniform', 'std', 'std/tx']) – Weighting method along the channel axis. uniform: Uniform weight (i.e. no channel dependence). std: Inverse square of temporal standard deviation of sky. std/tx: Same as std but std is divided by the atmospheric transmission calculated by the ATM model.

  • pwv (Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0']) – PWV in units of mm. Only used for the calculation of the atmospheric transmission when chan_weight is std/tx.

  • format (str) – Output image format of quick-look result.

  • outdir (Path) – Output directory for the quick-look result.

  • overwrite (bool) – Whether to overwrite the output if it exists.

  • suffix (str) – Suffix that precedes the file extension.

  • debug (bool) – Whether to print detailed logs for debugging.

  • **options (Any) – Other options for saving the output (e.g. dpi).

Returns:

Absolute path of the saved file.

Return type:

Path

yscan(dems: Path, /, *, include_mkid_ids: Sequence[int] | None = None, exclude_mkid_ids: Sequence[int] | None = None, min_frequency: str | None = None, max_frequency: str | None = None, data_type: Literal['auto', 'brightness', 'df/f'] = 'auto', chan_weight: Literal['uniform', 'std', 'std/tx'] = 'std/tx', pwv: Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0'] = '5.0', format: str = 'png', outdir: Path = PosixPath('.'), overwrite: bool = False, suffix: str = 'zscan', debug: bool = False, **options: Any) → Path[source]#

Quick-look at an observation of subref Y-axis focus scan.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • include_mkid_ids (Sequence[int] | None) – MKID IDs to be included in analysis. Defaults to all MKID IDs.

  • exclude_mkid_ids (Sequence[int] | None) – MKID IDs to be excluded in analysis. Defaults to no MKID IDs.

  • min_frequency (str | None) – Minimum frequency to be included in analysis. Defaults to no minimum frequency bound.

  • max_frequency (str | None) – Maximum frequency to be included in analysis. Defaults to no maximum frequency bound.

  • data_type (Literal['auto', 'brightness', 'df/f']) – Data type of the input DEMS file. Defaults to the long_name attribute in it.

  • chan_weight (Literal['uniform', 'std', 'std/tx']) – Weighting method along the channel axis. uniform: Uniform weight (i.e. no channel dependence). std: Inverse square of temporal standard deviation of sky. std/tx: Same as std but std is divided by the atmospheric transmission calculated by the ATM model.

  • pwv (Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0']) – PWV in units of mm. Only used for the calculation of the atmospheric transmission when chan_weight is std/tx.

  • format (str) – Output image format of quick-look result.

  • outdir (Path) – Output directory for the quick-look result.

  • overwrite (bool) – Whether to overwrite the output if it exists.

  • suffix (str) – Suffix that precedes the file extension.

  • debug (bool) – Whether to print detailed logs for debugging.

  • **options (Any) – Other options for saving the output (e.g. dpi).

Returns:

Absolute path of the saved file.

Return type:

Path

zscan(dems: Path, /, *, include_mkid_ids: Sequence[int] | None = None, exclude_mkid_ids: Sequence[int] | None = None, min_frequency: str | None = None, max_frequency: str | None = None, data_type: Literal['auto', 'brightness', 'df/f'] = 'auto', chan_weight: Literal['uniform', 'std', 'std/tx'] = 'std/tx', pwv: Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0'] = '5.0', format: str = 'png', outdir: Path = PosixPath('.'), overwrite: bool = False, suffix: str = 'zscan', debug: bool = False, **options: Any) → Path[source]#

Quick-look at an observation of subref Z-axis focus scan.

Parameters:

  • dems (Path) – Input DEMS file (netCDF or Zarr).

  • include_mkid_ids (Sequence[int] | None) – MKID IDs to be included in analysis. Defaults to all MKID IDs.

  • exclude_mkid_ids (Sequence[int] | None) – MKID IDs to be excluded in analysis. Defaults to no MKID IDs.

  • min_frequency (str | None) – Minimum frequency to be included in analysis. Defaults to no minimum frequency bound.

  • max_frequency (str | None) – Maximum frequency to be included in analysis. Defaults to no maximum frequency bound.

  • data_type (Literal['auto', 'brightness', 'df/f']) – Data type of the input DEMS file. Defaults to the long_name attribute in it.

  • chan_weight (Literal['uniform', 'std', 'std/tx']) – Weighting method along the channel axis. uniform: Uniform weight (i.e. no channel dependence). std: Inverse square of temporal standard deviation of sky. std/tx: Same as std but std is divided by the atmospheric transmission calculated by the ATM model.

  • pwv (Literal['0.5', '1.0', '2.0', '3.0', '4.0', '5.0']) – PWV in units of mm. Only used for the calculation of the atmospheric transmission when chan_weight is std/tx.

  • format (str) – Output image format of quick-look result.

  • outdir (Path) – Output directory for the quick-look result.

  • overwrite (bool) – Whether to overwrite the output if it exists.

  • suffix (str) – Suffix that precedes the file extension.

  • debug (bool) – Whether to print detailed logs for debugging.

  • **options (Any) – Other options for saving the output (e.g. dpi).

Returns:

Absolute path of the saved file.

Return type:

Path

On this page
Show Source