Package nom.tam.fits.header
Enum NonStandard
- java.lang.Object
-
- java.lang.Enum<NonStandard>
-
- nom.tam.fits.header.NonStandard
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<NonStandard>
,IFitsHeader
public enum NonStandard extends java.lang.Enum<NonStandard> implements IFitsHeader
This data dictionary contains FITS keywords that have been widely used within the astronomical community. It is recommended that these keywords only be used as defined here. These are the Keywords that denote non-standard FITS keyword format conventions.
-
-
Nested Class Summary
-
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 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.HIERARCH
The HIERARCH keyword, when followed by spaces in columns 9 and 10 of the FITS card image, indicates that the ESO HIERARCH keyword convention should be used to interpret the name and value of the keyword.INHERIT
The presence of this keyword with a value = T in an extension key indicates that the keywords contained in the primary key (except the FITS Mandatory keywords, and any COMMENT, HISTORY or 'blank' keywords) are to be inherited, or logically included in that extension key.
-
Field Summary
Fields Modifier and Type Field Description private IFitsHeader
key
-
Constructor Summary
Constructors Modifier Constructor Description private
NonStandard(IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, java.lang.String comment)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
comment()
IFitsHeader.HDU
hdu()
java.lang.String
key()
IFitsHeader
n(int... number)
IFitsHeader.SOURCE
status()
static NonStandard
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static NonStandard[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.IFitsHeader.VALUE
valueType()
-
-
-
Enum Constant Detail
-
CONTINUE
public static final NonStandard 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.
-
HIERARCH
public static final NonStandard HIERARCH
The HIERARCH keyword, when followed by spaces in columns 9 and 10 of the FITS card image, indicates that the ESO HIERARCH keyword convention should be used to interpret the name and value of the keyword. The HIERARCH keyword formally has no value because it is not followed by an equals sign in column 9. Under the HIERARCH convention the actual name of the keyword begins in column 11 of the card image and is terminated by the equal sign ('=') character. The name can contain any number of characters as long as it fits within columns 11 and 80 of the card image and also leaves enough space for the equal sign separator and the value field. The name can contain any printable ASCII text character, including spaces and lower-case characters, except for the equal sign character which serves as the terminator of the name field. Leading and trailing spaces in the name field are not significant, but embedded spaces within the name are significant. The value field follows the equals sign and must conform to the syntax for a free-format value field as defined in the FITS Standard. The value field may be null, in which case it contains only space characters, otherwise it may contain either a character string enclosed in single quotes, the logical constant T or F, an integer number, a floating point number, a complex integer number, or a complex floating point number. The value field may be followed by an optional comment string. The comment field must be separated from the value field by a slash character ('/'). It is recommended that the slash character be preceeded and followed by a space character. Example: "HIERARCH Filter Wheel = 12 / filter position". In this example the logical name of the keyword is 'Filter Wheel' and the value is 12.
-
INHERIT
public static final NonStandard INHERIT
The presence of this keyword with a value = T in an extension key indicates that the keywords contained in the primary key (except the FITS Mandatory keywords, and any COMMENT, HISTORY or 'blank' keywords) are to be inherited, or logically included in that extension key.
-
-
Field Detail
-
key
private final IFitsHeader key
-
-
Constructor Detail
-
NonStandard
private NonStandard(IFitsHeader.SOURCE status, IFitsHeader.HDU hdu, IFitsHeader.VALUE valueType, java.lang.String comment)
-
-
Method Detail
-
values
public static NonStandard[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (NonStandard c : NonStandard.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NonStandard valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
comment
public java.lang.String comment()
- Specified by:
comment
in interfaceIFitsHeader
-
hdu
public IFitsHeader.HDU hdu()
- Specified by:
hdu
in interfaceIFitsHeader
-
key
public java.lang.String key()
- Specified by:
key
in interfaceIFitsHeader
-
n
public IFitsHeader n(int... number)
- Specified by:
n
in interfaceIFitsHeader
-
status
public IFitsHeader.SOURCE status()
- Specified by:
status
in interfaceIFitsHeader
-
valueType
public IFitsHeader.VALUE valueType()
- Specified by:
valueType
in interfaceIFitsHeader
-
-