Package nom.tam.fits.header

Enum Synonyms

java.lang.Object

java.lang.Enum<Synonyms>

nom.tam.fits.header.Synonyms

All Implemented Interfaces:

Serializable, Comparable<Synonyms>, java.lang.constant.Constable

public enum Synonyms
extends Enum<Synonyms>

This enum wil try to list synonyms inside or over different dictionaries. So please use always the highest level keyword you can find.

Author:

Richard van Nieuwenhoven, Attila Kovacs, and John Murphy

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMBTEMP	Ambient temperature in degrees Celsius
CLOUDCVR	Cloud cover percentage
CREATOR	Software that created the original FITS file.
DARKTIME	DARKTIME appears in multiple conventions
DEWPOINT	Dew point in degrees Celsius
EGAIN	Electronic gain -- electrons per ADU
EQUINOX	EQUINOX is now preferred over the old EPOCH
EXPOSURE	[s] Non-standard exposure time conventions.
EXTLEVEL	EXTLEVEL and HDULEVEL are synonymous, but EXTLEVEL is part of the standard since 1.19
EXTNAME	EXTNAME and HDUNAME are synonymous, but EXTNAME is part of the standard since 1.19
EXTVER	EXTVER and HDUVER are synonymous, but EXTVER is part of the standard since 1.19
FOCUSER	Focuser name
FOCUSPOS	Focus position steps
FOCUSTEM	Focus temperature in degrees Celsius.
HUMIDITY	Relative humidity in percent
ISOSPEED	Camera gain / ISO speed
nSn_na	Equivalent keywords for array column axis string parameters.
nVn_na	Equivalent keywords for array column axis parameter values.
OBJCTROT	Image rotation angle in degrees
PIXSCALE	Image scale (arcsec/pixel)
PRESSURE	Atmospheric pressure in hPA
RADESYS	RADESYS is now preferred over the old RADECSYS
RESTFRQ	RESTFRQ is now preferred over the old RESTFREQ
TCn_na	Equivalent keywords for column coordinate transformation matrix (CD convention).
TELAPSE	Clock time duration of observation.
TPn_na	Equivalent keywords for column coordinate transformation matrix (PC convention).
TSn_na	Equivalent keywords for column parameter names.
TSTART	Variants for recording the start time of observation in HH:MM:SS[.s...] format
TSTOP	Variants for recording the ending time of observation in HH:MM:SS[.s...] format
TVn_na	Equivalent keywords for column parameter values.
WCSna	Equivalent keywords for column coordinate transformation matrix (PC convention).
WINDDIR	Wind direction in degrees, clockwise from North
WINDSPD	Wind speed in km/h
XBINNING	Pixel binning in X direction
YBINNING	Pixel binning in Y direction

Method Summary

Modifier and Type	Method	Description
IFitsHeader[]	getSynonyms()	Returns the list of equivalent FITS header keywords as an array
IFitsHeader	primaryKeyword()	Returns the primary or preferred FITS header keyword to use to provide this information in a FITS header.
static String	primaryKeyword(String header)	Returns the primary or preferred FITS header keyword to prefer for the given header entry to provide this information in a FITS header.
static IFitsHeader	primaryKeyword(IFitsHeader key)	Returns the primary or preferred FITS header keyword to prefer for the given header entry to provide this information in a FITS header.
static Synonyms	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Synonyms[]	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

Enum Constant Details

EQUINOX

public static final Synonyms EQUINOX

EQUINOX is now preferred over the old EPOCH

RADESYS

public static final Synonyms RADESYS

RADESYS is now preferred over the old RADECSYS

RESTFRQ

public static final Synonyms RESTFRQ

RESTFRQ is now preferred over the old RESTFREQ

TPn_na

public static final Synonyms TPn_na

Equivalent keywords for column coordinate transformation matrix (PC convention). The shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TCn_na

public static final Synonyms TCn_na

Equivalent keywords for column coordinate transformation matrix (CD convention). The shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TSn_na

public static final Synonyms TSn_na

Equivalent keywords for column parameter names. The shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

TVn_na

public static final Synonyms TVn_na

Equivalent keywords for column parameter values. The shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

WCSna

public static final Synonyms WCSna

Equivalent keywords for column coordinate transformation matrix (PC convention). The shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

nSn_na

public static final Synonyms nSn_na

