SofiaIntegration

class sofia_redux.scan.custom.sofia.integration.integration.SofiaIntegration(scan=None)

Bases: Integration

Initialize a SOFIA integration.

Parameters:

scansofia_redux.scan.custom.sofia.scan.scan.SofiaScan, optional

The scan to which this integration belongs.

Methods Summary

get_mean_chopper_position()	Return the mean chopper position for the integration.
get_mean_pwv()	Get the mean PWV of the integration.
get_mid_elevation()	Return the mid-point elevation of the integration.
get_model_pwv()	Estimate the PWV from the altitude of the observation.
get_modulation_frequency(signal_flag)	Return the modulation frequency.
set_atran_tau()	Set tau based on the ATRAN model.
set_pwv_model_tau()	Set tau based on the PWV (precipitable water vapor) model.
set_tau([spec, value])	Set the tau values for the integration.
validate()	Validate the integration after a read.
validate_pwv()	Validate the frame PWV set a new value in the configuration if necessary.

Methods Documentation

get_mean_chopper_position()

Return the mean chopper position for the integration.

Returns:

positionCoordinate2D

The mean (x, y) chopper position.

get_mean_pwv()

Get the mean PWV of the integration.

Returns:

pwvastropy.units.Quantity

The mean PWV.

get_mid_elevation()

Return the mid-point elevation of the integration.

The mid-point is defined as the average of the elevations of the first and last valid integration frame.

Returns:

elevationastropy.units.Quantity

get_model_pwv()

Estimate the PWV from the altitude of the observation.

Returns:

PWVastropy.units.Quantity

The derived PWV.

get_modulation_frequency(signal_flag)

Return the modulation frequency.

The modulation frequency is taken from the chopper frequency if available, or set to 0 Hz otherwise.

Parameters:

signal_flagFrameFlagTypes or str or int

The signal flag (not relevant for this implementation).

Returns:

frequencyastropy.units.Quantity.

The modulation frequency in Hz.

set_atran_tau()

Set tau based on the ATRAN model.

Returns:

None

set_pwv_model_tau()

Set tau based on the PWV (precipitable water vapor) model.

Returns:

None

set_tau(spec=None, value=None)

Set the tau values for the integration.

If a value is explicitly provided without a specification, will be used to set the zenith tau if ground based, or transmission. If a specification and value is provided, will set the zenith tau as:

((band_a / t_a) * (value - t_b)) + band_b

where band_a/b are retrieved from the configuration as tau.<spec>.a/b, and t_a/b are retrieved from the configuration as tau.<instrument>.a/b.

Parameters:

specstr, optional

The tau specification to read from the configuration. If not supplied, will be read from the configuration ‘tau’ setting.

valuefloat, optional

The tau value to set. If not supplied, will be retrieved from the configuration as tau.<spec>.

Returns:

None

validate()

Validate the integration after a read.

Returns:

None

validate_pwv()

Validate the frame PWV set a new value in the configuration if necessary.

Returns:

None