Enum WCS

java.lang.Object

java.lang.Enum<WCS>

nom.tam.fits.header.WCS

All Implemented Interfaces:

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

public enum WCS
extends Enum<WCS>
implements IFitsHeader

Standard FITS keywords for defining world coordinate systems (WCS). Many (but not all) keywords listed here support alternative coordinate systems. These have a lower case 'a' at the end of their enum names, e.g. WCSNAMEa. The alternative coordinate system for these can be set via the alt(char) method.

Since:

1.19

Author:

Attila Kovacs

See Also:

• DateTime

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Nested classes/interfaces inherited from interface IFitsHeader

IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE

Modifier and Type	Interface	Description
static enum	IFitsHeader.HDU	An enumeration of HDU types in which a header keyword may be used.
static enum	IFitsHeader.SOURCE	Documentation sources for the various known conventions.
static enum	IFitsHeader.VALUE	Values types to which implementing keywords can be restricted to.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CDELTna	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.
CNAMEna	Coordinate axis name.
CPERIna	Phase axis period
CRDERna	Random coordinate error on axis n in the physical coordinate unit (if defined).
CRPIXna	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.
CRVALna	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.
CSYERna	Systematic coordinate error on axis n in the physical coordinate unit (if defined).
CTYPEna	The value field shall contain a character string, giving the name of the coordinate represented by axis n.
CZPHSna	Phase axis zero point
EPOCH	Deprecated. Deprecated in the current FITS standard, use EQUINOXa instead.
EQUIna	[yr] Coordinate epoch for which the celestial coorinate system is defined for the given column index.
EQUINOXa	The value field shall contain a floating point number giving the equinox in years for the celestial coordinate system in which positions are expressed.
LATPna	[deg] The latitude of the celestial pole for the entries in the given column index (for spherical coordinates).
LATPOLEa	[deg] The latitude of the celestial pole (for spherical coordinates).
LONPna	[deg] The longitude of the celestial pole for the entries in the given column index (for spherical coordinates).
LONPOLEa	[deg] The longitude of the celestial pole (for spherical coordinates).
nCDEna	The coordinate axis spacing in the physical unit of the axis (if defined) for array entries in this column (trailing index).
nCDLTn	The coordinate axis spacing in the physical unit of the axis (if defined) for array entries in this column (trailing index).
nCNAna	The coordinate axis name for array entries in this column (trailing index).
nCPRna	Phase axis period on axis (leading index) for array entries in this column (trailing index)
nCRDna	The coordinate axis random error in the physical unit of the axis (if defined) for array entries in this column (trailing index).
nCROTn	Deprecated. The FITS standard deprecated this keyword.
nCRPna	The 1-based coordinate reference pixel index in the physical unit of the axis (if defined) for array entries in this column (trailing index).
nCRPXn	The 1-based coordinate reference pixel index in the physical unit of the axis (if defined) for array entries in this column (trailing index).
nCRVLn	The coordinate reference value in the physical unit of the axis (if defined) for array entries in this column (trailing index).
nCRVna	The coordinate reference value in the physical unit of the axis (if defined) for array entries in this column (trailing index).
nCSYna	The coordinate axis systematic error in the physical unit of the axis (if defined) for array entries in this column (trailing index).
nCTYna	The coordinate axis type for array entries in this column (trailing index).
nCTYPn	The coordinate axis type for array entries in this column (trailing index).
nCUNIn	The physical coordinate unit for array entries in this column (trailing index).
nCUNna	The physical coordinate unit for array entries in this column (trailing index).
nCZPna	Phase axis zero point on axis (leading index) for array entries in this column (trailing index)
nnCDna	Coordinate transformation matrix in the CD convention. from rectilinear coordinate index i (leading index) to coordinate index j (second index) for the for array entries in this column (trailing index).
nnPCna	Coordinate transformation matrix in the PC convention. from rectilinear coordinate index i (leading index) to coordinate index j (second index) for the for array entries in this column (trailing index).
nPSn_na	The coordinate string parameter m (trailing index) for axis i (leading index) for array entries in this column (middle index).
nPVn_na	The coordinate parameter value m (trailing index) for axis i (leading index) for array entries in this column (middle index).
nSn_na	The coordinate string parameter m (trailing index) for axis i (leading index) for array entries in this column (middle index).
nVn_na	The coordinate parameter value m (trailing index) for axis i (leading index) for array entries in this column (middle index).
nVn_Xa	The coordinate parameter array for axis i (leading index) in this column (middle index).
OBSGEO_X	[m] Geodetic location of observer (x coordinate).
OBSGEO_Y	[m] Geodetic location of observer (y coordinate).
OBSGEO_Z	[m] Geodetic location of observer (z coordinate).
OBSGXn	[m] Geodetic location (x coordinate) of observer for he given column index.
OBSGYn	[m] Geodetic location (y coordinate) of observer for he given column index.
OBSGZn	[m] Geodetic location (z coordinate) of observer for he given column index.
RADECSYS	Deprecated. Deprecated in the current FITS standard, use RADESYSa instead.
RADEna	The equatorial coordinate frame used for the given column index, e.g.
RADESYSa	Coordinate reference frame of major/minor axes.If absent the default value is 'FK5'.
RESTFREQ	Deprecated. Deprecated in the current FITS standard, use RESTFRQa instead.
RESTFRQa	[Hz] Rest frequency of observed spectral line.
RESTWAVa	[m] Rest wavelength of observed spectral line in image.
RFRQna	[Hz] The rest frequency of the line in the given column index.
RWAVna	[Hz] The rest wavelength of the line in the given column index.
SOBSna	Spectral reference system of observer for the given column index.
SPECna	Spectral reference frame for the given column index.
SPECSYSa	Image spectral reference system name.
SSRCna	Spectral reference system of source for the given column index.
SSYSOBSa	Image spectral reference system name of observer.
SSYSSRCa	Spectral reference system name of source.
TCDEna	The coordinate axis spacing in the physical unit of the axis (if defined) for the (1D_) pixel lists in this column (trailing index).
TCDLTn	The coordinate axis spacing in the physical unit of the axis (if defined) for the (1D_) pixel lists in this column (trailing index).
TCDn_na	Coordinate transformation matrix in the CD convention. from column index n (leading index) to column index k (second index) for the for the (1D) pixel lists in this column.
TCn_na	Coordinate transformation matrix in the CD convention. from column index n (leading index) to column index k (second index) for the for the (1D) pixel lists in this column.
TCNAna	The coordinate axis name for (1D) pixel lists in this column (trailing index).
TCPRna	Phase axis period on axis (leading index) for array entries in this column (trailing index)
TCRDna	The coordinate axis random error in the physical unit of the axis (if defined) for the (1D_) pixel lists in this column (trailing index).
TCROTn	Deprecated. The FITS standard deprecated this keyword.
TCRPna	The 1-based coordinate reference pixel index in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index).
TCRPXn	The 1-based coordinate reference pixel index in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index).
TCRVLn	The coordinate reference value in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index).
TCRVna	The coordinate reference value in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index).
TCSYna	The coordinate axis systematics error in the physical unit of the axis (if defined) for the (1D_) pixel lists in this column (trailing index).
TCTYna	The coordinate axis type for (1D) pixel lists in this column (trailing index).
TCTYPn	The coordinate axis type for (1D) pixel lists in this column (trailing index).
TCUNIn	The physical coordinate unit for (1D) pixel lists in this column (trailing index).
TCUNna	The physical coordinate unit for (1D) pixel lists in this column (trailing index).
TCZPna	Phase axis zero point on axis (leading index) for array entries in this column (trailing index)
TPCn_na	Coordinate transformation matrix in the PC convention. from column index n (leading index) to column index k (second index) for the for the (1D) pixel lists in this column.
TPn_na	Coordinate transformation matrix in the PC convention. from column index n (leading index) to column index k (second index) for the for the (1D) pixel lists in this column.
TPSn_na	The coordinate string parameter m (trailing index) for the (1D) pixel list entries in this column (leading index).
TPVn_na	The coordinate parameter value m (trailing index) for the (1D) pixel list entries in this column (leading index).
TSn_na	The coordinate string parameter m (trailing index) for the (1D) pixel list entries in this column (leading index).
TVn_na	The coordinate parameter value m (trailing index) for the (1D) pixel list entries in this column (leading index).
TWCSna	WCS name for the pixe list entries in the given column index.
VANGna	[deg] Angle of true velocity for the given column index.
VELANGLa	[deg] True velocity angle of source
VELOSYSa	[m/s] Radial velocity of source in the spectral reference frame.
VSYSna	[m/s] Source radial velocity for the given column index.
WCAXna	WCS dimensions for given column index.
WCSAXESa	Dimensionality of image coordinate system
WCSna	WCS name for the pixe list entries in the given column index.
WCSNAMEa	World coordinate system name
WCSNna	WCS name for the array entries in the given column index.
ZSOUna	Source redshift value for the given column index.
ZSOURCEa	Redshift value of source in the spectral reference frame.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALGO_GRA	Detector sampling algorithm code for CTYPEna keywords
static final String	ALGO_GRI	Detector sampling algorithm code for CTYPEna keywords
static final String	ALGO_LOG	Logarithmically sampled algorithm code for CTYPEna keywords
static final String	ALGO_TAB	Irregular sampling algorithm code for CTYPEna keywords
static final String	RADESYS_FK4	Bessel-Newcomb FK4 coordinate reference frame
static final String	RADESYS_FK4_NO_E	Bessel-Newcomb FK4 coordinate reference frame, without eccentricity terms
static final String	RADESYS_FK5	IAU 1984 FK5 coordinate reference frame
static final String	RADESYS_GAPPT	Geocentric apparent place (IAU 1984)
static final String	RADESYS_ICRS	ICRS coordinate reference frame
static final String	SPECTRAL_ALGO_A2F	Spectral air wavelength expressed as frequency transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_A2V	Spectral air wavelength expressed as apparent radial velocity transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_A2W	Spectral air wavelength expressed as vacuum wavelength transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_F2A	Spectral frequency expressed as air wavelength transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_F2V	Spectral frequency expressed as apparent radial velocity transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_F2W	Spectral frequency expressed as wavelength transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_V2A	Spectral radial velocity expressed as air wavelength transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_V2F	Spectral radial velocity expressed as frequency transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_V2W	Spectral radial velocity expressed as wavelength transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_W2A	Spectral wavelength expressed as air wavelength transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_W2F	Spectral wavelength expressed as frequency transformation code for CTYPEna keywords
static final String	SPECTRAL_ALGO_W2V	Spectral wavelength expressed as apparent radial velocity transformation code for CTYPEna keywords
static final String	SPECTRAL_TYPE_AWAV	Spectral wavelength in air coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_BETA	Spectral beta factor (v/c) coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_ENER	Spectral energy coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_FREQ	Spectral frequency coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_VELO	Spectral apparent radial velocity coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_VOPT	Spectral optical velocity coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_VRAD	Spectral radial velocity coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_WAVE	Spectral vacuum wavenlength coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_WAVN	Spectral wavenumber coordinate value for CTYPEna keywords
static final String	SPECTRAL_TYPE_ZOPT	Spectral redshift coordinate value for CTYPEna keywords
static final int	WCSAXES_MAX_VALUE	ICRS coordinate reference frame

