Package nom.tam.fits.header
Enum ObservationDurationDescription
- java.lang.Object
-
- java.lang.Enum<ObservationDurationDescription>
-
- nom.tam.fits.header.ObservationDurationDescription
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ObservationDurationDescription>
,IFitsHeader
public enum ObservationDurationDescription extends java.lang.Enum<ObservationDurationDescription> 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 DATE_END
The value field shall contain a character string that gives the date on which the observation ended.ELAPTIME
The value field shall contain a floating point number giving the difference between the stop and start times of the observation in units of seconds.EXPOSURE
The value field shall contain a floating point number giving the exposure time of the observation in units of seconds.EXPTIME
The value field shall contain a floating point number giving the exposure time of the observation in units of seconds.LIVETIME
The value field shall contain a floating point number giving the total integrated exposure time in units of seconds corrected for detector 'dead time' effects which reduce the net efficiency of the detector.ONTIME
The value field shall contain a floating point number giving the total integrated exposure time of the observation in units of seconds.TELAPSE
The value field shall contain a floating point number giving the difference between the stop and start times of the observation in units of seconds.TIME_END
The value field shall contain a character string that gives the time at which the observation ended.TIME_OBS
The value field shall contain a character string that gives the time at which the observation started.
-
Field Summary
Fields Modifier and Type Field Description private IFitsHeader
key
-
Constructor Summary
Constructors Modifier Constructor Description private
ObservationDurationDescription(java.lang.String key, IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, java.lang.String comment)
private
ObservationDurationDescription(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 ObservationDurationDescription
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ObservationDurationDescription[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.IFitsHeader.VALUE
valueType()
-
-
-
Enum Constant Detail
-
DATE_END
public static final ObservationDurationDescription DATE_END
The value field shall contain a character string that gives the date on which the observation ended. This keyword has the same format, and is used in conjunction with, the standard DATA-OBS keyword that gives the starting date of the observation. These 2 keywords may give either the calendar date using the 'yyyy-mm-dd' format, or may give the full date and time using the 'yyyy-mm-ddThh:mm:ss.sss' format.
-
ELAPTIME
public static final ObservationDurationDescription ELAPTIME
The value field shall contain a floating point number giving the difference between the stop and start times of the observation in units of seconds. This keyword is synonymous with the TELAPSE keyword.
-
EXPOSURE
public static final ObservationDurationDescription EXPOSURE
The value field shall contain a floating point number giving the exposure time of the observation in units of seconds. The exact definition of 'exposure time' is mission dependent and may, for example, include corrections for shutter open and close duration, detector dead time, vignetting, or other effects. This keyword is synonymous with the EXPTIME keyword.
-
EXPTIME
public static final ObservationDurationDescription EXPTIME
The value field shall contain a floating point number giving the exposure time of the observation in units of seconds. The exact definition of 'exposure time' is mission dependent and may, for example, include corrections for shutter open and close duration, detector dead time, vignetting, or other effects. This keyword is synonymous with the EXPOSURE keyword.
-
LIVETIME
public static final ObservationDurationDescription LIVETIME
The value field shall contain a floating point number giving the total integrated exposure time in units of seconds corrected for detector 'dead time' effects which reduce the net efficiency of the detector. The ratio of LIVETIME/ONTIME gives the mean dead time correction during the observation, which lies in the range 0.0 to 1.0.
-
ONTIME
public static final ObservationDurationDescription ONTIME
The value field shall contain a floating point number giving the total integrated exposure time of the observation in units of seconds. ONTIME may be less than TELAPSE if there were intevals during the observation in which the target was not observed (e.g., the shutter was closed, or the detector power was turned off).
-
TELAPSE
public static final ObservationDurationDescription TELAPSE
The value field shall contain a floating point number giving the difference between the stop and start times of the observation in units of seconds. This keyword is synonymous with the ELAPTIME keyword.
-
TIME_END
public static final ObservationDurationDescription TIME_END
The value field shall contain a character string that gives the time at which the observation ended. This keyword is used in conjunction with the DATE-END keyword to give the ending time of the observation; the DATE-END keyword gives the ending calendar date, with format 'yyyy-mm-dd', and TIME-END gives the time within that day using the format 'hh:mm:ss.sss...'. This keyword should not be used if the time is included directly as part of the DATE-END keyword value with the format 'yyyy-mm-ddThh:mm:ss.sss'.
-
TIME_OBS
public static final ObservationDurationDescription TIME_OBS
The value field shall contain a character string that gives the time at which the observation started. This keyword is used in conjunction with the standard DATE-OBS keyword to give the starting time of the observation; the DATE-OBS keyword gives the starting calendar date, with format 'yyyy-mm-dd', and TIME-OBS gives the time within that day using the format 'hh:mm:ss.sss...'. This keyword should not be used if the time is included directly as part of the DATE-OBS keyword value with the format 'yyyy-mm-ddThh:mm:ss.sss'.
-
-
Field Detail
-
key
private final IFitsHeader key
-
-
Constructor Detail
-
ObservationDurationDescription
private ObservationDurationDescription(IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, java.lang.String comment)
-
ObservationDurationDescription
private ObservationDurationDescription(java.lang.String key, IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, java.lang.String comment)
-
-
Method Detail
-
values
public static ObservationDurationDescription[] 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 (ObservationDurationDescription c : ObservationDurationDescription.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ObservationDurationDescription 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
-
-