pipeline.hifa.cli.hifa_bandpass

hifa_bandpass(vis=None, caltable=None, field=None, intent=None, spw=None, antenna=None, hm_phaseup=None, phaseupbw=None, phaseupmaxsolint=None, phaseupsolint=None, phaseupsnr=None, phaseupnsols=None, hm_phaseup_combine=None, hm_bandpass=None, solint=None, maxchannels=None, evenbpints=None, bpsnr=None, minbpsnr=None, bpnsols=None, combine=None, refant=None, solnorm=None, minblperant=None, minsnr=None, unregister_existing=None, hm_auto_fillgaps=None, parallel=None) → ResultsList[Results][source]

Compute bandpass calibration solutions.

The hifa_bandpass task computes a bandpass solution for every specified science spectral window. By default, a 'phaseup' pre-calibration is performed and applied on the fly to the data, before the bandpass is computed.

The hif_refant task may be used to pre-compute a prioritized list of reference antennas.

Parameters:

  • vis --

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

    Example: vis=['ngc5921.ms']

  • caltable --

    List of names for the output calibration tables. Defaults to the standard pipeline naming convention.

    Example: caltable=['ngc5921.gcal']

  • field --

    The list of field names or field ids for which bandpasses are computed. Set to field='' by default, which means the task will select all fields.

    Example: field='3C279', field='3C279,M82'

  • intent --

    A string containing a comma delimited list of intents against which the selected fields are matched. Set to intent='' by default, which means the task will select all data with the BANDPASS intent.

    Example: intent='*PHASE*'

  • spw --

    The list of spectral windows and channels for which bandpasses are computed. Set to spw='' by default, which means the task will select all science spectral windows.

    Example: spw='11,13,15,17'

  • antenna -- Set of data selection antenna IDs

  • hm_phaseup --

    The pre-bandpass solution phaseup gain heuristics. The options are:

    • 'snr': compute solution required to achieve the specified SNR

    • 'manual': use manual solution parameters

    • '': skip phaseup

    Example: hm_phaseup='manual'

  • phaseupbw --

    Bandwidth to be used for phaseup. Used when hm_phaseup= 'manual'.

    Example:

    • phaseupbw='' to use entire bandpass

    • phaseupbw='500MHz' to use central 500MHz

  • phaseupmaxsolint --

    Maximum phase correction solution interval (in seconds) allowed in very low-SNR cases. Used only when hm_phaseup='snr'.

    Example: phaseupmaxsolint=60.0

  • phaseupsolint --

    The phase correction solution interval in CASA syntax. Used when hm_phaseup='manual' or as a default if the hm_phaseup='snr' heuristic computation fails.

    Example: phaseupsolint='300s'

  • phaseupsnr --

    The required SNR for the phaseup solution. Used to calculate the phaseup time solint, and only if hm_phaseup='snr'.

    Example: phaseupsnr=10.0

  • phaseupnsols --

    The minimum number of phaseup gain solutions. Used only if hm_phaseup='snr'.

    Example: phaseupnsols=4

  • hm_phaseup_combine --

    The spw combination heuristic for the phase-up solution. Accepts one of following 3 options:

    • 'snr', default: heuristics will use combine='spw' in phase-up gaincal, when SpWs have SNR < phaseupsnr (default = 20).

    • 'always': heuristic will force combine='spw' in the phase-up gaincal.

    • 'never': heuristic will not use spw combination; this was the default logic for Pipeline release 2024 and prior.

    Example: hm_phaseup_combine='always'

  • hm_bandpass --

    The bandpass solution heuristics. The options are: 'snr': compute the solution required to achieve the specified SNR 'smoothed': simple 'smoothing' i.e. spectral solint>1chan 'fixed': use the user defined parameters for all spws

    Example: hm_bandpass='snr'

  • solint --

    Time and channel solution intervals in CASA syntax. Default is solint='inf', which is used when hm_bandpass='fixed'. If hm_bandpass='snr', then the task will attempt to compute and use an optimal SNR-based solint (and warn if this solint is not good enough). If hm_bandpass='smoothed', the task will override the spectral solint with bandwidth/maxchannels.

    Example: solint='int'

  • maxchannels --

    The bandpass solution 'smoothing' factor in channels, i.e. spectral solint will be set to bandwidth / maxchannels Set to 0 for no smoothing. Used if hm_bandpass='smoothed'.

    Example: maxchannels=240

  • evenbpints --

    Force the per spw frequency solint to be evenly divisible into the spw bandpass if hm_bandpass='snr'.

    Example: evenbpints=False

  • bpsnr --

    The required SNR for the bandpass solution. Used only if hm_bandpass='snr'.

    Example: bpsnr=30.0

  • minbpsnr --

    The minimum required SNR for the bandpass solution when strong atmospheric lines exist in Tsys spectra. Used only if hm_bandpass='snr'.

    Example: minbpsnr=10.0

  • bpnsols --

    The minimum number of bandpass solutions. Used only if hm_bandpass= 'snr'.

    Example: bpnsols=8

  • combine --

    Data axes to combine for solving. Axes are '', 'scan', 'spw', 'field' or any comma-separated combination.

    Example: combine='scan,field'

  • refant --

    List of reference antenna names. Defaults to the value(s) stored in the pipeline context. If undefined in the pipeline context defaults to the CASA reference antenna naming scheme.

    Example: refant='DV06,DV07'

  • solnorm --

    Normalise the bandpass solution; defaults to True.

    Example: solnorm=False

  • minblperant --

    Minimum number of baselines required per antenna for each solve. Antennas with fewer baselines are excluded from solutions.

    Example: minblperant=4

  • minsnr --

    Solutions below this SNR are rejected in the phaseup and bandpass solves.

    Example: minsnr=3.0

  • unregister_existing --

    Unregister all bandpass calibrations from the pipeline context before registering the new bandpass calibrations from this task. Defaults to False.

    Example: unregister_existing=True

  • hm_auto_fillgaps -- If True, then the hm_bandpass = 'snr' or 'smoothed' modes, that solve bandpass per SpW, are performed with CASA bandpass task parameter 'fillgaps' set to a quarter of the respective SpW bandwidth (in channels). If False, then these bandpass solves will use fillgaps=0. The hm_bandpass='fixed' mode is unaffected by hm_auto_fillgaps and always uses fillgaps=0.

  • parallel --

    Process multiple MeasurementSets in parallel using the casampi parallelization framework.

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

    Default: None (equivalent to False)

Returns:

The results object for the pipeline task is returned.

Examples

1. Compute a channel bandpass for all visibility files in the pipeline context using the CASA reference antenna determination scheme:

>>> hifa_bandpass()

  1. Same as the above but precompute a prioritized reference antenna list:

>>> hif_refant()
>>> hifa_bandpass()