nom.tam.fits.header.Synonyms Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nom-tam-fits Show documentation
Show all versions of nom-tam-fits Show documentation
Java library for reading and writing FITS files. FITS, the Flexible Image Transport System, is the format commonly used in the archiving and transport of astronomical data.
package nom.tam.fits.header;
import java.util.Arrays;
import nom.tam.fits.header.extra.CommonExt;
import nom.tam.fits.header.extra.MaxImDLExt;
import nom.tam.fits.header.extra.NOAOExt;
import nom.tam.fits.header.extra.SBFitsExt;
import nom.tam.fits.header.extra.STScIExt;
/*
* #%L
* nom.tam FITS library
* %%
* Copyright (C) 1996 - 2024 nom-tam-fits
* %%
* This is free and unencumbered software released into the public domain.
*
* Anyone is free to copy, modify, publish, use, compile, sell, or
* distribute this software, either in source code form or as a compiled
* binary, for any purpose, commercial or non-commercial, and by any
* means.
*
* In jurisdictions that recognize copyright laws, the author or authors
* of this software dedicate any and all copyright interest in the
* software to the public domain. We make this dedication for the benefit
* of the public at large and to the detriment of our heirs and
* successors. We intend this dedication to be an overt act of
* relinquishment in perpetuity of all present and future rights to this
* software under copyright law.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
* #L%
*/
/**
* 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
*/
@SuppressWarnings("deprecation")
public enum Synonyms {
/** EQUINOX is now preferred over the old EPOCH */
EQUINOX(Standard.EQUINOX, Standard.EPOCH),
/** RADESYS is now preferred over the old RADECSYS */
RADESYS(Standard.RADESYS, Standard.RADECSYS),
/** RESTFRQ is now preferred over the old RESTFREQ */
RESTFRQ(Standard.RESTFRQ, WCS.RESTFREQ),
/**
* 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
*/
TPn_na(WCS.TPn_na, WCS.TPCn_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
*/
TCn_na(WCS.TCn_na, WCS.TCDn_na),
/**
* Equivalent keywords for column parameter names. The shorter form may be required for column indices >99 with
* alternate coordinate systems.
*
* @since 1.19
*/
TSn_na(WCS.TVn_na, WCS.TPSn_na),
/**
* Equivalent keywords for column parameter values. The shorter form may be required for column indices >99 with
* alternate coordinate systems.
*
* @since 1.19
*/
TVn_na(WCS.TVn_na, WCS.TPVn_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
*/
WCSna(WCS.WCSna, WCS.TWCSna),
/**
* 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
*/
nSn_na(WCS.nSn_na, WCS.nPSn_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
*/
nVn_na(WCS.nVn_na, WCS.nPVn_na),
/**
* EXTNAME and HDUNAME are synonymous, but EXTNAME is part of the standard since 1.19
*/
EXTNAME(Standard.EXTNAME, DataDescription.HDUNAME),
/**
* EXTVER and HDUVER are synonymous, but EXTVER is part of the standard since 1.19
*/
EXTVER(Standard.EXTVER, DataDescription.HDUVER),
/**
* EXTLEVEL and HDULEVEL are synonymous, but EXTLEVEL is part of the standard since 1.19
*/
EXTLEVEL(Standard.EXTLEVEL, DataDescription.HDULEVEL),
/**
* [s] Non-standard exposure time conventions.
*
* @see DateTime#XPOSURE
*/
EXPOSURE(ObservationDurationDescription.EXPOSURE, ObservationDurationDescription.EXPTIME,
ObservationDurationDescription.ONTIME, STScIExt.XPOSURE),
/**
* Variants for recording the start time of observation in HH:MM:SS[.s...] format
*/
TSTART(DateTime.TSTART, ObservationDurationDescription.TIME_OBS),
/**
* Variants for recording the ending time of observation in HH:MM:SS[.s...] format
*/
TSTOP(DateTime.TSTOP, ObservationDurationDescription.TIME_END),
/** DARKTIME appears in multiple conventions */
DARKTIME(NOAOExt.DARKTIME, SBFitsExt.DARKTIME),
/**
* Image rotation angle in degrees
*
* @since 1.20.1
*/
OBJCTROT(CommonExt.OBJCTROT, CommonExt.ANGLE),
/**
* Electronic gain -- electrons per ADU
*
* @since 1.20.1
*/
EGAIN(SBFitsExt.EGAIN, CommonExt.GAINADU),
/**
* Focuser name
*
* @since 1.20.1
*/
FOCUSER(CommonExt.FOCUSER, CommonExt.FOCNAME),
/**
* Focus position steps
*
* @since 1.20.1
*/
FOCUSPOS(MaxImDLExt.FOCUSPOS, CommonExt.FOCPOS),
/**
* Focus temperature in degrees Celsius.
*
* @since 1.20.1
*/
FOCUSTEM(MaxImDLExt.FOCUSTEM, CommonExt.FOCTEMP),
/**
* Camera gain / ISO speed
*
* @since 1.20.1
*/
ISOSPEED(MaxImDLExt.ISOSPEED, CommonExt.GAINRAW),
/**
* Pixel binning in X direction
*
* @since 1.20.1
*/
XBINNING(SBFitsExt.XBINNING, CommonExt.CCDXBIN),
/**
* Pixel binning in Y direction
*
* @since 1.20.1
*/
YBINNING(SBFitsExt.YBINNING, CommonExt.CCDYBIN),
/**
* Image scale (arcsec/pixel)
*
* @since 1.20.1
*/
PIXSCALE(CommonExt.PIXSCALE, CommonExt.SCALE),
/**
* Cloud cover percentage
*
* @since 1.20.1
*/
CLOUDCVR(CommonExt.CLOUDCVR, MaxImDLExt.AOCCLOUD),
/**
* Relative humidity in percent
*
* @since 1.20.1
*/
HUMIDITY(CommonExt.HUMIDITY, MaxImDLExt.AOCHUM, MaxImDLExt.BOLTHUM, MaxImDLExt.DAVHUM),
/**
* Dew point in degrees Celsius
*
* @since 1.20.1
*/
DEWPOINT(CommonExt.DEWPOINT, MaxImDLExt.AOCDEW, MaxImDLExt.BOLTDEW, MaxImDLExt.DAVDEW),
/**
* Ambient temperature in degrees Celsius
*
* @since 1.20.1
*/
AMBTEMP(CommonExt.AMBTEMP, MaxImDLExt.AOCAMBT, MaxImDLExt.BOLTAMBT, MaxImDLExt.DAVAMBT),
/**
* Wind speed in km/h
*
* @since 1.20.1
*/
WINDSPD(CommonExt.WINDSPD, MaxImDLExt.BOLTWIND, MaxImDLExt.DAVWIND), // MaxImDLExt.AOCWIND, uses different units
/**
* Wind direction in degrees, clockwise from North
*
* @since 1.20.1
*/
WINDDIR(CommonExt.WINDDIR, MaxImDLExt.AOCWINDD, MaxImDLExt.DAVWINDD),
/**
* Atmospheric pressure in hPA
*
* @since 1.20.1
*/
PRESSURE(CommonExt.PRESSURE, MaxImDLExt.AOCBAROM, MaxImDLExt.DAVBAROM),
/**
* Software that created the original FITS file.
*
* @since 1.20.1
*/
CREATOR(DataDescription.CREATOR, DataDescription.PROGRAM, SBFitsExt.SWCREATE),
/**
* Clock time duration of observation.
*
* @since 1.20.1
*/
TELAPSE(DateTime.TELAPSE, ObservationDurationDescription.ELAPTIME);
private final IFitsHeader primaryKeyword;
private final IFitsHeader[] synonyms;
Synonyms(IFitsHeader primaryKeyword, IFitsHeader... synonyms) {
this.primaryKeyword = primaryKeyword;
this.synonyms = synonyms;
}
/**
* Returns the list of equivalent FITS header keywords as an array
*
* @return an array containing the list of equivalent (interchangeable) FITS header keywords
*/
public IFitsHeader[] getSynonyms() {
return Arrays.copyOf(synonyms, synonyms.length);
}
/**
* Returns the primary or preferred FITS header keyword to use to provide this information in a FITS header.
*
* @return the primary (or preferred) FITS header keyword form to use
*/
public IFitsHeader primaryKeyword() {
return primaryKeyword;
}
/**
* Returns the primary or preferred FITS header keyword to prefer for the given header entry to provide this
* information in a FITS header.
*
* @param key the standard or conventional header keyword.
*
* @return the primary (or preferred) FITS header keyword form to use
*
* @see #primaryKeyword(String)
* @see #primaryKeyword()
*/
public static IFitsHeader primaryKeyword(IFitsHeader key) {
for (Synonyms synonym : values()) {
for (IFitsHeader synHeader : synonym.synonyms) {
if (synHeader.equals(key)) {
return synonym.primaryKeyword();
}
}
}
return key;
}
/**
* Returns the primary or preferred FITS header keyword to prefer for the given header entry to provide this
* information in a FITS header.
*
* @param header the string FITS header keyword
*
* @return the primary (or preferred) FITS header keyword form to use
*
* @see #primaryKeyword(IFitsHeader)
*/
public static String primaryKeyword(String header) {
for (Synonyms synonym : values()) {
for (IFitsHeader synHeader : synonym.synonyms) {
if (synHeader.key().equals(header)) {
return synonym.primaryKeyword().key();
}
}
}
return header;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy