pipeline.hifv.cli.gotasks.hifv_restoredata

pipeline.hifv.cli.gotasks.hifv_restoredata = <pipeline.hifv.cli.gotasks.hifv_restoredata._hifv_restoredata object>

hifv_restoredata —- Restore flagged and calibration interferometry data from a pipeline run

The hifv_restoredata restores flagged and calibrated data from archived ASDMs and pipeline flagging and calibration data products. Pending archive retrieval support hifv_restoredata assumes that the required products are available in the rawdata_dir in the format produced by the hifv_exportdata task.

hifv_restoredata assumes that the following entities are available in the raw data directory

o the ASDMs to be restored o for each ASDM in the input list o a compressed tar file of the final flagversions file, e.g. uid___A002_X30a93d_X43e.ms.flagversions.tar.gz o a text file containing the applycal instructions, e.g. uid___A002_X30a93d_X43e.ms.calapply.txt o a compressed tar file containing the caltables for the parent session, e.g. uid___A001_X74_X29.session_3.caltables.tar.gz

hifv_restoredata performs the following operations

o imports the ASDM(s)) o removes the default MS.flagversions directory created by the filler o restores the final MS.flagversions directory stored by the pipeline o restores the final set of pipeline flags to the MS o restores the final calibration state of the MS o restores the final calibration tables for each MS o applies the calibration tables to each MS

Output:

results – If pipeline mode is ‘getinputs’ then None is returned. Otherwise the results object for the pipeline task is returned.

——— parameter descriptions ———————————————

vis List of visibility data files. These may be ASDMs, tar files of ASDMs,

MSes, or tar files of MSes, If ASDM files are specified, they will be converted to MS format. example: vis=[‘X227.ms’, ‘asdms.tar.gz’]

session List of sessions one per visibility file. Only can be set in pipelinemode=’interactive’.

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. Only can be set in pipelinemode=’interactive’. example: products_dir=’myproductspath’

copytoraw Copy calibration and flagging tables from products_dir to

rawdata_dir directory. Only can be set in pipelinemode=’interactive’. Example: copytoraw=False.

rawdata_dir The rawdata directory.

Only can be set in pipelinemode=’interactive’. Example: rawdata_dir=’myrawdatapath’

lazy Use the lazy filler option. Only can be set in pipelinemode=’interactive’. bdfflags Set the BDF flags. Only can be set in pipelinemode=’interactive’. ocorr_mode Correlation import mode gainmap If True, map gainfields to a particular list of scans when

applying calibration tables.

asis List of tables to import asis. Only can be set in pipelinemode=’interactive’. pipelinemode The pipeline operating mode. In ‘automatic’ mode the pipeline

determines the values of all context defined pipeline inputs automatically. In ‘interactive’ mode the user can set the pipeline context defined parameters manually. In ‘getinputs’ mode the user can check the settings of all pipeline parameters without running the task.

dryrun Run the commands (True) or generate the commands to be run but

do not execute (False). This is a pipeline task execution mode.

acceptresults Add the results of the task to the pipeline context (True) or

reject them (False). This is a pipeline task execution mode.

——— examples ———————————————————–

Examples

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

hifv_restoredata (vis=[‘myVLAsdm’], session=[‘session_1’], ocorr_mode=’ca’)