Enum CommonExt

java.lang.Object

java.lang.Enum<CommonExt>

nom.tam.fits.header.extra.CommonExt

All Implemented Interfaces:

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

public enum CommonExt
extends Enum<CommonExt>
implements IFitsHeader

A Set of commonly used keywords in the amateur astronomy community.

Since:

1.20.1

Author:

John Murphy and Attila Kovacs

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
AMBTEMP	Ambient air temperature in degrees Celsius
ANGLE	Synonym of OBJCTROT.
CCDXBIN	X axis binning factor.
CCDYBIN	Y axis binning factor.
CLOUDCVR	Cloud cover as percentage
DATE_LOC	Local time of observation (ISO timestamp), e.g. "2017-01-03T02:41:24" or "2024-02-24T22:23:33.054"
DEWPOINT	Dew point in degrees Celsius.
FLIPPED	Whether or not the image is flipped
FOCNAME	Name of focuser.
FOCPOS	Focuser position in steps.
FOCRATIO	Focal ratio
FOCTEMP	Focus temperature in degrees Celsius.
FOCUSER	Name of focuser
FWHEEL	Filter wheel name
GAIN	Camera gain / amplification.
GAINADU	Synonym of MaxImDLExt.EGAIN
GAINRAW	Amplifier gain.
HUMIDITY	Relative humidity as percentage
OBJCTROT	Image rotation angle in degrees.
OFFSET	Camera offset setting.
PIXSCALE	Image scale in arcsec/pixel.
PRESSURE	Air pressure in hPa.
SCALE	Image scale in arcsec / pixel.
SITEELEV	Elevation of observing site above sea level in meters
SITENAME	Observatory site, e.g.
WINDDIR	Wind direction clockwise from North [0:360]
WINDSPD	Average wind speed in km/h

Field Summary

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
final FitsKey	impl()	(primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
static CommonExt	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommonExt[]	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

AMBTEMP

public static final CommonExt AMBTEMP

Ambient air temperature in degrees Celsius

ANGLE

public static final CommonExt ANGLE

Synonym of OBJCTROT.

CCDXBIN

public static final CommonExt CCDXBIN

X axis binning factor. Synonym for SBFitsExt.XBINNING

CCDYBIN

public static final CommonExt CCDYBIN

Y axis binning factor. Synonym for SBFitsExt.YBINNING

CLOUDCVR

public static final CommonExt CLOUDCVR

Cloud cover as percentage

DATE_LOC

public static final CommonExt DATE_LOC

Local time of observation (ISO timestamp), e.g. "2017-01-03T02:41:24" or "2024-02-24T22:23:33.054"

DEWPOINT

public static final CommonExt DEWPOINT

Dew point in degrees Celsius.

FLIPPED

public static final CommonExt FLIPPED

Whether or not the image is flipped

FOCNAME

public static final CommonExt FOCNAME

Name of focuser. Synonym of FOCUSER

FOCPOS

public static final CommonExt FOCPOS

Focuser position in steps. Usually an integer, but not always. Synonymous to MaxImDLExt.FOCUSPOS

FOCRATIO

public static final CommonExt FOCRATIO

Focal ratio

FOCUSER

public static final CommonExt FOCUSER

Name of focuser

FOCTEMP

public static final CommonExt FOCTEMP

Focus temperature in degrees Celsius. Synonymous to MaxImDLExt.FOCUSTEM.

FWHEEL

public static final CommonExt FWHEEL

Filter wheel name

GAIN

public static final CommonExt GAIN

Camera gain / amplification. Often used the same as GAINRAW. There may be many different conventions on using this keyword. For example it may represent a multiplicative gain factor or gain defined as decibels, or strings such as 'HI'/'LO', or even as a boolean T/F. Therefore, this definition does not restrict the type of value this keyword can be used with. It is up to the user to ensure they follow the convention that makes most sense to their application, and for the tools they intend to use.

GAINADU

public static final CommonExt GAINADU

Synonym of MaxImDLExt.EGAIN

GAINRAW

public static final CommonExt GAINRAW

Amplifier gain. Synonym of MaxImDLExt.ISOSPEED

HUMIDITY

public static final CommonExt HUMIDITY

Relative humidity as percentage

OBJCTROT

public static final CommonExt OBJCTROT

Image rotation angle in degrees.

OFFSET

public static final CommonExt OFFSET

Camera offset setting. Very common since CMOS cameras became popular

PIXSCALE

public static final CommonExt PIXSCALE

Image scale in arcsec/pixel. Redundant with Standard.CDELTn.

PRESSURE

public static final CommonExt PRESSURE

Air pressure in hPa.

SCALE

public static final CommonExt SCALE

Image scale in arcsec / pixel. Synonym of PIXSCALE, and redundant with Standard.CDELTn.

SITEELEV

public static final CommonExt SITEELEV

Elevation of observing site above sea level in meters

SITENAME

public static final CommonExt SITENAME

Observatory site, e.g. "Maunakea"

WINDDIR

public static final CommonExt WINDDIR

Wind direction clockwise from North [0:360]

WINDSPD

public static final CommonExt WINDSPD

Average wind speed in km/h

Method Details

values

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