java.lang.Object

java.lang.Enum<STScIExt>

nom.tam.fits.header.extra.STScIExt

All Implemented Interfaces:: Serializable, Comparable<STScIExt>, java.lang.constant.Constable, IFitsHeader

public enum STScIExt extends Enum<STScIExt> implements IFitsHeader

This keyword dictionary gathered form STScI.

See http://tucana.noao.edu/ADASS/adass_proc/adass_95/zaraten/zaraten.html. Additional keywords added in 1.20.1 based on the HLSP Contributor Guide

Author:: Attila Kovacs and Richard van Nieuwenhoven

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 Constants

Enum Constant

Description

APPVEC

Type approach vectors.

BIT_RATE

Telemetry data rate (baud).

CLOCKAPP

Whether clock correction applied (boolean).

DATE_BEG

date of initial data represented (yy/mm/dd)

DATE_MAP

Date of original file creation (yy/mm/dd)

DEC_PNTE

Pointing error in declination (degrees; 1-sigma)

DEC_TARG

Declination coordinate of the target or field, in degrees

DETECTOR

ID of detector used for exposure

DISPRnn

Name(s) of dispersive element(s) used for exposure if more than one was used, with nn (zero-padded) incrementing from 1.

DISPRSR

Name of dispersive element used, or 'MULTI' if more than one defined the passband.

DOI

Digital Object Identifier for the HLSP data collection

FILE_ID

File name or observatory-unique identifier of the contributing observation.

FILTERnn

Name(s) of filter(s) used to define the passband, if more than one was used, with nn incrementing from 1 (and zero-pad if nn >9).

FOV_X_MM

Detector X field of view (mm)

FOV_Y_MM

Detector X field of view (mm)

HLSPID

The identifier (acronym) for this HLSP collection.

HLSPLEAD

Full name of HLSP project lead

HLSPNAME

Title for HLSP project, long form

HLSPTARG

Designation of the target(s) or field(s) for this HLSP

HLSPVER

Version identifier for this HLSP product

IPPS_B_P

Deprecated.
In truth this is an illegal FITS keyword, as the character '/' is not allowed in standard FITS keywords.

IPPS_ID

IPPS identification, such as target name, possibly including IPPS configuration

IPPS_MAX

Maximum value in raster

IPPS_MIN

Minimum value in raster

IPPS_RF

Raster LFN / raster ordinal

JOBNAME

?

LICENSE

License for use of these data, with the value 'CC BY 4.0'

LICENURL

Data license URL, with the value 'https://creativecommons.org/licenses/by/4.0/'

MJD_OBS

Deprecated.
Use the standard DateTime.MJD_OBS instead.

MJDREF

Deprecated.
Use the standard DateTime.MJDREF instead.

MJDREFF

Fractional portion of ephemeris MJD

MJDREFI

Integer portion of ephemeris MJD

MODAL_ID

Modal Configuration ID

OPTICn

Optical axis position in both linearized detector coordinates and sky coordinates.

ORBITBEG

beginning orbit number

ORBITEND

ending orbit number

PA_PNTE

Pointing error in position angle (degrees; 1-sigma)

PIXRESOL

Quad tree pixel resolution

PROCVER

Processing script version

PRODUCT

Data product description?

PROPOSID

Observatory program/proposal identifier, if applicable

PSFSIZE

Typical spatial extent of the point-spread function, in pix

RA_PNTE

Pointing error in right ascension (degrees, 1-sigma)

RA_TARG

Right Ascension coordinate of the target or field, in degrees

SEQNUM

Sequential number from ODB

SEQPNUM

Number of times sequence processed

SOLELONG

solar elongations included.

TASSIGN

Specifies where the time assignment of the data is done. for example, for EXOSAT time assignment was made at the Madrid tracking station, so TASSIGN ='Madrid'.

TCDLTn

Deprecated.
Use the standard WCS.TCDLTn instead.

TCRPXn

Deprecated.
Use the standard WCS.TCRPXn instead.

TCRVLn

Deprecated.
Use the standard WCS.TCRVLn instead.

TCTYPn

Deprecated.
Use the standard WCS.TCTYPn instead

TIMEREF

Time reference frame.

TIMEUNIT

Units of time, for example 's' for seconds.

TIMEZERO

Clock correction (if not zero), in TIMEUNIT.

TIMVERSN

Version of time specification convention.

TSTART