Equivalent keywords for array column axis string parameters. The shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

nVn_na

public static final Synonyms nVn_na

Equivalent keywords for array column axis parameter values. The shorter form may be required for column indices >99 with alternate coordinate systems.

Since:

1.19

EXTNAME

public static final Synonyms EXTNAME

EXTNAME and HDUNAME are synonymous, but EXTNAME is part of the standard since 1.19

EXTVER

public static final Synonyms EXTVER

EXTVER and HDUVER are synonymous, but EXTVER is part of the standard since 1.19

EXTLEVEL

public static final Synonyms EXTLEVEL

EXTLEVEL and HDULEVEL are synonymous, but EXTLEVEL is part of the standard since 1.19

EXPOSURE

public static final Synonyms EXPOSURE

[s] Non-standard exposure time conventions.

See Also:

• DateTime.XPOSURE

TSTART

public static final Synonyms TSTART

Variants for recording the start time of observation in HH:MM:SS[.s...] format

TSTOP

public static final Synonyms TSTOP

Variants for recording the ending time of observation in HH:MM:SS[.s...] format

DARKTIME

public static final Synonyms DARKTIME

DARKTIME appears in multiple conventions

OBJCTROT

public static final Synonyms OBJCTROT

Image rotation angle in degrees

Since:

1.20.1

EGAIN

public static final Synonyms EGAIN

Electronic gain -- electrons per ADU

Since:

1.20.1

FOCUSER

public static final Synonyms FOCUSER

Focuser name

Since:

1.20.1

FOCUSPOS

public static final Synonyms FOCUSPOS

Focus position steps

Since:

1.20.1

FOCUSTEM

public static final Synonyms FOCUSTEM

Focus temperature in degrees Celsius.

Since:

1.20.1

ISOSPEED

public static final Synonyms ISOSPEED

Camera gain / ISO speed

Since:

1.20.1

XBINNING

public static final Synonyms XBINNING

Pixel binning in X direction

Since:

1.20.1

YBINNING

public static final Synonyms YBINNING

Pixel binning in Y direction

Since:

1.20.1

PIXSCALE

public static final Synonyms PIXSCALE

Image scale (arcsec/pixel)

Since:

1.20.1

CLOUDCVR

public static final Synonyms CLOUDCVR

Cloud cover percentage

Since:

1.20.1

HUMIDITY

public static final Synonyms HUMIDITY

Relative humidity in percent

Since:

1.20.1

DEWPOINT

public static final Synonyms DEWPOINT

Dew point in degrees Celsius

Since:

1.20.1

AMBTEMP

public static final Synonyms AMBTEMP

Ambient temperature in degrees Celsius

Since:

1.20.1

WINDSPD

public static final Synonyms WINDSPD

Wind speed in km/h

Since:

1.20.1

WINDDIR

public static final Synonyms WINDDIR

Wind direction in degrees, clockwise from North

Since:

1.20.1

PRESSURE

public static final Synonyms PRESSURE

Atmospheric pressure in hPA

Since:

1.20.1

CREATOR

public static final Synonyms CREATOR

Software that created the original FITS file.

Since:

1.20.1

TELAPSE

public static final Synonyms TELAPSE

Clock time duration of observation.

Since:

1.20.1

Method Details

values

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

getSynonyms

public IFitsHeader[] getSynonyms()

Returns the list of equivalent FITS header keywords as an array

Returns:

an array containing the list of equivalent (interchangeable) FITS header keywords

primaryKeyword

public IFitsHeader primaryKeyword()

Returns the primary or preferred FITS header keyword to use to provide this information in a FITS header.

Returns:

the primary (or preferred) FITS header keyword form to use

primaryKeyword

public static IFitsHeader primaryKeyword(IFitsHeader key)

Returns the primary or preferred FITS header keyword to prefer for the given header entry to provide this information in a FITS header.

Parameters:

key - the standard or conventional header keyword.

Returns:

the primary (or preferred) FITS header keyword form to use

See Also:

• primaryKeyword(String)
• primaryKeyword()

primaryKeyword

public static String primaryKeyword(String header)

Returns the primary or preferred FITS header keyword to prefer for the given header entry to provide this information in a FITS header.

Parameters:

header - the string FITS header keyword

Returns:

the primary (or preferred) FITS header keyword form to use

See Also:

• primaryKeyword(IFitsHeader)