pipeline.hif.cli.hif_refant

hif_refant(vis=None, field=None, spw=None, intent=None, hm_refant=None, refant=None, geometry=None, flagging=None, parallel=None, refantignore=None) → ResultsList[Results][source]

Select the best reference antennas.

The hif_refant task selects a list of reference antennas and stores them in the pipeline context in priority order.

The priority order is determined by a weighted combination of scores derived by the antenna selection heuristics. In manual mode the reference antennas can be set by hand.

Parameters:

  • vis --

    The list of input MeasurementSets. Defaults to the list of MeasurementSets in the pipeline context.

    Example: ['M31.ms']

  • field --

    The comma delimited list of field names or field ids for which flagging scores are computed if hm_refant='automatic' and flagging = True

    Example: '' (Default to fields with the specified intents), '3C279', '3C279,M82'

  • spw --

    A string containing the comma delimited list of spectral window ids for which flagging scores are computed if hm_refant='automatic' and flagging = True.

    Example: '' (all spws observed with the specified intents), '11,13,15,17'

  • intent --

    A string containing a comma delimited list of intents against which the selected fields are matched. Defaults to all supported intents.

    Example: 'BANDPASS', 'AMPLITUDE,BANDPASS,PHASE,POLARIZATION'

  • hm_refant -- The heuristics method or mode for selection the reference antenna. The options are 'manual' and 'automatic. In manual mode a user supplied reference antenna refant is supplied. In 'automatic' mode the antennas are selected automatically.

  • refant --

    The user supplied reference antenna for hm_refant='manual'. If no antenna list is supplied an empty list is returned.

    Example: 'DV05'

  • geometry -- Score antenna by proximity to the center of the array. This option is quick as only the ANTENNA table must be read. Parameter is available when ``hm_refant``='automatic'.

  • flagging -- Score antennas by percentage of unflagged data. This option requires computing flagging statistics. Parameter is available when ``hm_refant``='automatic'.

  • parallel --

    Process multiple MeasurementSets in parallel using the casampi parallelization framework.

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

    Default: None (equivalent to False)

  • refantignore --

    string list to be ignored as reference antennas.

    Example: refantignore='ea02,ea03'

Returns:

The results object for the pipeline task is returned.

Examples

  1. Compute the references antennas to be used for bandpass and gain calibration.

>>> hif_refant()