java.lang.Object

java.lang.Enum<Standard>

nom.tam.fits.header.Standard

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

public enum Standard extends Enum<Standard> implements IFitsHeader

This data dictionary lists the 53 keywords currently defined in the FITS Standard.

See http://heasarc.gsfc.nasa.gov/docs/fcg/standard_dict.html

Author:: 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

AUTHOR

The value field shall contain a character string identifying who compiled the information in the data associated with the key.

BITPIX

The value field shall contain an integer.

BLANK

This keyword shall be used only in primary array headers or IMAGE extension headers with positive values of BITPIX (i.e., in arrays with integer data).

BLANKS

Columns 1-8 contain ASCII blanks.

BLOCKED

Deprecated.
no blocksize other that 2880 may be used.

BSCALE

This keyword shall be used, along with the BZERO keyword, when the array pixel values are not the true physical values, to transform the primary data array values to the true physical values they represent, using the equation: physical_value = BZERO + BSCALE * array_value.

BUNIT

The value field shall contain a character string, describing the physical units in which the quantities in the array, after application of BSCALE and BZERO, are expressed.

BZERO

This keyword shall be used, along with the BSCALE keyword, when the array pixel values are not the true physical values, to transform the primary data array values to the true values using the equation: physical_value = BZERO + BSCALE * array_value.

CDELTn

The value field shall contain a floating point number giving the partial derivative of the coordinate specified by the CTYPEn keywords with respect to the pixel index, evaluated at the reference point CRPIXn, in units of the coordinate specified by the CTYPEn keyword.

COMMENT

This keyword shall have no associated value; columns 9-80 may contain any ASCII text.

CONTINUE

The CONTINUE keyword, when followed by spaces in columns 9 and 10 of the card image and a character string enclosed in single quotes starting in column 11 or higher, indicates that the quoted string should be treated as a continuation of the character string value in the previous key keyword.

CROTAn

This keyword is used to indicate a rotation from a standard coordinate system described by the CTYPEn to a different coordinate system in which the values in the array are actually expressed.

CRPIXn

The value field shall contain a floating point number, identifying the location of a reference point along axis n, in units of the axis index.

CRVALn

The value field shall contain a floating point number, giving the value of the coordinate specified by the CTYPEn keyword at the reference point CRPIXn.

CTYPEn

The value field shall contain a character string, giving the name of the coordinate represented by axis n.

DATAMAX

The value field shall always contain a floating point number, regardless of the value of BITPIX.

DATAMIN

The value field shall always contain a floating point number, regardless of the value of BITPIX.

DATE

The date on which the HDU was created, in the format specified in the FITS Standard.

DATE_OBS

The date of the observation, in the format specified in the FITS Standard.

END

This keyword has no associated value.

EPOCH

Deprecated.
Deprecated by the FITS standard in favor of EQUINOX.

EQUINOX

The value field shall contain a floating point number giving the equinox in years for the celestial coordinate system in which positions are expressed.

EXTEND

If the FITS file may contain extensions, a card image with the keyword EXTEND and the value field containing the logical value T must appear in the primary key immediately after the last NAXISn card image, or, if NAXIS=0, the NAXIS card image.

EXTLEVEL

The value field shall contain an integer, specifying the level in a hierarchy of extension levels of the extension key containing it.

EXTNAME

The value field shall contain a character string, to be used to distinguish among different extensions of the same type, i.e., with the same value of XTENSION, in a FITS file.

EXTVER

The value field shall contain an integer, to be used to distinguish among different extensions in a FITS file with the same type and name, i.e., the same values for XTENSION and EXTNAME.

GCOUNT

The value field shall contain an integer that shall be used in any way appropriate to define the data structure, consistent with Eq. 5.2 in the FITS Standard.

GROUPS

The value field shall contain the logical constant T.

HISTORY

This keyword shall have no associated value; columns 9-80 may contain any ASCII text.

INHERIT

If set to true, it indicates that the HDU should inherit all non-confliucting keywords from the primary HDU.

INSTRUME

The value field shall contain a character string identifying the instrument used to acquire the data associated with the key.

NAXIS

The value field shall contain a non-negative integer no greater than 999, representing the number of axes in the associated data array.

NAXISn

