org.opencadc.fits.slice.FITSHeaderWCSKeywords Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cadc-data-ops-fits Show documentation
Show all versions of cadc-data-ops-fits Show documentation
OpenCADC FITS cutout library
The newest version!
/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2021. (c) 2021.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
* All rights reserved Tous droits réservés
*
* NRC disclaims any warranties, Le CNRC dénie toute garantie
* expressed, implied, or énoncée, implicite ou légale,
* statutory, of any kind with de quelque nature que ce
* respect to the software, soit, concernant le logiciel,
* including without limitation y compris sans restriction
* any warranty of merchantability toute garantie de valeur
* or fitness for a particular marchande ou de pertinence
* purpose. NRC shall not be pour un usage particulier.
* liable in any event for any Le CNRC ne pourra en aucun cas
* damages, whether direct or être tenu responsable de tout
* indirect, special or general, dommage, direct ou indirect,
* consequential or incidental, particulier ou général,
* arising from the use of the accessoire ou fortuit, résultant
* software. Neither the name de l'utilisation du logiciel. Ni
* of the National Research le nom du Conseil National de
* Council of Canada nor the Recherches du Canada ni les noms
* names of its contributors may de ses participants ne peuvent
* be used to endorse or promote être utilisés pour approuver ou
* products derived from this promouvoir les produits dérivés
* software without specific prior de ce logiciel sans autorisation
* written permission. préalable et particulière
* par écrit.
*
* This file is part of the Ce fichier fait partie du projet
* OpenCADC project. OpenCADC.
*
* OpenCADC is free software: OpenCADC est un logiciel libre ;
* you can redistribute it and/or vous pouvez le redistribuer ou le
* modify it under the terms of modifier suivant les termes de
* the GNU Affero General Public la “GNU Affero General Public
* License as published by the License” telle que publiée
* Free Software Foundation, par la Free Software Foundation
* either version 3 of the : soit la version 3 de cette
* License, or (at your option) licence, soit (à votre gré)
* any later version. toute version ultérieure.
*
* OpenCADC is distributed in the OpenCADC est distribué
* hope that it will be useful, dans l’espoir qu’il vous
* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
* without even the implied GARANTIE : sans même la garantie
* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
* General Public License for Générale Publique GNU Affero
* more details. pour plus de détails.
*
* You should have received Vous devriez avoir reçu une
* a copy of the GNU Affero copie de la Licence Générale
* General Public License along Publique GNU Affero avec
* with OpenCADC. If not, see OpenCADC ; si ce n’est
* > iterator() {
return new Iterator>() {
final Cursor source = header.iterator();
@Override
public boolean hasNext() {
return source.hasNext();
}
/**
* Convert to a Map.Entry object to adhere to the contract of this interface. Be aware that BLANKS and
* some COMMENTs will create empty keys and possibly empty values.
* @return Map.Entry object, never null.
*/
@Override
public Map.Entry next() {
final Map convertor = new HashMap<>();
final HeaderCard nextHeaderCard = source.next();
final Class valueType = nextHeaderCard.valueType();
final String headerCardValue = nextHeaderCard.getValue();
final Object value;
if (valueType == null || valueType == String.class || valueType == Boolean.class) {
value = headerCardValue;
} else if (valueType == Integer.class) {
value = Integer.parseInt(headerCardValue);
} else if (valueType == Long.class) {
value = Long.parseLong(headerCardValue);
} else if (valueType == Double.class || valueType == BigDecimal.class
|| valueType == BigInteger.class) {
value = Double.parseDouble(headerCardValue);
} else {
value = "";
}
convertor.put(nextHeaderCard.getKey(), value);
return convertor.entrySet().iterator().next();
}
};
}
public final Header getHeader() {
return this.header;
}
private Header cloneHeader(final WCSKeywords wcsKeywords) throws HeaderCardException {
final Header destination = new Header();
for (final Iterator> entryIterator = wcsKeywords.iterator();
entryIterator.hasNext(); ) {
final Map.Entry entry = entryIterator.next();
final String key = entry.getKey();
final Object value = entry.getValue();
if (value != null) {
final Class valueType = value.getClass();
cloneHeaderCard(destination, key, valueType, "", value.toString());
}
}
destination.setNaxes(wcsKeywords.getIntValue(Standard.NAXIS.key()));
sanitizeHeader(destination);
return destination;
}
/**
* Make a copy of the header. Adjusting the source Header directly with an underlying File can result in the source
* file being modified, so we duplicate it here to remove references.
*
* @param source The source Header.
* @return Header object with reproduced cards. Never null.
* @throws HeaderCardException Any I/O with Header Cards.
*/
private Header cloneHeader(final Header source) throws HeaderCardException {
final Header destination = new Header();
// Use a for loop here rather than Java Collections stream to pass the exception up properly.
for (final Iterator headerCardIterator = source.iterator(); headerCardIterator.hasNext(); ) {
final HeaderCard headerCard = headerCardIterator.next();
cloneHeaderCard(destination, headerCard.getKey(), headerCard.valueType(), headerCard.getComment(),
headerCard.getValue());
}
sanitizeHeader(destination);
return destination;
}
/**
* Copy a header card with some potential modifications. COMMENT and HISTORY cards are truncated to the
* maximum length.
*
* @param destination The Header to write to.
* @param headerCardKey The current key.
* @param valueType The class type of the value.
* @param comment The comment value for COMMENT or HISTORY values.
* @param value The string value.
* @throws HeaderCardException
*/
private void cloneHeaderCard(final Header destination, final String headerCardKey, final Class valueType,
final String comment, final String value) throws HeaderCardException {
// Check for blank lines or just plain comments that are not standard FITS comments.
if (!StringUtil.hasText(headerCardKey)) {
destination.addValue(headerCardKey, (String) null, comment);
} else if (Standard.COMMENT.key().equals(headerCardKey)) {
if (StringUtil.hasText(comment) && comment.length() > HeaderCard.MAX_COMMENT_CARD_COMMENT_LENGTH) {
destination.insertComment(comment.substring(0, HeaderCard.MAX_COMMENT_CARD_COMMENT_LENGTH));
} else {
destination.insertComment(comment);
}
} else if (Standard.HISTORY.key().equals(headerCardKey)) {
if (StringUtil.hasText(comment) && comment.length() > HeaderCard.MAX_COMMENT_CARD_COMMENT_LENGTH) {
destination.insertHistory(comment.substring(0, HeaderCard.MAX_COMMENT_CARD_COMMENT_LENGTH));
} else {
destination.insertHistory(comment);
}
} else if (headerCardKey.startsWith(CADCExt.CDELT.key())) {
// CDELT values cannot be zero.
final double cdeltValue = Double.parseDouble(value);
destination.addValue(headerCardKey, cdeltValue == 0.0D ? 1.0D : cdeltValue, comment);
} else {
if (valueType == String.class || valueType == null) {
destination.addValue(headerCardKey, value, comment);
} else if (valueType == Boolean.class) {
destination.addValue(headerCardKey, Boolean.parseBoolean(value) || value.equals("T"), comment);
} else if (valueType == Integer.class) {
destination.addValue(headerCardKey, Integer.parseInt(value), comment);
} else if (valueType == BigInteger.class) {
destination.addValue(headerCardKey, new BigInteger(value), comment);
} else if (valueType == Long.class) {
destination.addValue(headerCardKey, Long.parseLong(value), comment);
} else if (valueType == Double.class) {
destination.addValue(headerCardKey, Double.parseDouble(value), comment);
} else if (valueType == BigDecimal.class) {
destination.addValue(headerCardKey, new BigDecimal(value), comment);
} else if (valueType == Float.class) {
destination.addValue(headerCardKey, Float.parseFloat(value), comment);
}
}
}
private void sanitizeHeader(final Header destination) throws HeaderCardException {
final int naxis = destination.getIntValue(Standard.NAXIS);
final boolean expectCD = destination.containsKey(NOAOExt.CD1_1);
final boolean expectPC = destination.containsKey(CADCExt.PC1_1);
final int temporalAxis = getTemporalAxis(destination);
final boolean expectPCProper = destination.containsKey(CADCExt.PC01_01);
for (int x = 1; x <= naxis; x++) {
for (int y = 1; y <= naxis; y++) {
final String cdMatrixKey = String.format("CD%d_%d", x, y);
final String pcMatrixKey = String.format("PC%d_%d", x, y);
final String pcProperMatrixKey = String.format("PC%02d_%02d", x, y);
// The wcslib library wants the PC/CD matrix intact for spatial cutouts.
if (expectCD && !destination.containsKey(cdMatrixKey)) {
destination.addValue(cdMatrixKey, (x == y) ? 1.0D : 0.0D, null);
}
if ((expectPC && !destination.containsKey(pcMatrixKey))
|| (expectPCProper && !destination.containsKey(pcProperMatrixKey))) {
destination.addValue(pcProperMatrixKey, (x == y) ? 1.0D : 0.0D, null);
}
if (x == temporalAxis && !destination.containsKey(CADCExt.CUNITn.n(x))
&& !destination.containsKey(DateTime.TIMEUNIT)) {
destination.addValue(DateTime.TIMEUNIT.key(), "s", DateTime.TIMEUNIT.comment());
}
}
// Ensure the default units are added when missing.
final String cType = destination.getStringValue(Standard.CTYPEn.n(x));
if (cType != null) {
final String cUnit = destination.getStringValue(CADCExt.CUNITn.n(x));
if (cUnit == null) {
destination.addValue(CADCExt.CUNITn.n(x), CoordTypeCode.getDefaultUnit(cType));
}
}
}
}
/**
* Obtain the spatial longitude axis value.
*
* @return int axis, or -1 if no spectral axis present.
*/
int getSpatialLongitudeAxis() {
return getSpatialLongitudeAxis(this.header);
}
/**
* Obtain the two spatial axis value.
*
* @param h The header to check for the axes.
* @return int of longitude axis numbers, or -1 if none found.
*/
int getSpatialLongitudeAxis(final Header h) {
final int naxis = h.getIntValue(Standard.NAXIS);
for (int i = 1; i <= naxis; i++) {
final String ctypeValue = h.getStringValue(Standard.CTYPEn.n(i));
if (ctypeValue != null && Arrays.stream(CoordTypeCode.values()).anyMatch(
coordTypeCode -> ctypeValue.startsWith(coordTypeCode.name())
&& coordTypeCode.isSpatialLongitudinal())) {
return i;
}
}
return -1;
}
/**
* Obtain the spatial longitude axis value.
*
* @return int axis, or -1 if no spectral axis present.
*/
int getSpatialLatitudeAxis() {
return getSpatialLatitudeAxis(this.header);
}
/**
* Obtain the two spatial axis value.
*
* @param h The header to check for the axes.
* @return int of longitude axis numbers, or -1 if none found.
*/
int getSpatialLatitudeAxis(final Header h) {
final int naxis = h.getIntValue(Standard.NAXIS);
for (int i = 1; i <= naxis; i++) {
final String ctypeValue = h.getStringValue(Standard.CTYPEn.n(i));
if (ctypeValue != null && Arrays.stream(CoordTypeCode.values()).anyMatch(
coordTypeCode -> ctypeValue.startsWith(coordTypeCode.name())
&& coordTypeCode.isSpatialLatitudinal())) {
return i;
}
}
return -1;
}
/**
* Obtain the energy (1-based) axis from the current header. Return -1 if none found that match the Spectral types.
*
* @return int axis, or -1 if no spectral axis present.
*/
int getSpectralAxis() {
return getSpectralAxis(this.header);
}
/**
* Obtain the energy (1-based) axis from the given header. Return -1 if none found that match the Spectral types.
*
* @param h The header to search in
* @return integer axis, or -1 if not found.
*/
int getSpectralAxis(final Header h) {
final int naxis = h.getIntValue(Standard.NAXIS);
for (int i = 1; i <= naxis; i++) {
final String ctypeValue = h.getStringValue(Standard.CTYPEn.n(i));
if (ctypeValue != null && Arrays.stream(CoordTypeCode.values()).anyMatch(
coordTypeCode -> ctypeValue.startsWith(coordTypeCode.name()) && coordTypeCode.isSpectral())) {
return i;
}
}
return -1;
}
/**
* Obtain the time (1-based) axis from the current header. Return -1 if none found that match the Temporal types.
*
* @return int axis, or -1 if no temporal axis present.
*/
public int getTemporalAxis() {
return getTemporalAxis(this.header);
}
/**
* Obtain the time (1-based) axis from the given header. Return -1 if none found that match the Temporal types.
*
* @param h The header to search in
* @return integer axis, or -1 if not found.
*/
int getTemporalAxis(final Header h) {
final int naxis = h.getIntValue(Standard.NAXIS);
for (int i = 1; i <= naxis; i++) {
final String ctypeValue = h.getStringValue(Standard.CTYPEn.n(i));
if (ctypeValue != null && Arrays.stream(CoordTypeCode.values()).anyMatch(
coOrdTypeCode -> ctypeValue.startsWith(coOrdTypeCode.name()) && coOrdTypeCode.isTemporal())) {
return i;
}
}
return -1;
}
/**
* Obtain the time (1-based) axis from the given header. Return -1 if none found that match the Temporal types.
*
* @return integer axis, or -1 if not found.
*/
int getPolarizationAxis() {
return getPolarizationAxis(this.header);
}
/**
* Obtain the time (1-based) axis from the given header. Return -1 if none found that match the Temporal types.
*
* @param h The header to search in
* @return integer axis, or -1 if not found.
*/
int getPolarizationAxis(final Header h) {
final int naxis = h.getIntValue(Standard.NAXIS);
for (int i = 1; i <= naxis; i++) {
final String ctypeValue = h.getStringValue(Standard.CTYPEn.n(i));
if (ctypeValue != null && Arrays.stream(CoordTypeCode.values()).anyMatch(
coOrdTypeCode -> ctypeValue.startsWith(coOrdTypeCode.name()) && coOrdTypeCode.isPolarization())) {
return i;
}
}
return -1;
}
}