Fields inherited from interface IFitsHeader

MAX_INDEX

Modifier and Type	Field	Description
static final int	MAX_INDEX	Max numeric index we may use to replace n in the Java name of indexed variables.

Method Summary

Modifier and Type	Method	Description
IFitsHeader	alt(char c)	Specifying an alternative coordinate system.
final FitsKey	impl()	(primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
static WCS	valueOf(String name)	Returns the enum constant of this type with the specified name.
static WCS[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IFitsHeader

comment, extractIndices, hdu, key, n, status, valueType

Modifier and Type	Method	Description
default String	comment()	Returns the comment associated to this FITS header entry.
default int[]	extractIndices(String key)	Extracts the indices for this stndardized key from an actual keyword realization.
default IFitsHeader.HDU	hdu()	Returns the type of HDU(s) in which this header entry may be used.
default String	key()	Returns the FITS header keyword (or keyword template) for this header entry.
default IFitsHeader	n(int... numbers)	Constructs an indexed FITS header keyword entry from this stem, replacing index place-holders (indicated by lower-case 'n' in the name) with actual numerical values.
default IFitsHeader.SOURCE	status()	Returns the standard convention, which defines this FITS header entry
default IFitsHeader.VALUE	valueType()	The type(s) of value(s) this FITS header entry might take.

Enum Constant Details

WCSNAMEa

public static final WCS WCSNAMEa

World coordinate system name

Since:

1.19

WCSAXESa

public static final WCS WCSAXESa

Dimensionality of image coordinate system

Since:

1.19

RADESYSa

public static final WCS RADESYSa

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

Since:

1.19

RADECSYS

@Deprecated
public static final WCS RADECSYS

Deprecated.

Deprecated in the current FITS standard, use RADESYSa instead.

Coordinate reference frame of major/minor axes (generic).

LONPOLEa

public static final WCS LONPOLEa

[deg] The longitude of the celestial pole (for spherical coordinates).

Since:

1.19

LATPOLEa

public static final WCS LATPOLEa

[deg] The latitude of the celestial pole (for spherical coordinates).

Since:

1.19

EPOCH

@Deprecated
public static final WCS EPOCH

Deprecated.

Deprecated in the current FITS standard, use EQUINOXa instead.

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.

EQUINOXa

public static final WCS EQUINOXa

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

Since:

1.19

CNAMEna

public static final WCS CNAMEna

Coordinate axis name.

Since:

1.19

CRPIXna

public static final WCS CRPIXna

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.

Since:

1.19

CRVALna

public static final WCS CRVALna

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.

Since:

1.19

CTYPEna

public static final WCS CTYPEna

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

Since:

1.19

CDELTna

public static final WCS CDELTna

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.

Since:

1.19

CRDERna

public static final WCS CRDERna

Random coordinate error on axis n in the physical coordinate unit (if defined).

Since:

1.19

CSYERna

public static final WCS CSYERna

Systematic coordinate error on axis n in the physical coordinate unit (if defined).

Since:

1.19

CZPHSna

public static final WCS CZPHSna

Phase axis zero point

Since:

1.19

CPERIna

public static final WCS CPERIna

Phase axis period

RESTFRQa

public static final WCS RESTFRQa

[Hz] Rest frequency of observed spectral line.

Since:

1.19

RESTFREQ

@Deprecated
public static final WCS RESTFREQ

Deprecated.

Deprecated in the current FITS standard, use RESTFRQa instead.

[Hz] Rest frequeny of observed spectral line (generic).

RESTWAVa

public static final WCS RESTWAVa

[m] Rest wavelength of observed spectral line in image.

Since:

1.19

SPECSYSa

public static final WCS SPECSYSa

Image spectral reference system name.

Since:

1.19

SSYSOBSa

public static final WCS SSYSOBSa

Image spectral reference system name of observer.

Since:

1.19

SSYSSRCa

public static final WCS SSYSSRCa

Spectral reference system name of source.

Since:

1.19

VELOSYSa

public static final WCS VELOSYSa

[m/s] Radial velocity of source in the spectral reference frame.

Since:

1.19

ZSOURCEa

public static final WCS ZSOURCEa

Redshift value of source in the spectral reference frame.

Since:

1.19

VELANGLa

public static final WCS VELANGLa

[deg] True velocity angle of source

Since:

1.19

OBSGEO_X

public static final WCS OBSGEO_X

[m] Geodetic location of observer (x coordinate).

Since:

1.19

OBSGEO_Y

public static final WCS OBSGEO_Y

[m] Geodetic location of observer (y coordinate).

Since:

1.19

OBSGEO_Z

public static final WCS OBSGEO_Z

[m] Geodetic location of observer (z coordinate).

Since:

1.19

WCSNna

public static final WCS WCSNna

WCS name for the array entries in the given column index.

Since:

1.19

LONPna

public static final WCS LONPna

[deg] The longitude of the celestial pole for the entries in the given column index (for spherical coordinates).

Since:

1.19

LATPna

public static final WCS LATPna

[deg] The latitude of the celestial pole for the entries in the given column index (for spherical coordinates).

Since:

1.19

EQUIna

public static final WCS EQUIna

[yr] Coordinate epoch for which the celestial coorinate system is defined for the given column index.

Since:

1.19

RADEna

public static final WCS RADEna

The equatorial coordinate frame used for the given column index, e.g. 'FK4', 'FK5', or 'ICRS'.

Since:

1.19

RFRQna

public static final WCS RFRQna

[Hz] The rest frequency of the line in the given column index.

Since:

1.19

RWAVna

public static final WCS RWAVna

[Hz] The rest wavelength of the line in the given column index.

Since:

1.19

SPECna

public static final WCS SPECna

Spectral reference frame for the given column index.

Since:

1.19

SOBSna

public static final WCS SOBSna

Spectral reference system of observer for the given column index.

Since:

1.19

SSRCna

public static final WCS SSRCna

Spectral reference system of source for the given column index.

Since:

1.19

VSYSna

public static final WCS VSYSna

[m/s] Source radial velocity for the given column index.

Since:

1.19

VANGna

public static final WCS VANGna

[deg] Angle of true velocity for the given column index.

Since:

1.19

ZSOUna

public static final WCS ZSOUna

Source redshift value for the given column index.

Since:

1.19

OBSGXn

public static final WCS OBSGXn

[m] Geodetic location (x coordinate) of observer for he given column index.

Since:

1.19

OBSGYn

public static final WCS OBSGYn

[m] Geodetic location (y coordinate) of observer for he given column index.

Since:

1.19

OBSGZn

public static final WCS OBSGZn

[m] Geodetic location (z coordinate) of observer for he given column index.

Since:

1.19

nCTYPn

public static final WCS nCTYPn

The coordinate axis type for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• nCTYna

nCTYna

public static final WCS nCTYna

The coordinate axis type for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version supports alternative coordinates systems.

Since:

1.19

See Also:

• nCTYPn

nCNAna

public static final WCS nCNAna

The coordinate axis name for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column.

Since:

1.19

nCUNIn

public static final WCS nCUNIn

The physical coordinate unit for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• nCUNna

nCUNna

public static final WCS nCUNna

The physical coordinate unit for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version supports alternative coordinates systems.

Since:

1.19

See Also:

• nCUNIn

nCRVLn

public static final WCS nCRVLn

The coordinate reference value in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• nCRVna

nCRVna

public static final WCS nCRVna

The coordinate reference value in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version supports alternative coordinates systems.

Since:

1.19

See Also:

• nCRVLn

nCRDna

public static final WCS nCRDna

The coordinate axis random error in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column.

Since:

1.19

nCSYna

public static final WCS nCSYna

The coordinate axis systematic error in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column.

Since:

1.19

nCZPna

public static final WCS nCZPna

Phase axis zero point on axis (leading index) for array entries in this column (trailing index)

Since:

1.19

nCPRna

public static final WCS nCPRna

Phase axis period on axis (leading index) for array entries in this column (trailing index)

Since:

1.19

nCDLTn

public static final WCS nCDLTn

The coordinate axis spacing in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• nCDEna

nCDEna

public static final WCS nCDEna

The coordinate axis spacing in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version supports alternative coordinates systems.

Since:

1.19

See Also:

• nCDLTn

nCRPXn

public static final WCS nCRPXn

The 1-based coordinate reference pixel index in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• nCRPna

nCRPna

public static final WCS nCRPna

The 1-based coordinate reference pixel index in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. This version supports alternative coordinates systems.

Since:

1.19

See Also:

• nCRPXn

nCROTn

@Deprecated
public static final WCS nCROTn

Deprecated.

The FITS standard deprecated this keyword. Use nnPCna and nnCDnainstead. [deg] The coordinate axis rotation in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column.

Since:

1.19

nnPCna

public static final WCS nnPCna

Coordinate transformation matrix in the PC convention. from rectilinear coordinate index i (leading index) to coordinate index j (second index) for the for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column.

Since:

1.19

nnCDna

public static final WCS nnCDna

Coordinate transformation matrix in the CD convention. from rectilinear coordinate index i (leading index) to coordinate index j (second index) for the for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column.

Since:

1.19

nPSn_na

public static final WCS nPSn_na

The coordinate string parameter m (trailing index) for axis i (leading index) for array entries in this column (middle index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. The shorter nSn_na form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

nSn_na

public static final WCS nSn_na

The coordinate string parameter m (trailing index) for axis i (leading index) for array entries in this column (middle index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. Same as nPSn_na. This shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

nPVn_na

public static final WCS nPVn_na

The coordinate parameter value m (trailing index) for axis i (leading index) for array entries in this column (middle index). The number of coordinateaxes defined this way should match the dimensionality of the array elements in the column. The shorter nVn_na form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

nVn_na

public static final WCS nVn_na

The coordinate parameter value m (trailing index) for axis i (leading index) for array entries in this column (middle index). The number of coordinateaxes defined this way should match the dimensionality of the array elements in the column. Same as nPVn_na. This shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

nVn_Xa

public static final WCS nVn_Xa

The coordinate parameter array for axis i (leading index) in this column (middle index). The number of coordinate axes defined this way should match the dimensionality of the array elements in the column.

Since:

1.19

WCSna

public static final WCS WCSna

WCS name for the pixe list entries in the given column index. Same as TWCSna. This shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TWCSna

public static final WCS TWCSna

WCS name for the pixe list entries in the given column index. The shorter form WCSna may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

WCAXna

public static final WCS WCAXna

WCS dimensions for given column index.

Since:

1.19

TCTYPn

public static final WCS TCTYPn

The coordinate axis type for (1D) pixel lists in this column (trailing index). This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• TCTYna

TCTYna

public static final WCS TCTYna

The coordinate axis type for (1D) pixel lists in this column (trailing index). This version supports alternative coordinates systems.

Since:

1.19

See Also:

• TCTYPn

TCNAna

public static final WCS TCNAna

The coordinate axis name for (1D) pixel lists in this column (trailing index).

Since:

1.19

TCUNIn

public static final WCS TCUNIn

The physical coordinate unit for (1D) pixel lists in this column (trailing index). This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• TCUNna

TCUNna

public static final WCS TCUNna

The physical coordinate unit for (1D) pixel lists in this column (trailing index). This version supports alternative coordinates systems.

Since:

1.19

See Also:

• TCUNIn

TCRVLn

public static final WCS TCRVLn

The coordinate reference value in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index). This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• TCRVna

TCRVna

public static final WCS TCRVna

The coordinate reference value in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index). This version supports alternative coordinates systems.

Since:

1.19

See Also:

• TCRVLn

TCDLTn

public static final WCS TCDLTn

The coordinate axis spacing in the physical unit of the axis (if defined) for the (1D_) pixel lists in this column (trailing index). This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• TCDEna

TCDEna

public static final WCS TCDEna

The coordinate axis spacing in the physical unit of the axis (if defined) for the (1D_) pixel lists in this column (trailing index). This version supports alternative coordinates systems.

Since:

1.19

See Also:

• TCDLTn

TCRDna

public static final WCS TCRDna

The coordinate axis random error in the physical unit of the axis (if defined) for the (1D_) pixel lists in this column (trailing index).

Since:

1.19

TCSYna

public static final WCS TCSYna

The coordinate axis systematics error in the physical unit of the axis (if defined) for the (1D_) pixel lists in this column (trailing index).

Since:

1.19

TCZPna

public static final WCS TCZPna

Phase axis zero point on axis (leading index) for array entries in this column (trailing index)

Since:

1.19

TCPRna

public static final WCS TCPRna

Phase axis period on axis (leading index) for array entries in this column (trailing index)

Since:

1.19

TCRPXn

public static final WCS TCRPXn

The 1-based coordinate reference pixel index in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index). This version does not support alternative coordinates systems.

Since:

1.19

See Also:

• TCRPna

TCRPna

public static final WCS TCRPna

The 1-based coordinate reference pixel index in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index). This version supports alternative coordinates systems.