The value field of this indexed keyword shall contain a non-negative integer, representing the number of elements along axis n of a data array.

OBJECT

The value field shall contain a character string giving a name for the object observed.

OBSERVER

The value field shall contain a character string identifying who acquired the data associated with the key.

ORIGIN

The value field shall contain a character string identifying the organization or institution responsible for creating the FITS file.

PCOUNT

The value field shall contain an integer that shall be used in any way appropriate to define the data structure, consistent with Eq. 5.2 in the FITS Standard.

PSCALn

This keyword is reserved for use within the FITS Random Groups structure.

PTYPEn

This keyword is reserved for use within the FITS Random Groups structure.

PZEROn

This keyword is reserved for use within the FITS Random Groups structure.

RADECSYS

Deprecated.
Deprecated in the current FITS satndard, use RADESYS instead.

RADESYS

Coordinate reference frame of major/minor axes.If absent the default value is 'FK5'.

REFERENC

The value field shall contain a character string citing a reference where the data associated with the key are published.

RESTFREQ

Deprecated.
Deprecated in the current FITS standard, use RESTFRQ instead.

RESTFRQ

[Hz] Rest frequency of observed spectral line.

SIMPLE

The SIMPLE keyword is required to be the first keyword in the primary key of all FITS files.

TBCOLn

The value field of this indexed keyword shall contain an integer specifying the column in which field n starts in an ASCII TABLE extension.

TDIMn

The value field of this indexed keyword shall contain a character string describing how to interpret the contents of field n as a multidimensional array, providing the number of dimensions and the length along each axis.

TDISPn

The value field of this indexed keyword shall contain a character string describing the format recommended for the display of the contents of field n.

TDMAXn

The value field of this indexed keyword shall contain a floating point number specifying the maximum valid physical value represented in column n of the table, exclusive of any special values.

TDMINn

The value field of this indexed keyword shall contain a floating point number specifying the minimum valid physical value represented in column n of the table, exclusive of any special values.

TELESCOP

The value field shall contain a character string identifying the telescope used to acquire the data associated with the key.

TFIELDS

The value field shall contain a non-negative integer representing the number of fields in each row of a 'TABLE' or 'BINTABLE' extension.

TFORMn

The value field of this indexed keyword shall contain a character string describing the format in which field n is encoded in a 'TABLE' or 'BINTABLE' extension.

THEAP

The value field of this keyword shall contain an integer providing the separation, in bytes, between the start of the main data table and the start of a supplemental data area called the heap.

TLMAXn

The value field of this indexed keyword shall contain a floating point number specifying the upper bound of the legal range of physical values that may be represented in column n of the table.

TLMINn

The value field of this indexed keyword shall contain a floating point number specifying the lower bound of the legal range of physical values that may be represented in column n of the table.

TNULLn

In ASCII 'TABLE' extensions, the value field for this indexed keyword shall contain the character string that represents an undefined value for field n.

TSCALn

This indexed keyword shall be used, along with the TZEROn keyword, when the quantity in field n does not represent a true physical quantity.

TTYPEn

The value field for this indexed keyword shall contain a character string, giving the name of field n.

TUNITn

The value field shall contain a character string describing the physical units in which the quantity in field n, after any application of TSCALn and TZEROn, is expressed.

TZEROn

This indexed keyword shall be used, along with the TSCALn keyword, when the quantity in field n does not represent a true physical quantity.

XTENSION

The value field shall contain a character string giving the name of the extension type.
Field Summary

Fields

Modifier and Type

Field

Description

static final IFitsHeader

NAXIS1

A shorthand for NAXISn.n(1), that is the regular dimension along the first, fastest FITS array index (this is the same as the last dimension of Java arrays).

static final IFitsHeader

NAXIS2

A shorthand for NAXISn.n(2), that is the regular dimension along the second fastest FITS array index (this is the same as the one before the last dimension of Java arrays).

static final String

XTENSION_ASCIITABLE

The value of the XTENSION keword in case of a binary table.

static final String

XTENSION_BINTABLE

The value of the XTENSION keword in case of a binary table.

static final String

XTENSION_IMAGE

The value of the XTENSION keword in case of an image.

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

Modifier and Type

Method

Description

String

comment()

Returns the comment associated to this FITS header entry.

static void

context(Class<?> clazz)

