1 package nom.tam.fits.compression.provider.param.rice;
2
3 import nom.tam.fits.Header;
4
5 /*
6 * #%L
7 * nom.tam FITS library
8 * %%
9 * Copyright (C) 1996 - 2024 nom-tam-fits
10 * %%
11 * This is free and unencumbered software released into the public domain.
12 *
13 * Anyone is free to copy, modify, publish, use, compile, sell, or
14 * distribute this software, either in source code form or as a compiled
15 * binary, for any purpose, commercial or non-commercial, and by any
16 * means.
17 *
18 * In jurisdictions that recognize copyright laws, the author or authors
19 * of this software dedicate any and all copyright interest in the
20 * software to the public domain. We make this dedication for the benefit
21 * of the public at large and to the detriment of our heirs and
22 * successors. We intend this dedication to be an overt act of
23 * relinquishment in perpetuity of all present and future rights to this
24 * software under copyright law.
25 *
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
29 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32 * OTHER DEALINGS IN THE SOFTWARE.
33 * #L%
34 */
35
36 import nom.tam.fits.HeaderCard;
37 import nom.tam.fits.HeaderCardException;
38 import nom.tam.fits.compression.algorithm.rice.RiceCompressOption;
39 import nom.tam.fits.compression.provider.param.base.CompressHeaderParameter;
40 import nom.tam.fits.header.Compression;
41
42 /**
43 * (<i>for internal use</i>) The block size value for the Rice compression as recorded in the FITS header.
44 */
45 public final class RiceBlockSizeParameter extends CompressHeaderParameter<RiceCompressOption> {
46
47 /**
48 * @deprecated (<i>for internal use</i>) the visibility of this constructor may be reduced to the package level in
49 * future releases.
50 */
51 @Deprecated
52 @SuppressWarnings("javadoc")
53 public RiceBlockSizeParameter(RiceCompressOption riceCompressOption) {
54 super(Compression.BLOCKSIZE, riceCompressOption);
55 }
56
57 @Override
58 public void getValueFromHeader(Header header) throws HeaderCardException {
59 HeaderCard value = super.findZVal(header);
60 if (value != null) {
61 getOption().setBlockSize(value.getValue(Integer.class, getOption().getBlockSize()));
62 } else {
63 getOption().setBlockSize(RiceCompressOption.DEFAULT_RICE_BLOCKSIZE);
64 }
65 }
66
67 @Override
68 public void setValueInHeader(Header header) throws HeaderCardException {
69 int zvalIndex = nextFreeZVal(header);
70 header.addValue(Compression.ZNAMEn.n(zvalIndex), getName());
71 header.addValue(Compression.ZVALn.n(zvalIndex), getOption().getBlockSize());
72 }
73 }