Since:

1.19

See Also:

• TCRPXn

TPCn_na

public static final WCS TPCn_na

Coordinate transformation matrix in the PC convention. from column index n (leading index) to column index k (second index) for the for the (1D) pixel lists in this column. The shorter form TPn_na may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

See Also:

• TPn_na

TPn_na

public static final WCS TPn_na

Coordinate transformation matrix in the PC convention. from column index n (leading index) to column index k (second index) for the for the (1D) pixel lists in this column. Same as TPCn_na. This shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

See Also:

• TPCn_na

TCROTn

@Deprecated
public static final WCS TCROTn

Deprecated.

The FITS standard deprecated this keyword. Use TPCn_na and TCDn_nainstead. [deg] The coordinate axis rotation in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index).

Since:

1.19

TCDn_na

public static final WCS TCDn_na

Coordinate transformation matrix in the CD convention. from column index n (leading index) to column index k (second index) for the for the (1D) pixel lists in this column. The shorter form TCn_na may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TCn_na

public static final WCS TCn_na

Coordinate transformation matrix in the CD convention. from column index n (leading index) to column index k (second index) for the for the (1D) pixel lists in this column. Same as TCDn_na. This shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TPSn_na

public static final WCS TPSn_na

The coordinate string parameter m (trailing index) for the (1D) pixel list entries in this column (leading index). This shorter form TSn_na may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TSn_na

