nom.tam.fits.compression.algorithm.rice.RiceQuantizeCompressOption 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.algorithm.rice;

/*
 * #%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 nom.tam.fits.compression.algorithm.quant.QuantizeOption;

/**
 * @deprecated (for internal use) This class should not be exposed to users.
 *                 
 *                 Options to the Rice compression algorithm when the compression includes quantization. When
 *                 compressing tables and images using the Rice algorithm, including quantization, users can control how
 *                 exactly the compression and quantization are perfomed. When reading compressed FITS files, these
 *                 options will be set automatically based on the header values recorded in the compressed HDU.
 *                 
 * 
 * @see        nom.tam.image.compression.hdu.CompressedImageHDU#setCompressAlgorithm(String)
 * @see        nom.tam.image.compression.hdu.CompressedImageHDU#getCompressOption(Class)
 * @see        RiceCompressOption
 */
@Deprecated
public class RiceQuantizeCompressOption extends QuantizeOption {

    /**
     * Creates a new set of options for Rice compression with quantization, initialized to default values.
     */
    public RiceQuantizeCompressOption() {
        super(new RiceCompressOption());
    }

    /**
     * Creates a new set of options for Rice compression with quantization, using the specified option to the Rice
     * (de)compression, and initializing the qunatization options with default values.
     * 
     * @param compressOption The Rice compression options to use
     */
    public RiceQuantizeCompressOption(RiceCompressOption compressOption) {
        super(compressOption);
    }

    /**
     * Returns the options that are specific to the Rice compression algorithm (without quantization).
     * 
     * @return the included options to the Rice compression algorithm
     * 
     * @see    #getCompressOption(Class)
     */
    public RiceCompressOption getRiceCompressOption() {
        return (RiceCompressOption) super.getCompressOption();
    }
}