Source code for pipeline.hif.cli.hif_mstransform

import pipeline.h.cli.utils as utils


# docstring and type hints: inherits from hif.tasks.mstransform.mstransform.MstransformInputs.__init__

[docs]
@utils.cli_wrapper
def hif_mstransform(vis=None, outputvis=None, field=None, intent=None, spw=None, chanbin=None, timebin=None,
                    parallel=None):
    """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.

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

    Returns:
        The results object for the pipeline task is returned.

    Examples:
        1. Split all science target data:

        >>> hif_mstransform()

        2. Split only phase and bandpass calibrator data:

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

    """