hifa_lock_refant

Note

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

hifa_lock_refant(vis=None, unregister_spwphaseup=None)

Lock the reference antenna to a single antenna with refantmode='fixed'.

Sets the reference antenna to a single antenna and sets refantmode='fixed' for all subsequent calibration tasks, preventing any subsequent modification of the refant list.

In the polarization (polcal and polcalimage) recipes, hifa_bandpass and hifa_spwphaseup are each called a second time after this stage to ensure those calibration tables are computed using the fixed reference antenna.

By default, executing hifa_lock_refant will unregister any caltable made by any hifa_spwphaseup stage run prior to hifa_lock_refant. The unregistered hifa_spwphaseup caltables cannot be 're-registered'. In the current Pipeline use case, these are 'phase offset' caltable(s). For the polarization recipe where hifa_lock_refant is used, the hifa_spwphaseup stage will be called again.

The refant list can be unlocked with the hifa_unlock_refant task, although that is not needed in the standard polcal and polcalimage recipes.

Parameters:

• vis --

  List of input MeasurementSets. Defaults to the list of MeasurementSets specified in the pipeline context.

  Example: vis=['ngc5921.ms']

• unregister_spwphaseup -- Boolean option to remove any caltable created by any hifa_spwphaseup stage run prior to lock_refant. In the current Pipeline use case, hifa_spwphaseup makes phase offset tables (per spectral spec) to align spws. Defaults to True

Return type:

ResultsList[Results]

Notes

Only used in polarization recipes.

Returns:

The results object for the pipeline task is returned.

Return type:

ResultsList[Results]

Examples

1. Lock the refant list for all MSes in pipeline context:

   >>> hifa_lock_refant()