public static final WCS TSn_na

The coordinate string parameter m (trailing index) for the (1D) pixel list entries in this column (leading index). Same as TPSn_na. This shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TPVn_na

public static final WCS TPVn_na

The coordinate parameter value m (trailing index) for the (1D) pixel list entries in this column (leading index). The shorter form TVn_na may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TVn_na

public static final WCS TVn_na

The coordinate parameter value m (trailing index) for the (1D) pixel list entries in this column (leading index). Same as TPVn_na. This shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

Field Details

WCSAXES_MAX_VALUE

public static final int WCSAXES_MAX_VALUE

ICRS coordinate reference frame

See Also:

• Constant Field Values

RADESYS_ICRS

public static final String RADESYS_ICRS

ICRS coordinate reference frame

See Also:

• Constant Field Values

RADESYS_FK5

public static final String RADESYS_FK5

IAU 1984 FK5 coordinate reference frame

See Also:

• Constant Field Values

RADESYS_FK4

public static final String RADESYS_FK4

Bessel-Newcomb FK4 coordinate reference frame

See Also:

• Constant Field Values

RADESYS_FK4_NO_E

public static final String RADESYS_FK4_NO_E

Bessel-Newcomb FK4 coordinate reference frame, without eccentricity terms

See Also:

• Constant Field Values

