pipeline.hsd.cli.hsd_importdata

hsd_importdata(vis: list[str] | None = None, session: list[str] | None = None, hm_rasterscan: str | None = None, parallel: str | bool | None = None, asis: str | None = None, process_caldevice: bool | None = None, overwrite: bool | None = None, nocopy: bool | None = None, bdfflags: bool | None = None, datacolumns: dict | None = None, lazy: bool | None = None, with_pointing_correction: bool | None = None, createmms: str | None = None) → ResultsList[Results][source]

Imports data into the single dish pipeline.

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

If the overwrite input parameter is set to False and the task is asked to convert an input ASDM input to an MS, then when the output MS already exists in the output directory, the importasdm conversion step is skipped, and the existing MS will be imported instead.

Parameters:

  • 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 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.

    Example: session=['Session_1', 'Sessions_2']

  • 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')

  • parallel --

    Execute using CASA HPC functionality, if available.

    Options: 'automatic', 'true', 'false', True, False

    Default: None (equivalent to 'automatic')

  • 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: 'Receiver', ''

  • process_caldevice --

    Import the ASDM caldevice table.

    Example: True

    Default: None (equivalent to True)

  • overwrite --

    Overwrite existing files on import. When converting ASDM to MS, if overwrite=False and the MS already exists in output directory, then this existing MS dataset will be used instead.

    Default: None (equivalent to False)

  • nocopy -- Disable copying of MS to working directory

  • bdfflags -- Apply BDF flags on import.

  • datacolumns --

    Dictionary defining the data types of existing columns. The format is:

    {'data': 'data type 1'}

    or

    {'data': 'data type 1', 'corrected': 'data type 2'}

    For ASDMs the data type can only be RAW and one can only specify it for the data column. For MSes one can define two different data types for the DATA and CORRECTED_DATA columns and they can be any of the known data types (RAW, REGCAL_CONTLINE_ALL, REGCAL_CONTLINE_SCIENCE, SELFCAL_CONTLINE_SCIENCE, REGCAL_LINE_SCIENCE, SELFCAL_LINE_SCIENCE, BASELINED, ATMCORR). The intent selection strings _ALL or _SCIENCE can be skipped. In that case the task determines this automatically by inspecting the existing intents in the dataset. Usually, a single datacolumns dictionary is used for all datasets. If necessary, one can define a list of dictionaries, one for each EB, with different setups per EB. If no type is specified, {'data':'raw'} will be assumed.

  • lazy --

    Use the lazy filter import.

    Default: None (equivalent to False)

  • with_pointing_correction --

    Apply pointing correction to DIRECTION. Add (ASDM::Pointing::encoder - ASDM::Pointing::pointingDirection) to the value to be written in MS::Pointing::direction.

    Default: None (equivalent to True)

  • createmms --

    Create an MMS.

    Default: None (equivalent to False)

Returns:

The results object for the pipeline task is returned.

Examples

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

>>> hsd_importdata (vis=['../rawdata/uid___A002_X30a93d_X43e', '../rawdata/uid_A002_x30a93d_X44e'])

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

>>> hsd_importdata (vis=['uid___A002_X30a93d_X43e.ms'])

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

>>> hsd_importdata (vis=['../rawdata/uid___A002_X30a93d_X43e.tar.gz'])

  1. Import a list of MeasurementSets.

>>> myvislist = ['uid___A002_X30a93d_X43e.ms', 'uid_A002_x30a93d_X44e.ms']
>>> hsd_importdata(vis=myvislist)