The value field of this keyword shall contain the value of the start time of data acquisition in units of TIMEUNIT, relative to MJDREF, JDREF, or DATEREF and TIMEOFFS, in the time system specified by the TIMESYS keyword.

TSTOP

The value field of this keyword shall contain the value of the stop time of data acquisition in units of TIMEUNIT, relative to MJDREF, JDREF, or DATEREF and TIMEOFFS, in the time system specified by the TIMESYS keyword.

VERSION

Version of Data Reduction Software

WAVEn

nominal wavelength of band n, value + unit.

XPOSURE

Duration of exposure, exclusive of dead time, in seconds.

ZLREMOV

Whether map was corrected for zodiacal light
Field Summary

Fields

Modifier and Type

Field

Description

static final String

COLNAME_FLAGS

Data quality (binary) flags, with zero indicating no anthologies

static final String

COLNAME_FLUX

Could also be called "FLUX_DENSITY" or something similar, depending upon the quantity stored.

static final String

COLNAME_VARIANCE

Variance in the flux(es) at the associated wavelength(s)

static final String

COLNAME_WAVELENGTH

Wavelength(s) for the associated flux(es), in units of the TUNIT keyword for this column.

static final String

DISPRSR_MULTI

Standard DISPRSR value if multiple passbands are used.

static final String

FILTER_MULTI

Standard InstrumentDescription.FILTER value if multiple passbands are used.

static final String

TIMEREF_GEOCENTRIC

Time is reported when detected wavefront passed the center of Earth, a standard value for TIMEREF.

static final String

TIMEREF_HELIOCENTRIC

Time is reported when detected wavefront passed the center of the Sun, a standard value for TIMEREF.

static final String

TIMEREF_LOCAL

Time reported is actual time of detection, a standard value for TIMEREF.

static final String

TIMEREF_SOLARSYSTEM

Time is reported when detected wavefront passed the Solar System barycenter, a standard value for TIMEREF.

Fields inherited from interface nom.tam.fits.header.IFitsHeader
MAX_INDEX
Method Summary

Modifier and Type

Method

Description

final FitsKey

impl()

(primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.

static STScIExt

valueOf(String name)

Returns the enum constant of this type with the specified name.

static STScIExt[]

values()

Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface nom.tam.fits.header.IFitsHeader
comment, extractIndices, hdu, key, n, status, valueType

Enum Constant Details
- APPVEC
  
  public static final STScIExt APPVEC
  
  Type approach vectors. E.g. 'COMBINED'
- BIT_RATE
  
  public static final STScIExt BIT_RATE
  
  Telemetry data rate (baud).
- CLOCKAPP
  
  public static final STScIExt CLOCKAPP
  
  Whether clock correction applied (boolean).
  T
- DATE_BEG
  
  public static final STScIExt DATE_BEG
  
  date of initial data represented (yy/mm/dd)
  See Also:
  
  DateTime.DATE_BEG
- DATE_MAP
  
  public static final STScIExt DATE_MAP
  
  Date of original file creation (yy/mm/dd)
- DEC_PNTE
  
  public static final STScIExt DEC_PNTE
  
  Pointing error in declination (degrees; 1-sigma)
- FOV_X_MM
  
  public static final STScIExt FOV_X_MM
  
  Detector X field of view (mm)
- FOV_Y_MM
  
  public static final STScIExt FOV_Y_MM
  
  Detector X field of view (mm)
- IPPS_B_P
  
  public static final STScIExt IPPS_B_P
  
  Deprecated.
  In truth this is an illegal FITS keyword, as the character '/' is not allowed in standard FITS keywords. If possible, avoid using it since it may result in FITS that is not readable by some software.
  
  BITS/PIXEL OF IPPS RASTER.
- IPPS_ID
  
  public static final STScIExt IPPS_ID
  
  IPPS identification, such as target name, possibly including IPPS configuration
- IPPS_MAX
  
  public static final STScIExt IPPS_MAX
  
  Maximum value in raster
- IPPS_MIN
  
  public static final STScIExt IPPS_MIN
  
  Minimum value in raster
- IPPS_RF
  
  public static final STScIExt IPPS_RF
  
  Raster LFN / raster ordinal
- JOBNAME
  
  public static final STScIExt JOBNAME
  
  ?
- MJD_OBS
  
  public static final STScIExt MJD_OBS
  
  Deprecated.
  Use the standard DateTime.MJD_OBS instead.
- MJDREF
  
  public static final STScIExt MJDREF
  
  Deprecated.
  Use the standard DateTime.MJDREF instead.
- MJDREFF
  
  public static final STScIExt MJDREFF
  
  Fractional portion of ephemeris MJD
- MJDREFI
  
  public static final STScIExt MJDREFI
  
  Integer portion of ephemeris MJD
- MODAL_ID
  
  public static final STScIExt MODAL_ID
  
  Modal Configuration ID
- OPTICn
  
  public static final STScIExt OPTICn
  
  Optical axis position in both linearized detector coordinates and sky coordinates.
- ORBITBEG
  
  public static final STScIExt ORBITBEG
  
  beginning orbit number
- ORBITEND
  
  public static final STScIExt ORBITEND
  
  ending orbit number
- PA_PNTE
  
  public static final STScIExt PA_PNTE
  
  Pointing error in position angle (degrees; 1-sigma)
- PIXRESOL
  
  public static final STScIExt PIXRESOL
  
  Quad tree pixel resolution
- PROCVER
  
  public static final STScIExt PROCVER
  
  Processing script version
- PRODUCT
  
  public static final STScIExt PRODUCT
  
  Data product description?
- RA_PNTE
  
  public static final STScIExt RA_PNTE
  
  Pointing error in right ascension (degrees, 1-sigma)
- SEQNUM
  
  public static final STScIExt SEQNUM
  
  Sequential number from ODB
- SEQPNUM
  
  public static final STScIExt SEQPNUM
  
  Number of times sequence processed
- SOLELONG
  
  public static final STScIExt SOLELONG
  
  solar elongations included. E.g. 'ALL'
- TCDLTn
  
  public static final STScIExt TCDLTn
  
  Deprecated.
  Use the standard WCS.TCDLTn instead.
- TCRPXn
  
  public static final STScIExt TCRPXn
  
  Deprecated.
  Use the standard WCS.TCRPXn instead.
- TCRVLn
  
  public static final STScIExt TCRVLn
  
  Deprecated.
  Use the standard WCS.TCRVLn instead.
- TCTYPn
  
  public static final STScIExt TCTYPn
  
  Deprecated.
  Use the standard WCS.TCTYPn instead
- TASSIGN
  
  public static final STScIExt TASSIGN
  
  Specifies where the time assignment of the data is done. for example, for EXOSAT time assignment was made at the Madrid tracking station, so TASSIGN ='Madrid'. Since the document goes on to state that this information is relevant for barycentric corrections, one assumes that this means what is of interest is not the location of the computer where time tags where inserted into the telemetry stream, but whether those time tags refer to the actual photon arrival time or to the time at which the telemetry reached the ground station, etc.
  
  For example, for Einstein the time assignment was performed at the ground station but corrected to allow for the transmission time between satellite and ground, so I presume in this case TASSIGN='SATELLITE'. I believe that for AXAF, TASSIGN = 'SATELLITE'. OGIP/93-003 also speci es the location for the case of a ground station should be recorded the keywords GEOLAT, GEOLONG, and ALTITUDE. This is rather unfortunate since it would be nice to reserve these keywords for the satellite ephemeris position. However, since no ground station is de ned for AXAF, we feel that we can use GEOLONG, GEOLAT, and ALTITUDE for these purposes, especially since such usage is consistent with their usage for ground-based observations. TASSIGN has obviously no meaning when TIMESYS = 'TDB'.
- TIMEREF
  
  public static final STScIExt TIMEREF
  
  Time reference frame.
  See Also:
  
  TIMEREF_LOCAL
  
  TIMEREF_GEOCENTRIC
  
  TIMEREF_HELIOCENTRIC
  
  TIMEREF_SOLARSYSTEM
- TIMEUNIT
  
  public static final STScIExt TIMEUNIT
  
  Units of time, for example 's' for seconds. If absent, assume seconds.
- TIMVERSN
  
  public static final STScIExt TIMVERSN
  
  Version of time specification convention.
- TIMEZERO
  
  public static final STScIExt TIMEZERO
  
  Clock correction (if not zero), in TIMEUNIT.
- TSTART
  
  public static final STScIExt TSTART
  
  The value field of this keyword shall contain the value of the start time of data acquisition in units of TIMEUNIT, relative to MJDREF, JDREF, or DATEREF and TIMEOFFS, in the time system specified by the TIMESYS keyword. Similar to DateTime.TSTART except that it strictly uses decimal values.
- TSTOP
  
  public static final STScIExt TSTOP
  
  The value field of this keyword shall contain the value of the stop time of data acquisition in units of TIMEUNIT, relative to MJDREF, JDREF, or DATEREF and TIMEOFFS, in the time system specified by the TIMESYS keyword. Similar to DateTime.TSTOP except that it strictly uses decimal values.
- VERSION
  
  public static final STScIExt VERSION
  
  Version of Data Reduction Software
- WAVEn
  
  public static final STScIExt WAVEn
  
  nominal wavelength of band n, value + unit. For example '140. microns'.
- ZLREMOV
  
  public static final STScIExt ZLREMOV
  
  Whether map was corrected for zodiacal light
- DOI
  
  public static final STScIExt DOI
  
  Digital Object Identifier for the HLSP data collection
  
  Since:
  
  1.20.1
- HLSPID
  
  public static final STScIExt HLSPID
  
  The identifier (acronym) for this HLSP collection.
  
  Since:
  
  1.20.1
- HLSPLEAD
  
  public static final STScIExt HLSPLEAD
  
  Full name of HLSP project lead
  
  Since:
  
  1.20.1
- HLSPNAME
  
  public static final STScIExt HLSPNAME
  
  Title for HLSP project, long form
  
  Since:
  
  1.20.1
- HLSPTARG
  
  public static final STScIExt HLSPTARG
  
  Designation of the target(s) or field(s) for this HLSP
  
  Since:
  
  1.20.1
- HLSPVER
  
  public static final STScIExt HLSPVER
  
  Version identifier for this HLSP product
  
  Since:
  
  1.20.1
- LICENSE
  
  public static final STScIExt LICENSE
  
  License for use of these data, with the value 'CC BY 4.0'
  Since:
  
  1.20.1
  
  See Also:
  
  LICENURL
- LICENURL
  
  public static final STScIExt LICENURL
  
  Data license URL, with the value 'https://creativecommons.org/licenses/by/4.0/'
  Since:
  
  1.20.1
  
  See Also:
  
  LICENSE
- PROPOSID
  
  public static final STScIExt PROPOSID
  
  Observatory program/proposal identifier, if applicable
  
  Since:
  
  1.20.1
- XPOSURE
  
  public static final STScIExt XPOSURE
  
  Duration of exposure, exclusive of dead time, in seconds.
- DETECTOR
  
  public static final STScIExt DETECTOR
  
  ID of detector used for exposure
  
  Since:
  
  1.20.1
- FILTERnn
  
  public static final STScIExt FILTERnn
  
  Name(s) of filter(s) used to define the passband, if more than one was used, with nn incrementing from 1 (and zero-pad if nn >9). As such for a passband index of 4, you might use FILTERnn.n(0).n(4) to construct 'FILTER04'. It is similar to the more standard InstrumentDescription.FILTERn keyword except for the 2-digit, zero-padded, indexing for bands 1--9.
  
  Since:
  
  1.20.1
- DEC_TARG
  
  public static final STScIExt DEC_TARG
  
  Declination coordinate of the target or field, in degrees
  
  Since:
  
  1.20.1
- PSFSIZE
  
  public static final STScIExt PSFSIZE
  
  Typical spatial extent of the point-spread function, in pix
  
  Since:
  
  1.20.1
- RA_TARG
  
  public static final STScIExt RA_TARG
  
  Right Ascension coordinate of the target or field, in degrees
  
  Since:
  
  1.20.1
- DISPRSR
  
  public static final STScIExt DISPRSR
  
  Name of dispersive element used, or 'MULTI' if more than one defined the passband.
  Since:
  
  1.20.1
  
  See Also:
  
  DISPRSR_MULTI
- DISPRnn
  
  public static final STScIExt DISPRnn
  
  Name(s) of dispersive element(s) used for exposure if more than one was used, with nn (zero-padded) incrementing from 1. Note that this information can alternatively be represented in a PROVENANCE extension. See Provenance Metadata for details. As such for a passband index of 4, you might use DISPRnn.n(0).n(4) to construct 'DISPR04'.
  
  Since:
  
  1.20.1
- FILE_ID
  
  public static final STScIExt FILE_ID
  
  File name or observatory-unique identifier of the contributing observation. For products from MAST missions, provide the Observation ID so that the contributing data may be linked within MAST.
  
  Since:
  
  1.20.1
Field Details
- TIMEREF_GEOCENTRIC
  
  public static final String TIMEREF_GEOCENTRIC
  
  Time is reported when detected wavefront passed the center of Earth, a standard value for TIMEREF.
  Since:
  
  1.20.1
  
  See Also:
  
  Constant Field Values
- TIMEREF_HELIOCENTRIC
  
  public static final String TIMEREF_HELIOCENTRIC
  
  Time is reported when detected wavefront passed the center of the Sun, a standard value for TIMEREF.
  Since:
  
  1.20.1
  
  See Also:
  
  Constant Field Values
- TIMEREF_SOLARSYSTEM
  
  public static final String TIMEREF_SOLARSYSTEM
  
  Time is reported when detected wavefront passed the Solar System barycenter, a standard value for TIMEREF.
  Since:
  
  1.20.1
  
  See Also:
  
  Constant Field Values
- TIMEREF_LOCAL
  
  public static final String TIMEREF_LOCAL
  
  Time reported is actual time of detection, a standard value for TIMEREF.
  Since:
  
  1.20.1
  
  See Also:
  
  Constant Field Values
- FILTER_MULTI
  
  public static final String FILTER_MULTI
  
  Standard InstrumentDescription.FILTER value if multiple passbands are used.
  See Also:
  
  Constant Field Values
- DISPRSR_MULTI
  
  public static final String DISPRSR_MULTI
  
  Standard DISPRSR value if multiple passbands are used.
  See Also:
  
  Constant Field Values
- COLNAME_FLAGS
  
  public static final String COLNAME_FLAGS
  
  Data quality (binary) flags, with zero indicating no anthologies
  See Also:
  
  Constant Field Values
- COLNAME_FLUX
  
  public static final String COLNAME_FLUX
  
  Could also be called "FLUX_DENSITY" or something similar, depending upon the quantity stored. Flux(es) for the associated wavelength(s), in units of the value of the TUNIT keyword for this column.
  See Also:
  
  Constant Field Values
- COLNAME_VARIANCE
  
  public static final String COLNAME_VARIANCE
  
  Variance in the flux(es) at the associated wavelength(s)
  See Also:
  
  Constant Field Values
- COLNAME_WAVELENGTH
  
  public static final String COLNAME_WAVELENGTH
  
  Wavelength(s) for the associated flux(es), in units of the TUNIT keyword for this column.
  See Also:
  
  Constant Field Values
Method Details
- values
  
  public static STScIExt[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static STScIExt valueOf(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:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null
- impl
  
  public final FitsKey impl()
  
  Description copied from interface: IFitsHeader
  
  (primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
  
  Specified by:
  
  impl in interface IFitsHeader
  
  Returns:
  
  the implementation of this keyword, which provides the actual access methods. Implementations of this interface should simply return themselves.

Enum STScIExt

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Nested classes/interfaces inherited from interface nom.tam.fits.header.IFitsHeader

Enum Constant Summary

Field Summary

Fields inherited from interface nom.tam.fits.header.IFitsHeader

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface nom.tam.fits.header.IFitsHeader

Enum Constant Details

APPVEC

BIT_RATE

CLOCKAPP

DATE_BEG

DATE_MAP

DEC_PNTE

FOV_X_MM

FOV_Y_MM

IPPS_B_P

IPPS_ID

IPPS_MAX

IPPS_MIN

IPPS_RF

JOBNAME

MJD_OBS

MJDREF

MJDREFF

MJDREFI

MODAL_ID

OPTICn

ORBITBEG

ORBITEND

PA_PNTE

PIXRESOL

PROCVER

PRODUCT

RA_PNTE

SEQNUM

SEQPNUM

SOLELONG

TCDLTn

TCRPXn

TCRVLn

TCTYPn

TASSIGN

TIMEREF

TIMEUNIT

TIMVERSN

TIMEZERO

TSTART

TSTOP

VERSION

WAVEn

ZLREMOV

DOI

HLSPID

HLSPLEAD

HLSPNAME

HLSPTARG

HLSPVER

LICENSE

LICENURL

PROPOSID

XPOSURE

DETECTOR

FILTERnn

DEC_TARG

PSFSIZE

RA_TARG

DISPRSR

DISPRnn

FILE_ID

Field Details

TIMEREF_GEOCENTRIC

TIMEREF_HELIOCENTRIC

TIMEREF_SOLARSYSTEM

TIMEREF_LOCAL

FILTER_MULTI