InstrumentInfo

class sofia_redux.scan.info.instrument.InstrumentInfo[source]

Bases: InfoBase

Initialize the instrument information.

The instrument information contains parameters relating to the observing instrument such as the observing frequency, resolution, sampling interval, gain, and number of channels.

Attributes Summary

log_id

Return the string log ID for the info.

Methods Summary

edit_image_header(header[, scans])

Edit an image header with available information.

get_data_unit()

Return the data unit of the instrument

get_focus_string([focus])

Return a string describing the focus.

get_point_size()

Return the instrument point size (instrument resolution).

get_size_unit()

Return the size unit of the instrument.

get_source_size()

Return the size of the source for the instrument.

get_spectral_size()

Return the instrument spectral point size.

get_spectral_unit()

Return the size unit of the instrument.

get_stability()

Return the instrument stability timescale.

jansky_per_beam()

Return the Jansky's per beam.

kelvin()

Return the instrument temperature in Kelvin.

set_mount(mount)

Set the telescope mount for the instrument.

validate_scan(scan)

Validate scan information with THIS information.

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

Methods Documentation

edit_image_header(header, scans=None)[source]

Edit an image header with available information.

Parameters:
headerastropy.fits.Header

The FITS header to apply.

scanslist (Scan), optional

A list of scans to use during editing.

Returns:
None
get_data_unit()[source]

Return the data unit of the instrument

Returns:
astropy.units.Unit
static get_focus_string(focus=None)[source]

Return a string describing the focus.

Parameters:
focusInstantFocus, optional
Returns:
str
get_point_size()[source]

Return the instrument point size (instrument resolution).

Returns:
units.Quantity
static get_size_unit()[source]

Return the size unit of the instrument.

Returns:
units.Unit
get_source_size()[source]

Return the size of the source for the instrument.

Returns:
units.Quantity
get_spectral_size()[source]

Return the instrument spectral point size.

Returns:
units.Quantity
static get_spectral_unit()[source]

Return the size unit of the instrument.

Returns:
units.Unit
get_stability()[source]

Return the instrument stability timescale.

The stability time scale is the expected time over which the instrument is expected to produce somewhat consistent results. This is used to determine the number of frames from which to perform baseline subtraction and other operations.

Returns:
timeunits.Quantity

The stability time for the instrument.

jansky_per_beam()[source]

Return the Jansky’s per beam.

Returns:
astropy.units.Quantity
kelvin()[source]

Return the instrument temperature in Kelvin.

Returns:
astropy.units.Quantity
set_mount(mount)[source]

Set the telescope mount for the instrument.

Parameters:
mountMount or int or str

The actual Mount flag type, it’s integer representation (be careful it’s correct), or the string name for the mount.

Returns:
None
validate_scan(scan)[source]

Validate scan information with THIS information.

Parameters:
scanScan
Returns:
None