RADESYS_GAPPT

public static final String RADESYS_GAPPT

Geocentric apparent place (IAU 1984)

See Also:

• Constant Field Values

ALGO_LOG

public static final String ALGO_LOG

Logarithmically sampled algorithm code for CTYPEna keywords

See Also:

• Constant Field Values

ALGO_GRI

public static final String ALGO_GRI

Detector sampling algorithm code for CTYPEna keywords

See Also:

• Constant Field Values

ALGO_GRA

public static final String ALGO_GRA

Detector sampling algorithm code for CTYPEna keywords

See Also:

• Constant Field Values

ALGO_TAB

public static final String ALGO_TAB

Irregular sampling algorithm code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_FREQ

public static final String SPECTRAL_TYPE_FREQ

Spectral frequency coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_ENER

public static final String SPECTRAL_TYPE_ENER

Spectral energy coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_WAVN

public static final String SPECTRAL_TYPE_WAVN

Spectral wavenumber coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_VRAD

public static final String SPECTRAL_TYPE_VRAD

Spectral radial velocity coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_WAVE

public static final String SPECTRAL_TYPE_WAVE

Spectral vacuum wavenlength coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_VOPT

public static final String SPECTRAL_TYPE_VOPT

Spectral optical velocity coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_ZOPT

public static final String SPECTRAL_TYPE_ZOPT

