hifa_flagtargets

Note

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

hifa_flagtargets(vis=None, template=None, filetemplate=None, flagbackup=None, parallel=None)[source]

Apply observatory-scientist flagging templates to science target data.

Applies custom flagging commands to the science target MeasurementSets if determined to be necessary by an observatory scientist. The commands are read from the flagtargetstemplate.txt files linked from the WebLog page. The WebLog also displays a summary table of any flagging performed, including the number and fraction of data flagged per antenna, spw, and intent.

Parameters:

  • vis -- The list of input MeasurementSets. Defaults to the list of MeasurementSets defined in the pipeline context.

  • template -- Apply flagging templates; defaults to True.

  • filetemplate -- Text file containing flagging commands for science target data. If undefined, defaults to the dataset parent MS name (usually based on uid) with '.flagtargetstemplate.txt' suffix.

  • flagbackup -- Back up any pre-existing flags; defaults to False.

  • parallel --

    Process multiple MeasurementSets in parallel using the casampi parallelization framework.

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

    Default: None (equivalent to False)

Returns:

The results object for the pipeline task is returned.

Return type:

ResultsList[Results]

Examples

  1. Apply the science target flagging template:

>>> hifa_flagtargets()