hif_mstransform

Note

Parameters set to None will use intelligent defaults from the pipeline context. Pass explicit values to override context defaults.

hif_mstransform(vis=None, outputvis=None, field=None, intent=None, spw=None, chanbin=None, timebin=None, parallel=None)[source]

Split calibrated science target data into a new *targets.ms MeasurementSet.

For each execution block, calibrated visibilities for the science targets are split from the CORRECTED column of the input MS using the mstransform CASA task. The output MS is named with *targets.ms and is listed on the front WebLog page. At this stage the targets.ms contains only the calibrated continuum and line emission data (no continuum subtraction yet).

The new MS is not re-indexed: source, field, and spw names and IDs match the parent MS.

Parameters:

  • vis --

    The list of input MeasurementSets. Defaults to the list of MeasurementSets specified in the <hifa,hifv>_importdata task. '': use all MeasurementSets in the context

    Examples: 'ngc5921.ms', ['ngc5921a.ms', ngc5921b.ms', 'ngc5921c.ms']

  • outputvis --

    A list of output MeasurementSets for line detection and imaging,. This list must have the same length as the input list.

    Default Naming: By default, an input MS named <msrootname>.ms will produce an output named <msrootname>_targets.ms.

    Examples

    • outputvis='ngc5921_targets.ms'

    • outputvis=['ngc5921a_targets.ms', 'ngc5921b_targets.ms', 'ngc5921c_targets.ms']

  • field --

    Select fields name(s) or id(s) to transform. Only fields with data matching the intent will be selected.

    Examples: '3C279', 'Centaurus*', '3C279,J1427-421'

  • intent --

    Select intents for which associated fields will be imaged. By default only TARGET data is selected.

    Examples: 'PHASE,BANDPASS'

  • spw -- Select spectral window/channels to image. By default all science spws for which the specified intent is valid are selected.

  • chanbin -- Width (bin) of input channels to average to form an output channel. If chanbin > 1 then chanaverage is automatically switched to True.

  • timebin -- Bin width for time averaging. If timebin > 0s then timeaverage is automatically switched to True.

  • parallel --

    Process multiple MeasurementSets in parallel using the casampi parallelization framework.

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

    Default: None (equivalent to False)

Return type:

ResultsList[Results]

Notes

QA = 1.0 if the new MS is successfully created; 0.0 otherwise.

Returns:

The results object for the pipeline task is returned.

Return type:

ResultsList[Results]

Examples

  1. Split all science target data:

>>> hif_mstransform()

  1. Split only phase and bandpass calibrator data:

>>> hif_mstransform(intent='PHASE,BANDPASS')