SofiaSpectroscopyInfo

class sofia_redux.scan.custom.sofia.info.spectroscopy.SofiaSpectroscopyInfo

Bases: InfoBase

Initialize the SOFIA spectroscopy information.

Contains information on SOFIA spectroscopic parameters such as the bandwidth, resolution, frequencies, and velocities.

Attributes Summary

log_id	Return the string log ID for the info.
velocity_unit

Methods Summary

apply_configuration()	Update spectroscopic information with FITS header information.
edit_header(header)	Edit an image header with available information.
get_redshift()	Return the redshift of the source determined from it's velocity.
get_table_entry(name)	Return a parameter value for the given name.

Attributes Documentation

log_id

Return the string log ID for the info.

The log ID is used to extract certain information from table data.

Returns:

str

velocity_unit = Unit("km / s")

Methods Documentation

apply_configuration()

Update spectroscopic information with FITS header information.

Updates the information by taking the following keywords from the FITS header:

FRONTEND - The frontend device name (str)
BACKEND - The backend device name (str)
BANDWID - The total spectral bandwidth (MHz)
FREQRES - The spectral frequency resolution (MHz)
TSYS - The system temperature (K)
OBSFREQ - The observing frequency at the reference channel (MHz)
IMAGFREQ - The image frequency at the reference channel (MHz)
RESTFREQ - The rest frequency at the reference channel (MHz)
VELDEF - The velocity system definition (str)
VFRAME - Radial velocity of the reference frame wrt observer (km/s)
RVSYS - The source velocity wrt the observer (km/s)

Returns:

None

edit_header(header)

Edit an image header with available information.

Parameters:

headerastropy.fits.Header

The FITS header to apply.

Returns:

None

get_redshift()

Return the redshift of the source determined from it’s velocity.

The redshift is calculated as:

z = sqrt( (1 + v/c) / (1 - v/c) ) - 1

where v is the source velocity and c is the speed of light. I.e., the relativistic doppler shift along the line of sight.

Returns:

redshiftfloat

get_table_entry(name)

Return a parameter value for the given name.

Parameters:

namestr

The name of the parameter to retrieve.

Returns:

value