pipeline.hifa.cli.hifa_importdata

pipeline.hifa.cli.hifa_importdata = <pipeline.hifa.cli.hifa_importdata._hifa_importdata object>

hifa_importdata —- Imports data into the interferometry pipeline

Imports data into the interferometry pipeline.

——— 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 visibility data sessions 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.

asis Extra ASDM tables to convert as is process_caldevice Import the caldevice table from the ASDM overwrite Overwrite existing files on import nocopy Disable copying of MS to working directory bdfflags Apply BDF flags on import asimaging Import MeasurementSets as imaging MeasurementSets lazy Use the lazy filler import dbservice Use the online flux catalog ocorr_mode ALMA default set to ca createmms Create an MMS minparang Minimum required parallactic angle range for polarisation calibrator,

in degrees. The default of 0.0 is used for non-polarisation processing.

dryrun Run the task (False) or display task command (True) acceptresults Add the results into the pipeline context

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

The hifa_importdata task loads the specified visibility data into the pipeline context unpacking and / or converting it as necessary.

Keyword arguments

—- pipeline parameter arguments which can be set in any pipeline mode

session – List of sessions to which the visibility files belong. Defaults to a single session containing all the visibility files, otherwise a session must be assigned to each vis file.

default: [] example: session=[‘session_1’, ‘session_2’]

—- pipeline context defined parameter argument which can be set only in ‘interactive mode’

asis – ASDM tables to convert as is.

default: ‘SBSummary ExecBlock Antenna Station Receiver Source CalAtmosphere CalWVR’ example: asis=’Receiver’, asis=’’

process_caldevice – Ingest the ASDM caldevice table.

default: False example: process_caldevice=True

overwrite – Overwrite existing MSes on output.

default: False

nocopy – When importing an MS, disable copying of the MS to the working directory.

default: False

bdfflags – Apply BDF flags on line.

default: True

ocorr_mode – Read in cross- and auto-correlation data(ca), cross- correlation data only (co), or autocorrelation data only (ao).

default: ca

lazy – Use the lazy filter import.

default: False

dbservice – Use online flux catalog on import.

default: False

ocorr_mode – Read in cross- and auto-correlation data(ca), cross- correlation data only (co), or autocorrelation data only (ao).

default: ca

createmms – Create a multi-MeasurementSet (‘true’) ready for full parallel processing, or a standard MeasurementSet (‘false’). The default setting (‘automatic’) creates an MMS if running in a cluster environment.

default: ‘false’

— pipeline task execution modes

dryrun – Run the commands (True) or generate the commands to be run but do not execute (False).

default: True

acceptresults – Add the results of the task to the pipeline context (True) or reject them (False).

default: True

Output

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

Examples

  1. Load an ASDM list in the ../rawdata subdirectory into the context:

hifa_importdata(vis=[‘../rawdata/uid___A002_X30a93d_X43e’, ‘../rawdata/uid_A002_x30a93d_X44e’])

  1. Load an MS in the current directory into the context:

hifa_importdata(vis=[uid___A002_X30a93d_X43e.ms])

  1. Load a tarred ASDM in ../rawdata into the context:

hifa_importdata(vis=[‘../rawdata/uid___A002_X30a93d_X43e.tar.gz’])

  1. Check the hif_importdata inputs, then import the data:

myvislist = [‘uid___A002_X30a93d_X43e.ms’, ‘uid_A002_x30a93d_X44e.ms’] hifa_importdata(vis=myvislist, pipelinemode=’getinputs’) hifa_importdata(vis=myvislist)

  1. Load an ASDM but check the results before accepting them into the context.

results = hifa_importdata(vis=[‘uid___A002_X30a93d_X43e.ms’], acceptresults=False) results.accept()

  1. Run in dryrun mode before running for real:

results = hifa_importdata(vis=[‘uid___A002_X30a93d_X43e.ms’], dryrun=True) results = hifa_importdata(vis=[‘uid___A002_X30a93d_X43e.ms’])