Deprecated.
(for internal use) Using HeaderCard.setComment(String) after creating a header card with this keyword provides a more transparent way of setting context-specific comments.

String

getCommentByKey(String commentKey)

Deprecated.
()for internal use)

final FitsKey

impl()

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

static IFitsHeader

match(String key)

Returns the standard FITS keyword that matches the specified actual key.

void

setCommentByKey(String commentKey, String value)

Deprecated.
()for internal use)

static Standard

valueOf(String name)

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

static Standard[]

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
extractIndices, hdu, key, n, status, valueType

Enum Constant Details
- AUTHOR
  
  public static final Standard AUTHOR
  
  The value field shall contain a character string identifying who compiled the information in the data associated with the key. This keyword is appropriate when the data originate in a published paper or are compiled from many sources.
- BITPIX
  
  public static final Standard BITPIX
  
  The value field shall contain an integer. The absolute value is used in computing the sizes of data structures. It shall specify the number of bits that represent a data value. RANGE: -64,-32,8,16,32
  See Also:
  
  Bitpix
- BLANK
  
  public static final Standard BLANK
  
  This keyword shall be used only in primary array headers or IMAGE extension headers with positive values of BITPIX (i.e., in arrays with integer data). Columns 1-8 contain the string, `BLANK ' (ASCII blanks in columns 6-8). The value field shall contain an integer that specifies the representation of array values whose physical values are undefined.
- BLANKS
  
  public static final Standard BLANKS
  
  Columns 1-8 contain ASCII blanks. This keyword has no associated value. Columns 9-80 may contain any ASCII text. Any number of card images with blank keyword fields may appear in a key.
- BLOCKED
  
  @Deprecated public static final Standard BLOCKED
  
  Deprecated.
  no blocksize other that 2880 may be used.
  
  This keyword may be used only in the primary key. It shall appear within the first 36 card images of the FITS file. (Note: This keyword thus cannot appear if NAXIS is greater than 31, or if NAXIS is greater than 30 and the EXTEND keyword is present.) Its presence with the required logical value of T advises that the physical block size of the FITS file on which it appears may be an integral multiple of the logical record length, and not necessarily equal to it. Physical block size and logical record length may be equal even if this keyword is present or unequal if it is absent. It is reserved primarily to prevent its use with other meanings. Since the issuance of version 1 of the standard, the BLOCKED keyword has been deprecated.
- BSCALE
  
  public static final Standard BSCALE
  
  This keyword shall be used, along with the BZERO keyword, when the array pixel values are not the true physical values, to transform the primary data array values to the true physical values they represent, using the equation: physical_value = BZERO + BSCALE * array_value. The value field shall contain a floating point number representing the coefficient of the linear term in the scaling equation, the ratio of physical value to array value at zero offset. The default value for this keyword is 1.0.
- BUNIT
  
  public static final Standard BUNIT
  
  The value field shall contain a character string, describing the physical units in which the quantities in the array, after application of BSCALE and BZERO, are expressed. The units of all FITS key keyword values, with the exception of measurements of angles, should conform with the recommendations in the IAU Style Manual. For angular measurements given as floating point values and specified with reserved keywords, degrees are the recommended units (with the units, if specified, given as 'deg').
- BZERO
  
  public static final Standard BZERO
  
  This keyword shall be used, along with the BSCALE keyword, when the array pixel values are not the true physical values, to transform the primary data array values to the true values using the equation: physical_value = BZERO + BSCALE * array_value. The value field shall contain a floating point number representing the physical value corresponding to an array value of zero. The default value for this keyword is 0.0.
- CDELTn
  
  public static final Standard CDELTn
  
  The value field shall contain a floating point number giving the partial derivative of the coordinate specified by the CTYPEn keywords with respect to the pixel index, evaluated at the reference point CRPIXn, in units of the coordinate specified by the CTYPEn keyword. These units must follow the prescriptions of section 5.3 of the FITS Standard.
  See Also:
  
  WCS.CDELTna
- COMMENT
  
  public static final Standard COMMENT
  
  This keyword shall have no associated value; columns 9-80 may contain any ASCII text. Any number of COMMENT card images may appear in a key.
- CONTINUE
  
  public static final Standard CONTINUE
  
  The CONTINUE keyword, when followed by spaces in columns 9 and 10 of the card image and a character string enclosed in single quotes starting in column 11 or higher, indicates that the quoted string should be treated as a continuation of the character string value in the previous key keyword. To conform to this convention, the character string value on the previous keyword must end with the ampersand character ('&'), but the ampersand is not part of the value string and should be deleted before concatenating the strings together. The character string value may be continued on any number of consecutive CONTINUE keywords, thus effectively allowing arbitrarily long strings to be written as keyword values.
- CROTAn
  
  public static final Standard CROTAn
  
  This keyword is used to indicate a rotation from a standard coordinate system described by the CTYPEn to a different coordinate system in which the values in the array are actually expressed. Rules for such rotations are not further specified in the Standard; the rotation should be explained in comments. The value field shall contain a floating point number giving the rotation angle in degrees between axis n and the direction implied by the coordinate system defined by CTYPEn. In unit degrees.
- CRPIXn
  
  public static final Standard CRPIXn
  
  The value field shall contain a floating point number, identifying the location of a reference point along axis n, in units of the axis index. This value is based upon a counter that runs from 1 to NAXISn with an increment of 1 per pixel. The reference point value need not be that for the center of a pixel nor lie within the actual data array. Use comments to indicate the location of the index point relative to the pixel.
  See Also:
  
  WCS.CRPIXna
- CRVALn
  
  public static final Standard CRVALn
  
  The value field shall contain a floating point number, giving the value of the coordinate specified by the CTYPEn keyword at the reference point CRPIXn. Units must follow the prescriptions of section 5.3 of the FITS Standard.
  See Also:
  
  WCS.CRVALna
- CTYPEn
  
  public static final Standard CTYPEn
  
  The value field shall contain a character string, giving the name of the coordinate represented by axis n.
  See Also:
  
  WCS.CTYPEna
- DATAMAX
  
  public static final Standard DATAMAX
  
  The value field shall always contain a floating point number, regardless of the value of BITPIX. This number shall give the maximum valid physical value represented by the array, exclusive of any special values.
- DATAMIN
  
  public static final Standard DATAMIN
  
  The value field shall always contain a floating point number, regardless of the value of BITPIX. This number shall give the minimum valid physical value represented by the array, exclusive of any special values.
- DATE
  
  public static final Standard DATE
  
  The date on which the HDU was created, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. the new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
  See Also:
  
  DateTime.DATE
- DATE_OBS
  
  public static final Standard DATE_OBS
  
  The date of the observation, in the format specified in the FITS Standard. The old date format was 'yy/mm/dd' and may be used only for dates from 1900 through 1999. The new Y2K compliant date format is 'yyyy-mm-dd' or 'yyyy-mm-ddTHH:MM:SS[.sss]'.
  See Also:
  
  DateTime.DATE_OBS
- END
  
  public static final Standard END
  
  This keyword has no associated value. Columns 9-80 shall be filled with ASCII blanks.
- EPOCH
  
  public static final Standard EPOCH
  
  Deprecated.
  Deprecated by the FITS standard in favor of EQUINOX.
  
  The value field shall contain a floating point number giving the equinox in years for the celestial coordinate system in which positions are expressed. Starting with Version 1, the Standard has deprecated the use of the EPOCH keyword and thus it shall not be used in FITS files created after the adoption of the standard; rather, the EQUINOX keyword shall be used.
- EQUINOX
  
  public static final Standard EQUINOX
  
  The value field shall contain a floating point number giving the equinox in years for the celestial coordinate system in which positions are expressed. This version of the keyword does not support alternative coordinate systems.
  See Also:
  
  WCS.EQUINOXa
- EXTEND
  
  public static final Standard EXTEND
  
  If the FITS file may contain extensions, a card image with the keyword EXTEND and the value field containing the logical value T must appear in the primary key immediately after the last NAXISn card image, or, if NAXIS=0, the NAXIS card image. The presence of this keyword with the value T in the primary key does not require that extensions be present.
- EXTLEVEL
  
  public static final Standard EXTLEVEL
  
  The value field shall contain an integer, specifying the level in a hierarchy of extension levels of the extension key containing it. The value shall be 1 for the highest level; levels with a higher value of this keyword shall be subordinate to levels with a lower value. If the EXTLEVEL keyword is absent, the file should be treated as if the value were 1. This keyword is used to describe an extension and should not appear in the primary key.RANGE: [1:] DEFAULT: 1
- EXTNAME
  
  public static final Standard EXTNAME
  
  The value field shall contain a character string, to be used to distinguish among different extensions of the same type, i.e., with the same value of XTENSION, in a FITS file. This keyword is used to describe an extension and but may appear in the primary header also.
- EXTVER
  
  public static final Standard EXTVER
  
  The value field shall contain an integer, to be used to distinguish among different extensions in a FITS file with the same type and name, i.e., the same values for XTENSION and EXTNAME. The values need not start with 1 for the first extension with a particular value of EXTNAME and need not be in sequence for subsequent values. If the EXTVER keyword is absent, the file should be treated as if the value were 1. This keyword is used to describe an extension and should not appear in the primary key.RANGE: [1:] DEFAULT: 1
- GCOUNT
  
  public static final Standard GCOUNT
  
  The value field shall contain an integer that shall be used in any way appropriate to define the data structure, consistent with Eq. 5.2 in the FITS Standard. This keyword originated for use in FITS Random Groups where it specifies the number of random groups present. In most other cases this keyword will have the value 1.
- GROUPS
  
  public static final Standard GROUPS
  
  The value field shall contain the logical constant T. The value T associated with this keyword implies that random groups records are present.
- HISTORY
  
  public static final Standard HISTORY
  
  This keyword shall have no associated value; columns 9-80 may contain any ASCII text. The text should contain a history of steps and procedures associated with the processing of the associated data. Any number of HISTORY card images may appear in a key.
- INSTRUME
  
  public static final Standard INSTRUME
  
  The value field shall contain a character string identifying the instrument used to acquire the data associated with the key.
- NAXIS
  
  public static final Standard NAXIS
  
  The value field shall contain a non-negative integer no greater than 999, representing the number of axes in the associated data array. A value of zero signifies that no data follow the key in the HDU. In the context of FITS 'TABLE' or 'BINTABLE' extensions, the value of NAXIS is always 2.RANGE: [0:999]
- NAXISn
  
  public static final Standard NAXISn
  
  The value field of this indexed keyword shall contain a non-negative integer, representing the number of elements along axis n of a data array. The NAXISn must be present for all values n = 1,...,NAXIS, and for no other values of n. A value of zero for any of the NAXISn signifies that no data follow the key in the HDU. If NAXIS is equal to 0, there should not be any NAXISn keywords.RANGE: [0:]
- OBJECT
  
  public static final Standard OBJECT
  
  The value field shall contain a character string giving a name for the object observed.
- OBSERVER
  
  public static final Standard OBSERVER
  
  The value field shall contain a character string identifying who acquired the data associated with the key.
- ORIGIN
  
  public static final Standard ORIGIN
  
  The value field shall contain a character string identifying the organization or institution responsible for creating the FITS file.
- PCOUNT
  
  public static final Standard PCOUNT
  
  The value field shall contain an integer that shall be used in any way appropriate to define the data structure, consistent with Eq. 5.2 in the FITS Standard. This keyword was originated for use with FITS Random Groups and represented the number of parameters preceding each group. It has since been used in 'BINTABLE' extensions to represent the size of the data heap following the main data table. In most other cases its value will be zero.
- PSCALn
  
  public static final Standard PSCALn
  
  This keyword is reserved for use within the FITS Random Groups structure. This keyword shall be used, along with the PZEROn keyword, when the nth FITS group parameter value is not the true physical value, to transform the group parameter value to the true physical values it represents, using the equation, physical_value = PZEROn + PSCALn * group_parameter_value. The value field shall contain a floating point number representing the coefficient of the linear term, the scaling factor between true values and group parameter values at zero offset. The default value for this keyword is 1.0.
- PTYPEn
  
  public static final Standard PTYPEn
  
  This keyword is reserved for use within the FITS Random Groups structure. The value field shall contain a character string giving the name of parameter n. If the PTYPEn keywords for more than one value of n have the same associated name in the value field, then the data value for the parameter of that name is to be obtained by adding the derived data values of the corresponding parameters. This rule provides a mechanism by which a random parameter may have more precision than the accompanying data array elements; for example, by summing two 16-bit values with the first scaled relative to the other such that the sum forms a number of up to 32-bit precision.
- PZEROn
  
  public static final Standard PZEROn
  
  This keyword is reserved for use within the FITS Random Groups structure. This keyword shall be used, along with the PSCALn keyword, when the nth FITS group parameter value is not the true physical value, to transform the group parameter value to the physical value. The value field shall contain a floating point number, representing the true value corresponding to a group parameter value of zero. The default value for this keyword is 0.0. The transformation equation is as follows: physical_value = PZEROn + PSCALn * group_parameter_value.DEFAULT: 0.0
- RADESYS
  
  public static final Standard RADESYS
  
  Coordinate reference frame of major/minor axes.If absent the default value is 'FK5'. This version of the keyword does not support alternative coordinate systems.
  See Also:
  
  WCS.RADESYSa
- RADECSYS
  
  public static final Standard RADECSYS
  
  Deprecated.
  Deprecated in the current FITS satndard, use RADESYS instead.
  
  Coordinate reference frame of major/minor axes (generic).
- RESTFRQ
  
  public static final Standard RESTFRQ
  
  [Hz] Rest frequency of observed spectral line.
  Since:
  
  1.19
  
  See Also:
  
  WCS.RESTFRQa
- RESTFREQ
  
  public static final Standard RESTFREQ
  
  Deprecated.
  Deprecated in the current FITS standard, use RESTFRQ instead.
  
  [Hz] Rest frequeny of observed spectral line (generic).
- REFERENC
  
  public static final Standard REFERENC
  
  The value field shall contain a character string citing a reference where the data associated with the key are published.
- SIMPLE
  
  public static final Standard SIMPLE
  
  The SIMPLE keyword is required to be the first keyword in the primary key of all FITS files. The value field shall contain a logical constant with the value T if the file conforms to the standard. This keyword is mandatory for the primary key and is not permitted in extension headers. A value of F signifies that the file does not conform to this standard.
- TBCOLn
  
  public static final Standard TBCOLn
  
  The value field of this indexed keyword shall contain an integer specifying the column in which field n starts in an ASCII TABLE extension. The first column of a row is numbered 1.RANGE: [1:]
- TDIMn
  
  public static final Standard TDIMn
  
  The value field of this indexed keyword shall contain a character string describing how to interpret the contents of field n as a multidimensional array, providing the number of dimensions and the length along each axis. The form of the value is not further specified by the Standard. A proposed convention is described in Appendix B.2 of the FITS Standard in which the value string has the format '(l,m,n...)' where l, m, n,... are the dimensions of the array.
- TDISPn
  
  public static final Standard TDISPn
  
  The value field of this indexed keyword shall contain a character string describing the format recommended for the display of the contents of field n. If the table value has been scaled, the physical value shall be displayed. All elements in a field shall be displayed with a single, repeated format. For purposes of display, each byte of bit (type X) and byte (type B) arrays is treated as an unsigned integer. Arrays of type A may be terminated with a zero byte. Only the format codes in Table 8.6, discussed in section 8.3.4 of the FITS Standard, are permitted for encoding. The format codes must be specified in upper case. If the Bw.m, Ow.m, and Zw.m formats are not readily available to the reader, the Iw.m display format may be used instead, and if the ENw.d and ESw.d formats are not available, Ew.d may be used. The meaning of this keyword is not defined for fields of type P in the Standard but may be defined in conventions using such fields.
- TELESCOP
  
  public static final Standard TELESCOP
  
  The value field shall contain a character string identifying the telescope used to acquire the data associated with the key.
- TFIELDS
  
  public static final Standard TFIELDS
  
  The value field shall contain a non-negative integer representing the number of fields in each row of a 'TABLE' or 'BINTABLE' extension. The maximum permissible value is 999. RANGE: [0:999]
- TFORMn
  
  public static final Standard TFORMn
  
  The value field of this indexed keyword shall contain a character string describing the format in which field n is encoded in a 'TABLE' or 'BINTABLE' extension.
- THEAP
  
  public static final Standard THEAP
  
  The value field of this keyword shall contain an integer providing the separation, in bytes, between the start of the main data table and the start of a supplemental data area called the heap. The default value shall be the product of the values of NAXIS1 and NAXIS2. This keyword shall not be used if the value of PCOUNT is zero. A proposed application of this keyword is presented in Appendix B.1 of the FITS Standard.
- TNULLn
  
  public static final Standard TNULLn
  
  In ASCII 'TABLE' extensions, the value field for this indexed keyword shall contain the character string that represents an undefined value for field n. The string is implicitly blank filled to the width of the field. In binary 'BINTABLE' table extensions, the value field for this indexed keyword shall contain the integer that represents an undefined value for field n of data type B, I, or J. The keyword may not be used in 'BINTABLE' extensions if field n is of any other data type.
- TSCALn
  
  public static final Standard TSCALn
  
  This indexed keyword shall be used, along with the TZEROn keyword, when the quantity in field n does not represent a true physical quantity. The value field shall contain a floating point number representing the coefficient of the linear term in the equation, physical_value = TZEROn + TSCALn * field_value, which must be used to compute the true physical value of the field, or, in the case of the complex data types C and M, of the real part of the field with the imaginary part of the scaling factor set to zero. The default value for this keyword is 1.0. This keyword may not be used if the format of field n is A, L, or X.DEFAULT: 1.0
- TTYPEn
  
  public static final Standard TTYPEn
  
  The value field for this indexed keyword shall contain a character string, giving the name of field n. It is recommended that only letters, digits, and underscore (hexadecimal code 5F, ('_') be used in the name. String comparisons with the values of TTYPEn keywords should not be case sensitive. The use of identical names for different fields should be avoided.
- TUNITn
  
  public static final Standard TUNITn
  
  The value field shall contain a character string describing the physical units in which the quantity in field n, after any application of TSCALn and TZEROn, is expressed. The units of all FITS key keyword values, with the exception of measurements of angles, should conform with the recommendations in the IAU Style Manual. For angular measurements given as floating point values and specified with reserved keywords, degrees are the recommended units (with the units, if specified, given as 'deg').
- TZEROn
  
  public static final Standard TZEROn
  
  This indexed keyword shall be used, along with the TSCALn keyword, when the quantity in field n does not represent a true physical quantity. The value field shall contain a floating point number representing the true physical value corresponding to a value of zero in field n of the FITS file, or, in the case of the complex data types C and M, in the real part of the field, with the imaginary part set to zero. The default value for this keyword is 0.0. This keyword may not be used if the format of field n is A, L, or X.DEFAULT: 0.0
- TDMAXn
  
  public static final Standard TDMAXn
  
  The value field of this indexed keyword shall contain a floating point number specifying the maximum valid physical value represented in column n of the table, exclusive of any special values. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions and is analogous to the DATAMAX keyword used for FITS images.
  
  Since:
  
  1.19
- TDMINn
  
  public static final Standard TDMINn
  
  The value field of this indexed keyword shall contain a floating point number specifying the minimum valid physical value represented in column n of the table, exclusive of any special values. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions and is analogous to the DATAMIN keyword used for FITS images.
  
  Since:
  
  1.19
- TLMAXn
  
  public static final Standard TLMAXn
  
  The value field of this indexed keyword shall contain a floating point number specifying the upper bound of the legal range of physical values that may be represented in column n of the table. The column may contain values that are greater than this legal maximum value but the interpretation of such values is not defined here. The value of this keyword is typically used as the maxinum value when constructing a histogram of the values in the column. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions.
  
  Since:
  
  1.19
- TLMINn
  
  public static final Standard TLMINn
  
  The value field of this indexed keyword shall contain a floating point number specifying the lower bound of the legal range of physical values that may be represented in column n of the table. The column may contain values that are less than this legal minimum value but the interpretation of such values is not defined here. The value of this keyword is typically used as the mininum value when constructing a histogram of the values in the column. This keyword may only be used in 'TABLE' or 'BINTABLE' extensions.
  
  Since:
  
  1.19
- XTENSION
  
  public static final Standard XTENSION
  
  The value field shall contain a character string giving the name of the extension type. This keyword is mandatory for an extension key and must not appear in the primary key. For an extension that is not a standard extension, the type name must not be the same as that of a standard extension.
- INHERIT
  
  public static final Standard INHERIT
  
  If set to true, it indicates that the HDU should inherit all non-confliucting keywords from the primary HDU.
  
  Since:
  
  1.19
Field Details
- NAXIS1
  
  public static final IFitsHeader NAXIS1
  
  A shorthand for NAXISn.n(1), that is the regular dimension along the first, fastest FITS array index (this is the same as the last dimension of Java arrays).
- NAXIS2
  
  public static final IFitsHeader NAXIS2
  
  A shorthand for NAXISn.n(2), that is the regular dimension along the second fastest FITS array index (this is the same as the one before the last dimension of Java arrays).
- XTENSION_ASCIITABLE
  
  public static final String XTENSION_ASCIITABLE
  
  The value of the XTENSION keword in case of a binary table.
  See Also:
  
  Constant Field Values
- XTENSION_BINTABLE
  
  public static final String XTENSION_BINTABLE
  
  The value of the XTENSION keword in case of a binary table.
  See Also:
  
  Constant Field Values
- XTENSION_IMAGE
  
  public static final String XTENSION_IMAGE
  
  The value of the XTENSION keword in case of an image.
  See Also:
  
  Constant Field Values
Method Details
- values
  
  public static Standard[] 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 Standard 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.
- comment
  
  public String comment()
  
  Description copied from interface: IFitsHeader
  
  Returns the comment associated to this FITS header entry. The comment is entirely optional, and it may not be appear in full (or at all) in the FITS header. Comments should thus never contain essential information. Their purpose is only to provide non-essential extra information for human use.
  Specified by:
  
  comment in interface IFitsHeader
  
  Returns:
  
  the associated standard comment.
  
  See Also:
  
  HeaderCard.getComment()
  
  HeaderCard.setComment(String)
- context
  
  public static void context(Class<?> clazz)
  
  Deprecated.
  (for internal use) Using HeaderCard.setComment(String) after creating a header card with this keyword provides a more transparent way of setting context-specific comments. This convoluted approach is no longer supported and will be removed in the future.
  Parameters:
  
  clazz - Usually a subclass of nom.tam.fits.Data.
  
  See Also:
  
  HeaderCard.setComment(String)
- getCommentByKey
  
  public String getCommentByKey(String commentKey)
  
  Deprecated.
  ()for internal use)
  
  scan for a comment with the specified reference key.
  
  Parameters:
  
  commentKey - the reference key
  
  Returns:
  
  the comment for the reference key
- setCommentByKey
  
  public void setCommentByKey(String commentKey, String value)
  
  Deprecated.
  ()for internal use)
  
  set the comment for the specified reference key.
  
  Parameters:
  
  commentKey - the reference key
  
  value - the comment to set when the fits key is used.
- match
  
  public static IFitsHeader match(String key)
  
  Returns the standard FITS keyword that matches the specified actual key.
  Parameters:
  
  key - The key as it may appear in a FITS header, e.g. "CTYPE1A"
  
  Returns:
  
  The standard FITS keyword/pattern that matches, e.g. WCS.CTYPEna.
  
  Since:
  
  1.19
  
  See Also:
  
  IFitsHeader.extractIndices(String)

Enum Standard

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

AUTHOR

BITPIX

BLANK

BLANKS

BLOCKED

BSCALE

BUNIT

BZERO

CDELTn

COMMENT

CONTINUE

CROTAn

CRPIXn

CRVALn

CTYPEn

DATAMAX

DATAMIN

DATE

DATE_OBS

END

EPOCH

EQUINOX

EXTEND

EXTLEVEL

EXTNAME

EXTVER

GCOUNT

GROUPS

HISTORY

INSTRUME

NAXIS

NAXISn

OBJECT

OBSERVER

ORIGIN

PCOUNT

PSCALn

PTYPEn

PZEROn

RADESYS

RADECSYS

RESTFRQ

RESTFREQ

REFERENC

SIMPLE

TBCOLn

TDIMn

TDISPn

TELESCOP

TFIELDS

TFORMn

THEAP

TNULLn

TSCALn

TTYPEn

TUNITn

TZEROn

TDMAXn

TDMINn

TLMAXn

TLMINn

XTENSION

INHERIT

Field Details

NAXIS1

NAXIS2

XTENSION_ASCIITABLE

XTENSION_BINTABLE