Package nom.tam.fits.header
Enum Class ObservationDurationDescription
- All Implemented Interfaces:
Serializable
,Comparable<ObservationDurationDescription>
,Constable
,IFitsHeader
public enum ObservationDurationDescription
extends 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 class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface nom.tam.fits.header.IFitsHeader
IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe value field shall contain a character string that gives the date on which the observation ended.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.The value field shall contain a floating point number giving the exposure time of the observation in units of seconds.The value field shall contain a floating point number giving the exposure time of the observation in units of seconds.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 value field shall contain a floating point number giving the total integrated exposure time of the observation in units of seconds.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.The value field shall contain a character string that gives the time at which the observation ended.The value field shall contain a character string that gives the time at which the observation started. -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
ObservationDurationDescription
(String key, IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, String comment) private
ObservationDurationDescription
(IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, String comment) -
Method Summary
-
Enum Constant Details
-
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
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
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
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
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
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
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
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
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 Details
-
key
-
-
Constructor Details
-
ObservationDurationDescription
private ObservationDurationDescription(IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, String comment) -
ObservationDurationDescription
private ObservationDurationDescription(String key, IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, String comment)
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
comment
- Specified by:
comment
in interfaceIFitsHeader
-
hdu
- Specified by:
hdu
in interfaceIFitsHeader
-
key
- Specified by:
key
in interfaceIFitsHeader
-
n
- Specified by:
n
in interfaceIFitsHeader
-
status
- Specified by:
status
in interfaceIFitsHeader
-
valueType
- Specified by:
valueType
in interfaceIFitsHeader
-