1 package nom.tam.fits.compression.algorithm.rice;
2
3 /*
4 * #%L
5 * nom.tam FITS library
6 * %%
7 * Copyright (C) 1996 - 2024 nom-tam-fits
8 * %%
9 * This is free and unencumbered software released into the public domain.
10 *
11 * Anyone is free to copy, modify, publish, use, compile, sell, or
12 * distribute this software, either in source code form or as a compiled
13 * binary, for any purpose, commercial or non-commercial, and by any
14 * means.
15 *
16 * In jurisdictions that recognize copyright laws, the author or authors
17 * of this software dedicate any and all copyright interest in the
18 * software to the public domain. We make this dedication for the benefit
19 * of the public at large and to the detriment of our heirs and
20 * successors. We intend this dedication to be an overt act of
21 * relinquishment in perpetuity of all present and future rights to this
22 * software under copyright law.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30 * OTHER DEALINGS IN THE SOFTWARE.
31 * #L%
32 */
33
34 import nom.tam.fits.compression.algorithm.quant.QuantizeOption;
35
36 /**
37 * @deprecated (<i>for internal use</i>) This class should not be exposed to users.
38 * <p>
39 * Options to the Rice compression algorithm when the compression includes quantization. When
40 * compressing tables and images using the Rice algorithm, including quantization, users can control how
41 * exactly the compression and quantization are perfomed. When reading compressed FITS files, these
42 * options will be set automatically based on the header values recorded in the compressed HDU.
43 * </p>
44 *
45 * @see nom.tam.image.compression.hdu.CompressedImageHDU#setCompressAlgorithm(String)
46 * @see nom.tam.image.compression.hdu.CompressedImageHDU#getCompressOption(Class)
47 * @see RiceCompressOption
48 */
49 @Deprecated
50 public class RiceQuantizeCompressOption extends QuantizeOption {
51
52 /**
53 * Creates a new set of options for Rice compression with quantization, initialized to default values.
54 */
55 public RiceQuantizeCompressOption() {
56 super(new RiceCompressOption());
57 }
58
59 /**
60 * Creates a new set of options for Rice compression with quantization, using the specified option to the Rice
61 * (de)compression, and initializing the qunatization options with default values.
62 *
63 * @param compressOption The Rice compression options to use
64 */
65 public RiceQuantizeCompressOption(RiceCompressOption compressOption) {
66 super(compressOption);
67 }
68
69 /**
70 * Returns the options that are specific to the Rice compression algorithm (without quantization).
71 *
72 * @return the included options to the Rice compression algorithm
73 *
74 * @see #getCompressOption(Class)
75 */
76 public RiceCompressOption getRiceCompressOption() {
77 return (RiceCompressOption) super.getCompressOption();
78 }
79 }