import pipeline.h.cli.utils as utils
# docstring and type hints: inherits from hifa.tasks.tsysflag_contamination.tsysflagcontamination.TsysFlagContaminationInputs.__init__
[docs]
@utils.cli_wrapper
def hifa_tsysflagcontamination(
vis=None,
caltable=None,
filetemplate=None,
logpath=None,
remove_n_extreme=None,
relative_detection_factor=None,
diagnostic_plots=None,
continue_on_failure=None,
parallel=None,
):
"""Flag line contamination in ALMA interferometric Tsys caltables.
This task flags all line contamination detected through an analysis of the
Tsys and bandpass caltables.
The general idea for the detection algorithm is to discern features which
appear in the Tsys calibration tables of the scans taken in the vicinity
of the source field in comparison with the Tsys calibration tables of the
scans taken toward the bandpass. The bandpass scan should be clean of
astrophysical line features.
Returns:
The results object for the pipeline task is returned.
Examples:
1. Flag Tsys line contamination using currently recommended parameters:
>>> hifa_tsysflagcontamination()
2. Halt pipeline execution if a failure occurs in the underlying heuristic:
>>> hifa_tsysflagcontamination(continue_on_failure=False)
"""