Package nom.tam.fits.header
Enum ObservationDescription
- java.lang.Object
-
- java.lang.Enum<ObservationDescription>
-
- nom.tam.fits.header.ObservationDescription
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ObservationDescription>
,IFitsHeader
public enum ObservationDescription extends java.lang.Enum<ObservationDescription> implements IFitsHeader
This data dictionary contains FITS keywords that have been widely used within the astronomical community. It is recommended that these keywords only be used as defined here. These are the Keywords that describe the observation.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface nom.tam.fits.header.IFitsHeader
IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AIRMASS
The value field shall contain a floating point number giving the air mass during the observation by a ground based telescope.DEC
The value field gives the declination of the observation.DEC_NOM
The value field shall contain a floating point number giving the nominal declination of the pointing direction in units of decimal degrees.DEC_OBJ
The value field shall contain a floating point number giving the declination of the observed object in units of decimal degrees.DEC_PNT
The value field shall contain a floating point number giving the declination of the pointing direction in units of decimal degrees.DEC_SCX
The value field shall contain a floating point number giving the declination of the space craft (or telescope platform) X axis during the observation in decimal degrees.DEC_SCZ
The value field shall contain a floating point number giving the declination of the space craft (or telescope platform) Z axis during the observation in decimal degrees.LATITUDE
The value field shall contain a floating point number giving the geographic latitude from which the observation was made in units of degrees.MOONANGL
The value field shall contain a floating point number giving the angle between the direction of the observation (e.g., the optical axis of the telescope or the position of the target) and the moon, measured in degrees.OBJNAME
The value field shall contain a character string giving a name for the observed object that conforms to the IAU astronomical object naming conventions.OBS_ID
The value field shall contain a character string which uniquely identifies the dataset contained in the FITS file.ORIENTAT
The value field shall contain a floating point number giving the position angle of the y axis of the detector projected on the sky, in degrees east of north.PA_PNT
The value field shall contain a floating point number giving the position angle of the relevant aspect of telescope pointing axis and/or instrument on the sky in units of degrees east of north.RA
The value field gives the Right Ascension of the observation.RA_NOM
The value field shall contain a floating point number giving the nominal Right Ascension of the pointing direction in units of decimal degrees.RA_OBJ
The value field shall contain a floating point number giving the Right Ascension of the observed object in units of decimal degrees.RA_PNT
The value field shall contain a floating point number giving the Right Ascension of the pointing direction in units of decimal degrees.RA_SCX
The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) X axis during the observation in decimal degrees.RA_SCY
The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) Y axis during the observation in decimal degrees.RA_SCZ
The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) Z axis during the observation in decimal degrees.SUNANGLE
The value field shall contain a floating point number giving the angle between the direction of the observation (e.g., the optical axis of the telescope or the position of the target) and the sun, measured in degrees.
-
Field Summary
Fields Modifier and Type Field Description private IFitsHeader
key
-
Constructor Summary
Constructors Modifier Constructor Description private
ObservationDescription(IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, java.lang.String comment)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
comment()
IFitsHeader.HDU
hdu()
java.lang.String
key()
IFitsHeader
n(int... number)
IFitsHeader.SOURCE
status()
static ObservationDescription
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ObservationDescription[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.IFitsHeader.VALUE
valueType()
-
-
-
Enum Constant Detail
-
AIRMASS
public static final ObservationDescription AIRMASS
The value field shall contain a floating point number giving the air mass during the observation by a ground based telescope. The value of the airmass is often approximated by the secant of the elevation angle and has a value of 1.0 at the zenith and increases towards the horizon. This value is assumed to correspond to the start of the observation unless another interpretation is clearly explained in the comment field.
-
DEC
public static final ObservationDescription DEC
The value field gives the declination of the observation. It may be expressed either as a floating point number in units of decimal degrees, or as a character string in 'dd:mm:ss.sss' format where the decimal point and number of fractional digits are optional. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. Example: -47.25944 or '-47:15:34.00'.
-
DEC_NOM
public static final ObservationDescription DEC_NOM
The value field shall contain a floating point number giving the nominal declination of the pointing direction in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. The precise definition of this keyword is instrument-specific, but typically the nominal direction corresponds to the direction to which the instrument was requested to point. The DEC_PNT keyword should be used to give the actual pointed direction.
-
DEC_OBJ
public static final ObservationDescription DEC_OBJ
The value field shall contain a floating point number giving the declination of the observed object in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword.
-
DEC_PNT
public static final ObservationDescription DEC_PNT
The value field shall contain a floating point number giving the declination of the pointing direction in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. The precise definition of this keyword is instrument-specific, but typically the pointed direction corresponds to the optical axis of the instrument. This keyword gives a mean value in cases where the pointing axis was not fixed during the entire observation.
-
DEC_SCX
public static final ObservationDescription DEC_SCX
The value field shall contain a floating point number giving the declination of the space craft (or telescope platform) X axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.
-
DEC_SCZ
public static final ObservationDescription DEC_SCZ
The value field shall contain a floating point number giving the declination of the space craft (or telescope platform) Z axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.
-
LATITUDE
public static final ObservationDescription LATITUDE
The value field shall contain a floating point number giving the geographic latitude from which the observation was made in units of degrees.
-
MOONANGL
public static final ObservationDescription MOONANGL
The value field shall contain a floating point number giving the angle between the direction of the observation (e.g., the optical axis of the telescope or the position of the target) and the moon, measured in degrees.
-
OBJNAME
public static final ObservationDescription OBJNAME
The value field shall contain a character string giving a name for the observed object that conforms to the IAU astronomical object naming conventions. The value of this keyword is more strictly constrained than for the standard OBJECT keyword which in practice has often been used to record other ancillary information about the observation (e.g. filter, exposure time, weather conditions, etc.).
-
OBS_ID
public static final ObservationDescription OBS_ID
The value field shall contain a character string which uniquely identifies the dataset contained in the FITS file. This is typically a sequence number that can contain a mixture of numerical and character values. Example: '10315-01-01-30A'
-
ORIENTAT
public static final ObservationDescription ORIENTAT
The value field shall contain a floating point number giving the position angle of the y axis of the detector projected on the sky, in degrees east of north. This keyword is synonymous with the CROTA2 WCS keyword.
-
PA_PNT
public static final ObservationDescription PA_PNT
The value field shall contain a floating point number giving the position angle of the relevant aspect of telescope pointing axis and/or instrument on the sky in units of degrees east of north. It commonly applies to the orientation of a slit mask.
-
RA
public static final ObservationDescription RA
The value field gives the Right Ascension of the observation. It may be expressed either as a floating point number in units of decimal degrees, or as a character string in 'HH:MM:SS.sss' format where the decimal point and number of fractional digits are optional. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. Example: 180.6904 or '12:02:45.7'.
-
RA_NOM
public static final ObservationDescription RA_NOM
The value field shall contain a floating point number giving the nominal Right Ascension of the pointing direction in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. The precise definition of this keyword is instrument-specific, but typically the nominal direction corresponds to the direction to which the instrument was requested to point. The RA_PNT keyword should be used to give the actual pointed direction.
-
RA_OBJ
public static final ObservationDescription RA_OBJ
The value field shall contain a floating point number giving the Right Ascension of the observed object in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword.
-
RA_PNT
public static final ObservationDescription RA_PNT
The value field shall contain a floating point number giving the Right Ascension of the pointing direction in units of decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. The precise definition of this keyword is instrument-specific, but typically the pointed direction corresponds to the optical axis of the instrument. This keyword gives a mean value in cases where the pointing axis was not fixed during the entire observation.
-
RA_SCX
public static final ObservationDescription RA_SCX
The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) X axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.
-
RA_SCY
public static final ObservationDescription RA_SCY
The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) Y axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.
-
RA_SCZ
public static final ObservationDescription RA_SCZ
The value field shall contain a floating point number giving the Right Ascension of the space craft (or telescope platform) Z axis during the observation in decimal degrees. The coordinate reference frame is given by the RADECSYS keyword, and the coordinate epoch is given by the EQUINOX keyword. This keyword gives a mean value in cases where the axis was not fixed during the entire observation.
-
SUNANGLE
public static final ObservationDescription SUNANGLE
The value field shall contain a floating point number giving the angle between the direction of the observation (e.g., the optical axis of the telescope or the position of the target) and the sun, measured in degrees.
-
-
Field Detail
-
key
private final IFitsHeader key
-
-
Constructor Detail
-
ObservationDescription
private ObservationDescription(IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, java.lang.String comment)
-
-
Method Detail
-
values
public static ObservationDescription[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ObservationDescription c : ObservationDescription.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ObservationDescription valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
comment
public java.lang.String comment()
- Specified by:
comment
in interfaceIFitsHeader
-
hdu
public IFitsHeader.HDU hdu()
- Specified by:
hdu
in interfaceIFitsHeader
-
key
public java.lang.String key()
- Specified by:
key
in interfaceIFitsHeader
-
n
public IFitsHeader n(int... number)
- Specified by:
n
in interfaceIFitsHeader
-
status
public IFitsHeader.SOURCE status()
- Specified by:
status
in interfaceIFitsHeader
-
valueType
public IFitsHeader.VALUE valueType()
- Specified by:
valueType
in interfaceIFitsHeader
-
-