hifv_flagtargetsdata

Note

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

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

Apply a flagtemplate to target data prior to running imaging pipeline tasks.

Parameters:

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

  • template (bool) -- Apply flagging templates.

  • filetemplate (str) -- 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 (bool) -- Back up any pre-existing flags.

Return type:

ResultsList[Results]

Examples

  1. Basic flagtargetsdata task:

>>> hifv_flagtargetsdata()