Spectral redshift coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_AWAV

public static final String SPECTRAL_TYPE_AWAV

Spectral wavelength in air coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_VELO

public static final String SPECTRAL_TYPE_VELO

Spectral apparent radial velocity coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_TYPE_BETA

public static final String SPECTRAL_TYPE_BETA

Spectral beta factor (v/c) coordinate value for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_F2W

public static final String SPECTRAL_ALGO_F2W

Spectral frequency expressed as wavelength transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_F2V

public static final String SPECTRAL_ALGO_F2V

Spectral frequency expressed as apparent radial velocity transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_F2A

public static final String SPECTRAL_ALGO_F2A

Spectral frequency expressed as air wavelength transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_W2F

public static final String SPECTRAL_ALGO_W2F

Spectral wavelength expressed as frequency transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_W2V

public static final String SPECTRAL_ALGO_W2V

Spectral wavelength expressed as apparent radial velocity transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_W2A

public static final String SPECTRAL_ALGO_W2A

Spectral wavelength expressed as air wavelength transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_V2F

public static final String SPECTRAL_ALGO_V2F

Spectral radial velocity expressed as frequency transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_V2W

public static final String SPECTRAL_ALGO_V2W

Spectral radial velocity expressed as wavelength transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_V2A

