1 package nom.tam.fits.compression.provider.param.quant;
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 import nom.tam.fits.compression.provider.param.base.CompressColumnParameter;
36 import nom.tam.fits.header.Compression;
37
38 /**
39 * (<i>for internal use</i>) The blanking value in quantized data as recorded in a FITS compressed table column.
40 */
41 public final class ZBlankColumnParameter extends CompressColumnParameter<int[], QuantizeOption> {
42
43 /**
44 * @deprecated (<i>for internal use</i>) the visibility of this constructor may be reduced to the package level in
45 * future releases.
46 */
47 @Deprecated
48 @SuppressWarnings("javadoc")
49 public ZBlankColumnParameter(QuantizeOption quantizeOption) {
50 super(Compression.ZBLANK_COLUMN, quantizeOption, int[].class);
51 }
52
53 @Override
54 public void getValueFromColumn(int index) {
55 int[] col = getColumnData();
56 if (col != null) {
57 getOption().setBNull(col[index]);
58 }
59 }
60
61 @Override
62 public void setValueInColumn(int index) throws IndexOutOfBoundsException {
63 int[] col = getColumnData();
64 if (col != null) {
65 Integer blankValue = getOption().getBNull();
66 col[index] = blankValue == null ? getInitValue() : blankValue;
67 }
68 }
69
70 /**
71 * Checks if the column entries are all the same.
72 *
73 * @return <code>true</code> if the entries in the column are all identical. Otherwise <code>false</code> if the
74 * entries vary.
75 *
76 * @since 1.23
77 */
78 boolean isUniform() {
79 int[] col = getColumnData();
80 if (col != null) {
81 int value = col[0];
82 for (int entry : col) {
83 if (entry != value) {
84 return false;
85 }
86 }
87 }
88 return true;
89 }
90
91 @Override
92 protected Integer getInitValue() {
93 return QuantizeOption.RECOMMENDED_NAN_INDICATOR;
94 }
95 }