pipeline.hsd.cli.hsd_restoredata

hsd_restoredata(vis: list[str] = None, session: str | None = None, products_dir: str | None = None, copytoraw: bool | None = None, rawdata_dir: str | None = None, lazy: bool | None = None, bdfflags: bool | None = None, ocorr_mode: str | None = None, asis: str | None = None, hm_rasterscan: str | None = None) → Results[source]

Restore flagged and calibration single dish data from a pipeline run.

The hsd_restoredata task restores flagged and calibrated MeasurementSets from archived ASDMs and pipeline flagging and calibration data products.

hsd_restoredata assumes that the ASDMs to be restored are present in the directory specified by the rawdata_dir (default: '../rawdata').

By default (copytoraw = True), hsd_restoredata assumes that for each ASDM in the input list, the corresponding pipeline flagging and calibration data products (in the format produced by the hsd_exportdata task) are present in the directory specified by products_dir (default: '../products'). At the start of the task, these products are copied from the products_dir to the rawdata_dir.

If copytoraw = False, hsd_restoredata assumes that these products are to be found in rawdata_dir along with the ASDMs.

The expected flagging and calibration products (for each ASDM) include:

  • a compressed tar file of the final flagversions file, e.g. uid___A002_X30a93d_X43e.ms.flagversions.tar.gz

  • a text file containing the applycal instructions, e.g. uid___A002_X30a93d_X43e.ms.calapply.txt

  • a compressed tar file containing the caltables for the parent session, e.g. uid___A001_X74_X29.session_3.caltables.tar.gz

hsd_restoredata performs the following operations:

  • imports the ASDM(s)

  • removes the default MS.flagversions directory created by the filler

  • restores the final MS.flagversions directory stored by the pipeline

  • restores the final set of pipeline flags to the MS

  • restores the final calibration state of the MS

  • restores the final calibration tables for each MS

  • applies the calibration tables to each MS

When importing the ASDM and converting it to a MeasurementSet (MS), if the output MS already exists in the output directory, then the importasdm conversion step is skipped, and the existing MS will be imported instead.

Parameters:

  • vis --

    List of raw visibility data files to be restored. Assumed to be in the directory specified by rawdata_dir.

    Example: vis=['uid___A002_X30a93d_X43e']

  • session --

    List of sessions one per visibility file.

    Example: session=['session_3']

  • products_dir --

    Name of the data products directory to copy calibration products from. The parameter is effective only when copytoraw=True. When copytoraw=False, calibration products in rawdata_dir will be used.

    Example: products_dir='myproductspath'

    Default: None (equivalent to '../products')

  • copytoraw --

    Copy calibration and flagging tables from products_dir to rawdata_dir directory.

    Example: copytoraw=False

    Default: None (equivalent to True)

  • rawdata_dir --

    Name of the raw data directory.

    Example: rawdata_dir='myrawdatapath'

    Default: None (equivalent to '../rawdata')

  • lazy --

    Use the lazy filler option.

    Example: lazy=True

    Default: None (equivalent to False)

  • bdfflags --

    Apply BDF flags on import.

    Example: bdfflags=False

    Default: None (equivalent to True)

  • ocorr_mode --

    Selection of baseline correlation to import. Valid only if input visibility is ASDM. See a document of CASA, casatasks::importasdm, for available options.

    Example: ocorr_mode='ca'

    Default: None (equivalent to 'ao')

  • asis --

    Creates verbatim copies of the ASDM tables in the output MS. The value given to this option must be a list of table names separated by space characters. Default value, None, is equivalent to the following list.

    'SBSummary ExecBlock Annotation Antenna Station Receiver Source CalAtmosphere CalWVR SpectralWindow'

    Example: asis='Source Receiver'

  • hm_rasterscan --

    Heuristics method for raster scan analysis. Two analysis modes, time-domain analysis ('time') and direction analysis ('direction'), are available.

    Default: None (equivalent to 'time')

Returns:

The results object for the pipeline task is returned.

Examples

  1. Restore the pipeline results for a single ASDM in a single session

>>> hsd_restoredata (vis=['uid___A002_X30a93d_X43e'], session=['session_1'], ocorr_mode='ao')