public static final String SPECTRAL_ALGO_V2A

Spectral radial velocity expressed as air wavelength transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_A2F

public static final String SPECTRAL_ALGO_A2F

Spectral air wavelength expressed as frequency transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_A2W

public static final String SPECTRAL_ALGO_A2W

Spectral air wavelength expressed as vacuum wavelength transformation code for CTYPEna keywords

See Also:

• Constant Field Values

SPECTRAL_ALGO_A2V

public static final String SPECTRAL_ALGO_A2V

Spectral air wavelength expressed as apparent radial velocity transformation code for CTYPEna keywords

See Also:

• Constant Field Values

Method Details

values

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

alt

public IFitsHeader alt(char c)
                throws IllegalArgumentException,
UnsupportedOperationException

Specifying an alternative coordinate system. Alternative systems are labelled 'A' through 'Z'. This call is available only for the enums, which have a lower-case 'a' at the end of their Java names (such as WCSNAMEa). Attempting to call this on WCS keywords that do not end with lower-case 'a' in their Java names (such as OBSGEO_X will throw and UnsupportedOperationException. You will want to call this before chaining other calls to IFitsHeader.

Parameters:

c - The alternative coordinate system marker 'A' through 'Z' (case insensitive).

Returns:

The standard FITS keyword with the alternate coordinate system marker attached.

Throws:

IllegalArgumentException - if the marker is outside of the legal range of 'A' through 'Z' (case insensitive).

UnsupportedOperationException - if the keyword does not support alternative coordinate systems

Since:

1.19