pipeline.hifa.cli.hifa_tsysflag

hifa_tsysflag(vis=None, caltable=None, flag_nmedian=None, fnm_limit=None, fnm_byfield=None, flag_derivative=None, fd_max_limit=None, flag_edgechans=None, fe_edge_limit=None, flag_fieldshape=None, ff_refintent=None, ff_max_limit=None, flag_birdies=None, fb_sharps_limit=None, flag_toomany=None, tmf1_limit=None, tmef1_limit=None, metric_order=None, normalize_tsys=None, filetemplate=None, parallel=None) → ResultsList[Results][source]

Flag deviant system temperatures for ALMA interferometry measurements.

This task flags all deviant system temperature measurements in the system temperature calibration table by running a sequence of flagging tests, each designed to look for a different type of possible error.

If a file with manual Tsys flags is provided with the filetemplate parameter, then these flags are applied prior to the evaluation of the flagging heuristics listed below.

The tests are:

  1. Flag Tsys spectra with high median values

  2. Flag Tsys spectra with high median derivatives. This is meant to spot spectra that are 'ringing'.

  3. Flag the edge channels of the Tsys spectra in each SpW.

  4. Flag Tsys spectra whose shape is different from that associated with the BANDPASS intent.

  5. Flag 'birdies'.

  6. Flag the Tsys spectra of all antennas in a timestamp and spw if proportion of antennas already flagged in this timestamp and spw exceeds a threshold, and flag Tsys spectra for all antennas and all timestamps in a spw, if proportion of antennas that are already entirely flagged in all timestamps exceeds a threshold.

Parameters:

  • vis -- List of input MeasurementSets (Not used).

  • caltable --

    List of input Tsys calibration tables. Default: [] - Use the table currently stored in the pipeline context.

    Example: caltable=['X132.ms.tsys.s2.tbl']

  • flag_nmedian -- True to flag Tsys spectra with high median value.

  • fnm_limit -- Flag spectra with median value higher than fnm_limit * median of this measure over all spectra.

  • fnm_byfield -- Evaluate the nmedian metric separately for each field.

  • flag_derivative -- True to flag Tsys spectra with high median derivative.

  • fd_max_limit -- Flag spectra with median derivative higher than fd_max_limit * median of this measure over all spectra.

  • flag_edgechans -- True to flag edges of Tsys spectra.

  • fe_edge_limit -- Flag channels whose channel to channel difference > fe_edge_limit * median across spectrum.

  • flag_fieldshape -- True to flag Tsys spectra with a radically different shape to those of the ff_refintent.

  • ff_refintent -- Data intent that provides the reference shape for 'flag_fieldshape'.

  • ff_max_limit -- Flag Tsys spectra with 'fieldshape' metric values > ff_max_limit.

  • flag_birdies -- True to flag channels covering sharp spectral features.

  • fb_sharps_limit -- Flag channels bracketing a channel to channel difference > fb_sharps_limit.

  • flag_toomany -- True to flag Tsys spectra for which a proportion of antennas for given timestamp and/or proportion of antennas that are entirely flagged in all timestamps exceeds their respective thresholds.

  • tmf1_limit -- Flag Tsys spectra for all antennas in a timestamp and spw if proportion of antennas already flagged in this timestamp and spw exceeds tmf1_limit.

  • tmef1_limit -- Flag Tsys spectra for all antennas and all timestamps in a spw, if proportion of antennas that are already entirely flagged in all timestamps exceeds tmef1_limit.

  • metric_order -- Order in which to evaluate the flagging metrics that are enabled. Disabled metrics are skipped.

  • normalize_tsys -- True to create a normalized Tsys table that is used to evaluate the Tsys flagging metrics. All newly found flags are also applied to the original Tsys caltable that continues to be used for subsequent calibration.

  • filetemplate -- The name of a text file that contains the manual Tsys flagging template. If the template flags file is undefined, a name of the form 'msname.flagtsystemplate.txt' is assumed.

  • parallel -- The description is missing.

Returns:

The results object for the pipeline task is returned.

Examples

  1. Flag Tsys measurements using currently recommended tests:

>>> hifa_tsysflag()

2. Flag Tsys measurements using all recommended tests apart from that using the 'fieldshape' metric:

>>> hifa_tsysflag(flag_fieldshape=False)