CalApplication¶

class CalApplication(calto: CalTo | list[CalTo], calfrom: CalFrom | list[CalFrom], origin: CalAppOrigin | list[CalAppOrigin] | None = None)[source]

Bases: object

CalApplication maps calibration tables and their application arguments to a target data selection, encapsulated as CalFrom and CalTo objects respectively.

calto: The CalTo representing the data selection to which the calibration should apply.

calfrom: The CalFrom representing the calibration and application parameters.

origin: The CalAppOrigin marking how this calibration was created.

Attributes Summary

`antenna`	The antennas to which the calibrations apply.
`calwt`	The calwt parameter to be used when applying these calibrations.
`field`	The field(s) to which the calibrations apply.
`gainfield`	The gainfield parameters to be used when applying these calibrations.
`gaintable`	The gaintable parameters to be used when applying these calibrations.
`intent`	The observing intent(s) to which the calibrations apply.
`interp`	The interp parameters to be used when applying these calibrations.
`spw`	Spectral window(s) to which the calibrations apply.
`spwmap`	The spwmap parameters to be used when applying these calibrations.
`vis`	Name of the measurement set to which the calibrations apply.

Methods Summary

`as_applycal`()	Get a representation of this object as a CASA applycal call.
`exists`()	Test whether all calibration tables referred to by this application exist.
`from_export`(s)	Unmarshal a CalApplication from a string.

Attributes Documentation

antenna

The antennas to which the calibrations apply.

Returns:: String representing the (comma-separated) antennas to which the calibrations apply.

calwt

The calwt parameter to be used when applying these calibrations.

Returns:: Boolean representing what to use for calwt for this calibration. If there are multiple CalFrom objects to apply, this returns a list of booleans, one per CalFrom.

field

The field(s) to which the calibrations apply.

Returns:: String representing the field(s) (comma-separated) to apply the calibrations to.

gainfield

The gainfield parameters to be used when applying these calibrations.

Returns:: Value for the gainfield parameter to be used when applying these calibrations; returns a scalar string if representing 1 calibration, otherwise a list of strings.

gaintable

The gaintable parameters to be used when applying these calibrations.

Returns:: Value for the gaintable parameter to be used when applying these calibrations; returns a scalar string if representing 1 calibration, otherwise a list of strings.

intent

The observing intent(s) to which the calibrations apply.

Returns:: String representing the intent(s) (comma-separated) to apply the calibrations to.

interp

The interp parameters to be used when applying these calibrations.

Returns:: Value for the interp parameter to be used when applying these calibrations; returns a scalar string if representing 1 calibration, otherwise a list of strings.

spw

Spectral window(s) to which the calibrations apply.

Returns:: String representing the spectral window id(s) (comma-separated) to apply the calibrations to.

spwmap

The spwmap parameters to be used when applying these calibrations.

Returns:: Value for the spwmap parameter to be used when applying these calibrations; returns a scalar string if representing 1 calibration, otherwise a list of strings.

vis

Name of the measurement set to which the calibrations apply.

Returns:: The name of the measurement set to which the calibrations apply.

Methods Documentation

as_applycal() → str[source]

Get a representation of this object as a CASA applycal call.

Returns:: String representation of CalApplication as a CASA applycal call.

exists() → bool[source]

Test whether all calibration tables referred to by this application exist.

Returns:: True if all calibration tables exist in the file system.

static from_export(s: str) → CalApplication[source]

Unmarshal a CalApplication from a string.

Parameters:: s -- String representation of a CalApplication as a CASA applycal call.
Returns:: CalApplication object generated from given string.