Package nom.tam.fits.header.extra

Enum CXCExt

java.lang.Object

java.lang.Enum<CXCExt>

nom.tam.fits.header.extra.CXCExt

All Implemented Interfaces:

Serializable, Comparable<CXCExt>, java.lang.constant.Constable, IFitsHeader

public enum CXCExt
extends Enum<CXCExt>
implements IFitsHeader

This is the file content.txt that presents a comprehensive compilation of all classes of data products in the Chandra Data Archive for the "flight" dataset. This file is the definitive authority on the values of various FITS header keywords.

All files are identified by the CONTENT value of their principal HDUs.

Originally based on the Guide to Chandra Data Products, with additional keyword entries added in 1.20.1 based on the FITS Keyword Conventions in CXC Data Model files SDS-7.3.

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
ASCDSVER	ASC-DS processing system revision (release)
BTIMCORR	Correction applied to Basic Time rate (s)
BTIMDRFT	Basic Time clock drift (s / VCDUcount2)
BTIMNULL	Basic Time offset (s)
BTIMRATE	Basic Time clock rate (s / VCDUcount)
CLOCKAPP	Same as STScIExt.CLOCKAPP.
CNAMEn	Override Standard.CTYPEn image coordinate axis name
CONTENT	Data product identification
CONVERS	The format of the CONVERS keyword is 'i.j.k'. if missing, the default value will be '1.0.0'
CPREF	List of 'preferred cols' for making image from table
DATACLAS	Data class: 'observed' or 'simulated'
DEFOCUS	Defocus distance of instrument in mm rel to best.
DSFORMn	Data Subspace data type name (optional) for column n.
DSREFn	Data Subspace table pointer for column n.
DSTYPn	Data Subspace column name for column n.
DSUNITn	Data Subspace unit name (optional) for column n.
DSVALn	Data Subspace filter list for column n.
DTCOR	Dead time correction factor [0.0:1.0].
DTYPEn	Name for composite long-named keyword (f.
DUNITn	Unit for composite long-named keyword for column n.
DVALn	Value for composite long-named keyword for column n.
FOC_LEN	Assumed focal length, mm; Level 1 and up
GAINFILE	CALDB file for gain corretion
GRD_FILE	CALDB file for grade correction
HDUNAME	Gives a name to an HDU.
HDUSPEC	ICD reference.
LONGSTRN	The OGIP long string convention may be used.
METYPn	Type of composite column (not yet supported)
MFORMn	Comma-separated list of column names making up composite col (with MTYPEn).
MISSION	Mission specifier, e.g.
MTYPEn	Composite column name (paired with MFORMn).
nDSREFn	Data Subspace table pointer for component i (leading index) and column n (trailing index).
nDSVALn	Data Subspace filter list for component i (leading index) and column n (trailing index).
READMODE	Configuration of instrument
REVISION	Processing version of data
ROLL_NOM	Nominal roll angle, deg
SEQ_NUM	Sequence number
SIM_X	SIM focus pos (mm)
SIM_Y	SIM orthogonal axis pos (mm)
SIM_Z	SIM translation stage pos (mm)
STARTMJF	Major frame count at start
STARTMNF	Minor frame count at start
STARTOBT	On-Board MET close to STARTMJF and STARTMNF
STOPMJF	Major frame count at stop
STOPMNF	Minor frame count at stop
TASSIGN	Same as STScIExt.TASSIGN.
TCNAMn	Override WCS.TCTYPn table oordinate axis name.
TDBINn	Default binning factor for table column
TDNULLn	Floating point null value other than NaN
TIERABSO	Absolute timing error.
TIERRELA	Clock rate error
TIMEDEL	Same as DateTime.TIMEDEL.
TIMEPIXR	Time stamp reference as bin fraction
TIMEREF	Same as STScIExt.TIMEREF.
TIMEUNIT	Same as STScIExt.TIMEUNIT.
TIMEZERO	Same as STScIExt.TIMEZERO.
TIMVERSN	Same as STScIExt.TIMVERSN.
TLMVER	Telemetry revision number (IP&CL)
TSTART	Same as STScIExt.TSTART.
TSTOP	Same as STScIExt.TSTOP.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATACLAS_OBSERVED	Standard DATACLAS value 'observed'.
static final String	DATACLAS_SIMULATED	Standard DATACLAS value 'simulated'.
static final String	OBS_MODE_GROUND_CAL	Standard InstrumentDescription.OBS_MODE value for ground cal observations.
static final String	OBS_MODE_POINTING	Standard InstrumentDescription.OBS_MODE value for pointing observations.
static final String	OBS_MODE_SLEWING	Standard InstrumentDescription.OBS_MODE value while slewing.
static final String	TIMEREF_GEOCENTRIC	Same as STScIExt.TIMEREF_GEOCENTRIC.
static final String	TIMEREF_HELIOCENTRIC	Same as STScIExt.TIMEREF_HELIOCENTRIC.
static final String	TIMEREF_LOCAL	Same as STScIExt.TIMEREF_LOCAL.
static final String	TIMEREF_SOLARSYSTEM	Same as STScIExt.TIMEREF_SOLARSYSTEM.

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 CXCExt	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CXCExt[]	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

ASCDSVER

public static final CXCExt ASCDSVER

ASC-DS processing system revision (release)

BTIMCORR

public static final CXCExt BTIMCORR

Correction applied to Basic Time rate (s)

BTIMDRFT

public static final CXCExt BTIMDRFT

Basic Time clock drift (s / VCDUcount²)

BTIMNULL

public static final CXCExt BTIMNULL

Basic Time offset (s)

BTIMRATE

public static final CXCExt BTIMRATE

Basic Time clock rate (s / VCDUcount)

CONTENT

public static final CXCExt CONTENT

Data product identification

CONVERS

public static final CXCExt CONVERS

The format of the CONVERS keyword is 'i.j.k'. if missing, the default value will be '1.0.0'

DATACLAS

public static final CXCExt DATACLAS

Data class: 'observed' or 'simulated'

See Also:

• DATACLAS_OBSERVED
• DATACLAS_SIMULATED

DTCOR

public static final CXCExt DTCOR

Dead time correction factor [0.0:1.0].

FOC_LEN

public static final CXCExt FOC_LEN

Assumed focal length, mm; Level 1 and up

HDUSPEC

public static final CXCExt HDUSPEC

ICD reference. E.g. 'HRC Level 1 Data Products ICD, Version 1.1'

LONGSTRN

public static final CXCExt LONGSTRN

The OGIP long string convention may be used.

MISSION

public static final CXCExt MISSION

Mission specifier, e.g. 'AXAF'

REVISION

public static final CXCExt REVISION

Processing version of data

ROLL_NOM

public static final CXCExt ROLL_NOM

Nominal roll angle, deg

SEQ_NUM

public static final CXCExt SEQ_NUM

Sequence number

SIM_X

public static final CXCExt SIM_X

SIM focus pos (mm)

SIM_Y

public static final CXCExt SIM_Y

SIM orthogonal axis pos (mm)

SIM_Z

public static final CXCExt SIM_Z

SIM translation stage pos (mm)

STARTMJF

public static final CXCExt STARTMJF

Major frame count at start

STARTMNF

public static final CXCExt STARTMNF

Minor frame count at start

STARTOBT

public static final CXCExt STARTOBT

On-Board MET close to STARTMJF and STARTMNF

STOPMJF

public static final CXCExt STOPMJF

Major frame count at stop

STOPMNF

public static final CXCExt STOPMNF

Minor frame count at stop

TIERABSO

public static final CXCExt TIERABSO

Absolute timing error.

TIERRELA

public static final CXCExt TIERRELA

Clock rate error

TIMEPIXR

public static final CXCExt TIMEPIXR

Time stamp reference as bin fraction

TLMVER

public static final CXCExt TLMVER

Telemetry revision number (IP&CL)

CLOCKAPP

public static final CXCExt CLOCKAPP

Same as STScIExt.CLOCKAPP.

Since:

1.20.1

TASSIGN

public static final CXCExt TASSIGN

Same as STScIExt.TASSIGN.

Since:

1.20.1

TIMEDEL

public static final CXCExt TIMEDEL

Same as DateTime.TIMEDEL.

Since:

1.20.1

TIMEREF

public static final CXCExt TIMEREF

Same as STScIExt.TIMEREF.

Since:

1.20.1

See Also:

• TIMEREF_LOCAL
• TIMEREF_GEOCENTRIC
• TIMEREF_HELIOCENTRIC
• TIMEREF_SOLARSYSTEM

TIMEUNIT

public static final CXCExt TIMEUNIT

Same as STScIExt.TIMEUNIT.

Since:

1.20.1

TIMVERSN

public static final CXCExt TIMVERSN

Same as STScIExt.TIMVERSN.

Since:

1.20.1

TIMEZERO

public static final CXCExt TIMEZERO

Same as STScIExt.TIMEZERO.

Since:

1.20.1

TSTART

public static final CXCExt TSTART

Same as STScIExt.TSTART.

TSTOP

public static final CXCExt TSTOP

Same as STScIExt.TSTOP.

DEFOCUS

public static final CXCExt DEFOCUS

Defocus distance of instrument in mm rel to best.

Since:

1.20.1

READMODE

public static final CXCExt READMODE

Configuration of instrument

Since:

1.20.1

GAINFILE

public static final CXCExt GAINFILE

CALDB file for gain corretion

Since:

1.20.1

GRD_FILE

public static final CXCExt GRD_FILE

CALDB file for grade correction

Since:

1.20.1

CNAMEn

public static final CXCExt CNAMEn

Override Standard.CTYPEn image coordinate axis name

Since:

1.20.1

CPREF

public static final CXCExt CPREF

List of 'preferred cols' for making image from table

Since:

1.20.1

DSTYPn

public static final CXCExt DSTYPn

Data Subspace column name for column n.

Since:

1.20.1

DSFORMn

public static final CXCExt DSFORMn

Data Subspace data type name (optional) for column n.

Since:

1.20.1

DSUNITn

public static final CXCExt DSUNITn

Data Subspace unit name (optional) for column n.

Since:

1.20.1

DSVALn

public static final CXCExt DSVALn

Data Subspace filter list for column n.

Since:

1.20.1

nDSVALn

public static final CXCExt nDSVALn

Data Subspace filter list for component i (leading index) and column n (trailing index).

Since:

1.20.1

See Also:

• DSVALn

DSREFn

public static final CXCExt DSREFn

Data Subspace table pointer for column n.

Since:

1.20.1

nDSREFn

public static final CXCExt nDSREFn

Data Subspace table pointer for component i (leading index) and column n (trailing index).

Since:

1.20.1

See Also:

• DSVALn

DTYPEn

public static final CXCExt DTYPEn

Name for composite long-named keyword (f. CFITSIO HIERARCH) for column n. Also used to de ne array keywords.

Since:

1.20.1

DUNITn

public static final CXCExt DUNITn

Unit for composite long-named keyword for column n.

Since:

1.20.1

DVALn

public static final CXCExt DVALn

Value for composite long-named keyword for column n.

Since:

1.20.1

HDUNAME

public static final CXCExt HDUNAME

Gives a name to an HDU. If not present, you should use EXTNAME/EXTVER.

Since:

1.20.1

METYPn

public static final CXCExt METYPn

Type of composite column (not yet supported)

Since:

1.20.1

MFORMn

public static final CXCExt MFORMn

Comma-separated list of column names making up composite col (with MTYPEn).

Since:

1.20.1

MTYPEn

public static final CXCExt MTYPEn

Composite column name (paired with MFORMn).

Since:

1.20.1

TCNAMn

public static final CXCExt TCNAMn

Override WCS.TCTYPn table oordinate axis name.

Since:

1.20.1

TDBINn

public static final CXCExt TDBINn

Default binning factor for table column

Since:

1.20.1

TDNULLn

public static final CXCExt TDNULLn

Floating point null value other than NaN

Since:

1.20.1

Field Details

DATACLAS_OBSERVED

public static final String DATACLAS_OBSERVED

Standard DATACLAS value 'observed'.

Since:

1.20.1

See Also:

• Constant Field Values

DATACLAS_SIMULATED

public static final String DATACLAS_SIMULATED

Standard DATACLAS value 'simulated'.

Since:

1.20.1

See Also:

• Constant Field Values

OBS_MODE_POINTING

public static final String OBS_MODE_POINTING

Standard InstrumentDescription.OBS_MODE value for pointing observations.

Since:

1.20.1

See Also:

• Constant Field Values

OBS_MODE_SLEWING

public static final String OBS_MODE_SLEWING

Standard InstrumentDescription.OBS_MODE value while slewing.

Since:

1.20.1

See Also:

• Constant Field Values

OBS_MODE_GROUND_CAL

public static final String OBS_MODE_GROUND_CAL

Standard InstrumentDescription.OBS_MODE value for ground cal observations.

Since:

1.20.1

See Also:

• Constant Field Values

TIMEREF_GEOCENTRIC

public static final String TIMEREF_GEOCENTRIC

Same as STScIExt.TIMEREF_GEOCENTRIC.

Since:

1.20.1

See Also:

• Constant Field Values

TIMEREF_HELIOCENTRIC

public static final String TIMEREF_HELIOCENTRIC

Same as STScIExt.TIMEREF_HELIOCENTRIC.

Since:

1.20.1

See Also:

• Constant Field Values

TIMEREF_SOLARSYSTEM

public static final String TIMEREF_SOLARSYSTEM

Same as STScIExt.TIMEREF_SOLARSYSTEM.

Since:

1.20.1

See Also:

• Constant Field Values

TIMEREF_LOCAL

public static final String TIMEREF_LOCAL

Same as STScIExt.TIMEREF_LOCAL.

Since:

1.20.1

See Also:

• Constant Field Values

Method Details

values

public static CXCExt[] 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 CXCExt 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.