SpecFrameSpecFrame - Spectral coordinate system description

Description:
A SpecFrame is a specialised form of one-dimensional FrameFrame which represents various coordinate systems used to describe positions within an electro-magnetic spectrum. The particular coordinate system to be used is specified by setting the SpecFrame's SystemSystem attribute (the default is wavelength) qualified, as necessary, by other attributes such as the rest frequency, the standard of rest, the epoch of observation, units, etc (see the description of the System attribute for details).

By setting a value for thr SpecOriginSpecOrigin attribute, a SpecFrame can be made to represent offsets from a given spectral position, rather than absolute spectral values.

Constructor Function:
astSpecFrameastSpecFrame
Inheritance
The SpecFrame class inherits from the Frame class.
Attributes
In addition to those attributes common to all Frames, every SpecFrame also has the following attributes:

  • AlignSpecOffsetAlignSpecOffset: Align SpecFrames using the offset coordinate system?

  • AlignStdOfRestAlignStdOfRest: Standard of rest in which to align SpecFrames

  • RefDecRefDec: Declination of the source (FK5 J2000)

  • RefRARefRA: Right ascension of the source (FK5 J2000)

  • RestFreqRestFreq: Rest frequency

  • SourceSysSourceSys: Source velocity spectral system

  • SourceVelSourceVel: Source velocity

  • SourceVRFSourceVRF: Source velocity rest frame

  • SpecOriginSpecOrigin: The zero point for SpecFrame axis values

  • StdOfRestStdOfRest: Standard of rest

Several of the Frame attributes inherited by the SpecFrame class refer to a specific axis of the Frame (for instance Unit(axis)Unitaxis, Label(axis)Labelaxis, etc). Since a SpecFrame is strictly one-dimensional, it allows these attributes to be specified without an axis index. So for instance, "Unit" is allowed in place of "Unit(1)".
Functions
In addition to those functions applicable to all Frames, the following functions may also be applied to all SpecFrames:

  • astSetRefPosastSetRefPos: Set reference position in any celestial system

  • astGetRefPosastGetRefPos: Get reference position in any celestial system