nom.tam.fits.compression.provider.param.base.CompressParameters 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
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.
There is a newer version: 1.21.0
Show newest version
package nom.tam.fits.compression.provider.param.base;

import nom.tam.fits.BinaryTable;
import nom.tam.fits.BinaryTableHDU;
import nom.tam.fits.FitsException;
import nom.tam.fits.Header;
import nom.tam.fits.HeaderCard;
import nom.tam.fits.HeaderCardException;
import nom.tam.fits.compression.provider.param.api.ICompressColumnParameter;
import nom.tam.fits.compression.provider.param.api.ICompressHeaderParameter;
import nom.tam.fits.compression.provider.param.api.ICompressParameters;

/*
 * #%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%
 */

import static nom.tam.fits.header.Standard.TTYPEn;

/**
 * (for internal use) A set of {@link CompressParameter}s that are bundled together, typically because they are
 * parameters that all link to the same {@link nom.tam.fits.compression.algorithm.api.ICompressOption}
 * 
 * @see CompressParameter
 */
public abstract class CompressParameters implements ICompressParameters, Cloneable {

    @Override
    public void addColumnsToTable(BinaryTableHDU hdu) throws FitsException {
        for (ICompressColumnParameter parameter : columnParameters()) {
            Object column = parameter.getColumnData();
            if (column != null) {
                hdu.setColumnName(hdu.addColumn(column) - 1, parameter.getName(), null);
            }
        }
    }

    @Override
    protected CompressParameters clone() {
        try {
            return (CompressParameters) super.clone();
        } catch (CloneNotSupportedException e) {
            return null;
        }
    }

    @Override
    public void setTileIndex(int index) {
    }

    @Override
    public void getValuesFromColumn(int index) {
        for (ICompressColumnParameter parameter : columnParameters()) {
            parameter.getValueFromColumn(index);
        }
    }

    @Override
    public void getValuesFromHeader(Header header) throws HeaderCardException {
        for (ICompressHeaderParameter compressionParameter : headerParameters()) {
            compressionParameter.getValueFromHeader(header);
        }
    }

    @Override
    public void initializeColumns(Header header, BinaryTable binaryTable, int size)
            throws HeaderCardException, FitsException {
        for (ICompressColumnParameter parameter : columnParameters()) {
            parameter.setColumnData(getNullableColumn(header, binaryTable, parameter.getName()), size);
        }
    }

    @Override
    public void initializeColumns(int size) {
        for (ICompressColumnParameter parameter : columnParameters()) {
            parameter.setColumnData(null, size);
        }
    }

    @Override
    public void setValuesInColumn(int index) {
        for (ICompressColumnParameter parameter : columnParameters()) {
            parameter.setValueInColumn(index);
        }
    }

    @Override
    public void setValuesInHeader(Header header) throws HeaderCardException {
        for (ICompressHeaderParameter parameter : headerParameters()) {
            parameter.setValueInHeader(header);
        }
    }

    private Object getNullableColumn(Header header, BinaryTable binaryTable, String columnName)
            throws HeaderCardException, FitsException {
        for (int i = 1; i <= binaryTable.getNCols(); i++) {
            HeaderCard card = header.getCard(TTYPEn.n(i));
            if (card != null) {
                if (card.getValue().trim().equals(columnName)) {
                    return binaryTable.getColumn(i - 1);
                }
            }
        }
        return null;
    }

    /**
     * Retuens the subset of parameters from within, which are recorded in compressed table columns along with the
     * compressed data.
     * 
     * @return the subset of parameters that are recorded in compressed table columns.
     * 
     * @see    #headerParameters()
     */
    protected ICompressColumnParameter[] columnParameters() {
        return new ICompressColumnParameter[0];
    }

    /**
     * Returns the subset of parameters from within, which are recorded in the header of the compressed HDU.
     * 
     * @return the subset of parameters that are recorded in the compressed HDU's header.
     * 
     * @see    #columnParameters()
     */
    protected abstract ICompressHeaderParameter[] headerParameters();
}