nom.tam.fits
MavenTag List Report
The following document contains the listing of user tags found in the code. Below is the summary of the occurrences per tag.
| Tag Class | Total number of occurrences | Tag strings used by tag class |
|---|---|---|
| Deprecated API | 360 | @deprecated |
Each tag is detailed below:
Deprecated API
Number of occurrences found in the code: 360
| nom.tam.fits.AbstractTableData | Line |
|---|---|
| Serves no purpose really. It can be removed in the future, letting {@link AsciiTable} extend {@link Data} and implement {@link TableData} instead. | 38 |
| nom.tam.fits.AsciiTable | Line |
| (<i>for internal use</i>) Visibility may be reduced to the package level in the future. | 155 |
| Use {@link #setI10PreferInt(boolean)} instead prior to reading ASCII tables. | 180 |
| It is not entirely foolproof for keeping the header in sync -- it is better to (re)wrap tables in a new HDU and editing the header as necessary to incorporate custom entries. May be removed from the API in the future. | 985 |
| nom.tam.fits.AsciiTableHDU | Line |
| (<i>for internal use</i>) Its visibility should be reduced to package level in the future. | 75 |
| (<i>for internal use</i>) Use {@link AsciiTable#fromColumnMajor(Object[])} instead. Will reduce visibility in the future | 90 |
| (<i>for internal use</i>) Will reduce visibility in the future | 105 |
| (<i>for internal use</i>) Will reduce visibility in the future | 133 |
| (<i>for internal use</i>) Will reduce visibility in the future | 149 |
| (<i>for internal use</i>) Will reduce visibility in the future | 163 |
| nom.tam.fits.BasicHDU | Line |
| Use {@link Bitpix#VALUE_FOR_BYTE} instead. | 90 |
| Use {@link Bitpix#VALUE_FOR_SHORT} instead. | 96 |
| Use {@link Bitpix#VALUE_FOR_INT} instead. | 102 |
| Use {@link Bitpix#VALUE_FOR_LONG} instead. | 108 |
| Use {@link Bitpix#VALUE_FOR_FLOAT} instead. | 114 |
| Use {@link Bitpix#VALUE_FOR_DOUBLE} instead. | 120 |
| intended for internal use. Its visibility should be reduced to package level in the future. | 134 |
| Use {@link NullDataHDU} instead. Gets a HDU with no data, only header. | 152 |
| (<i>for internal use</i>) Will be removed as it serves no purpose. | 165 |
| (<i>for internal use</i>) Will be removed as it serves no purpose. | 176 |
| (<i>for internal use</i>) Will reduce visibility or remove entirely in the future. | 412 |
| This is only applicable to {@link ImageHDU} or {@link RandomGroupsHDU} and not for other HDU or data types. | 423 |
| This is only applicable to {@link ImageHDU} or {@link RandomGroupsHDU} with integer type data and not for other HDU or data types. | 436 |
| This is only applicable to {@link ImageHDU} or {@link RandomGroupsHDU} with integer type data and not for other HDU or data types. | 453 |
| This is only applicable to {@link ImageHDU} or {@link RandomGroupsHDU} with integer type data and not for other HDU or data types. | 468 |
| use {@link #getEquinox()} instead | 509 |
| Should not be exposed outside of {@link RandomGroupsHDU} -- will reduce visibility in the future/ | 539 |
| Not very useful, since it has no meaning other than ensuring that the checksum of the HDU yields <code>(int) -1</code> (that is <code>0xffffffff</code>) after including this value for the CHECKSUM keyword in the header. It will be removed in the future. Use {@link #verifyIntegrity()} instead when appropriate. | 552 |
| Use {@link #verifyIntegrity()} instead when appropriate. It's not particularly useful since integrity checking does not use or require knowledge of this sum. May be removed from future releases. | 687 |
| Should not be exposed outside of {@link RandomGroupsHDU} -- will reduce visibility in the future. | 817 |
| (<i>for internal use</i>) Will reduced visibility in the future. Use {@link Header#getStringValue(IFitsHeader)} or similar instead followed by {@link String#trim()} if necessary. | 863 |
| (<i>for internal use</i>) Will reduced visibility in the future. Use {@link Header#getStringValue(String)} or similar instead followed by {@link String#trim()} if necessary. | 884 |
| nom.tam.fits.BinaryTable | Line |
| Ambiguous, use {@link #getLegacyBase()} instead. It can be confusing since it is not clear if it refers to array element types used in FITS storage or on the java side when using the older array access, or if it refers to the class of entries in the main table, which may be heap pointers. It is also distinct from {@link #getElementClass()}, which returns the boxed type used by {@link BinaryTable#get(int, int)} or {@link BinaryTable#set(int, int, Object)}. | 730 |
| (<i>for internal use</i>) Use {@link #getEntryShape()} instead. Not useful to users since it returns the dimensions of the primitive storage types, which is not always the dimension of table entries on the Java side. | 797 |
| (<i>for internal use</i>) This method should be private in the future. | 989 |
| (<i>for internal use</i>) It may be reduced to private visibility in the future. Returns the number of bytes that each element occupies in its FITS serialized form in the stored row data. | 1000 |
| (<i>for internal use</i>) no longer used, and will be removed in the future. | 1298 |
| (<i>for internal use</i>) no longer in use. Will remove in the future. | 1307 |
| DO NOT USE -- it will be removed in the future. | 1388 |
| (<i>for internal use</i>) This constructor should only be called from a {@link Fits} object reading an input; visibility may be reduced to the package level in the future. | 1423 |
| The constructor is ambiguous, use {@link #fromRowMajor(Object[][])} instead. You can have a column-major array that has no scalar primitives which would also be an <code>Object[][]</code> and could be passed erroneously. | 1481 |
| The constructor is ambiguous, use {@link #fromColumnMajor(Object[])} instead. One could call this method with any row-major <code>Object[][]</code> table by mistake. | 1527 |
| (<i>for internal use</i>) It may become a private method in the future. | 1634 |
| (<i>for internal use</i>) It may be reduced to private visibility in the future. Parse the TDIMS value. If the TDIMS value cannot be deciphered a one-d array with the size given in arrsiz is returned. | 1645 |
| (<i>for internal use</i>) No longer used, will be removed in the future | 2063 |
| (<i>for internal use</i>) Ambiguous, use {@link ColumnDesc#getElementClass()} instead. Will remove in the future. | 2245 |
| (<i>for internal use</i>) Use {@link ColumnDesc#getEntryShape()} to access the shape of Java elements individually for columns instead. Not useful to users since it returns the dimensions of the primitive storage types, which is not always the dimension of elements on the Java side (notably for string entries). | 2332 |
| (<i>for internal use</i>) It may be private in the future. | 2346 |
| (<i>for internal use</i>) It may be reduced to private visibility in the future. | 2358 |
| (<i>for internal use</i>) Use {@link #getElement(int, int)} instead for low-level reading of tables in deferred mode. Not recommended for uses because it requires a deep understanding of how data (especially varialbe length columns) are represented in the FITS. Will reduce visibility to private in the future. | 2490 |
| (<i>for internal use</i>) Will reduce visibility in the future. | 2553 |
| (<i>for internal use</i>) Use {@link ColumnDesc#getElementCount()} instead. This one returns the number of elements in the FITS representation, not in the java representation. For example, for {@link String} entries, this returns the number of bytes stored, not the number of strings. Similarly, for complex values it returns the number of components not the number of values. | 2981 |
| (<i>for internal use</i>) Use {@link ColumnDesc#getElementClass()} instead. Not very useful to users since this returns the FITS primitive storage type for the data column. | 3014 |
| (<i>for internal use</i>) It may be reduced to private visibility in the future. Sets a column with the data already flattened. | 3392 |
| It is not entirely foolproof for keeping the header in sync -- it is better to (re)wrap tables in a new HDU after column deletions, and then edit the new header as necessary to incorporate custom entries. May be removed from the API in the future. | 3424 |
| (<i>for internal use</i>) Used Only by {@link nom.tam.image.compression.hdu.CompressedTableData} so it would make a better private method in there.. ` | 3921 |
| (<i>for internal use</i>) This method should have visibility reduced to private | 3929 |
| (<i>for internal use</i>) unused. | 3973 |
| (<i>for internal use</i>) Visibility should be reduced to protected. | 4027 |
| nom.tam.fits.BinaryTableHDU | Line |
| (<i>for internal use</i>) Its visibility should be reduced to package level in the future. | 71 |
| (<i>for internal use</i>) Use {@link BinaryTable#fromColumnMajor(Object[])} or {@link BinaryTable#fromRowMajor(Object[][])} instead. Will reduce visibility in the future. | 110 |
| (<i>for internal use</i>) Will reduce visibility in the future | 143 |
| (<i>for internal use</i>) Will reduce visibility in the future | 153 |
| (<i>for internal use</i>) Will reduce visibility in the future | 172 |
| (<i>for internal use</i>) Will reduce visibility in the future | 186 |
| (<i>for internal use</i>) Will reduce visibility in the future | 260 |
| nom.tam.fits.Data | Line |
| Will be private. Access via {@link #getFileOffset()} The starting location of the data when last read | 70 |
| Will be removed. Use {@link #getTrueSize()} instead. The size of the data when last read | 76 |
| Will be private. Use {@link #getRandomAccessInput()} instead. The input stream used. | 82 |
| nom.tam.fits.Fits | Line |
| Use {@link #Fits(File)} instead (compression is auto detected). Will remove in the future. | 235 |
| Use {@link #Fits(InputStream)} instead (compression is auto detected). Will remove in the future. | 360 |
| Use {@link #Fits(String)} instead (compression is auto detected). Will be a private method in the future. | 421 |
| Use {@link #Fits(URL)} instead (compression is auto detected). Will remove in the future. | 512 |
| Use <b>try-with-resources</b> constructs in Java 8+ instead. | 609 |
| use {@link #getNumberOfHDUs()} instead | 636 |
| Will be private in 2.0. Get a stream from the file and then use the stream initialization. | 669 |
| Use {@link #Fits(InputStream)} constructor instead. We will remove this method in the future. | 1131 |
| Use {@link BasicHDU#verifyIntegrity()} instead when appropriate. It's not particularly useful since integrity checking does not use or require knowledge of this sum. May be removed from future releases. | 1322 |
| This method is poorly conceived as we cannot really read FITS from just any <code>ArrayDataInput</code> but only those, which utilize {@link nom.tam.util.FitsDecoder} to convert Java types to FITS binary format, such as {@link FitsInputStream} or {@link FitsFile} (or else a wrapped <code>DataInputStream</code>). As such, this method is inherently unsafe as it can be used to parse FITS content iscorrectly. It will be removed from the public API in a future major release. Set the data stream to be used for future input. | 1375 |
| The meaning of size of ambiguous. Use {@link #getNumberOfHDUs()} instead. Note size() will read the input file/stream to the EOF before returning the number of HDUs which {@link #getNumberOfHDUs()} does not. If you wish to duplicate this behavior and ensure that the input has been exhausted before getting the number of HDUs then use the sequence: <code> read(); getNumberOfHDUs(); </code> | 1398 |
| This method is poorly conceived as we cannot really write FITS to just any <code>DataOutput</code> but only to specific {@link ArrayDataOutput}, which utilize {@link nom.tam.util.FitsEncoder} to convert Java types to FITS binary format, such as {@link FitsOutputStream} or {@link FitsFile} (or else a wrapped <code>DataOutputStream</code>). As such, this method is inherently unsafe as it can be used to create unreadable FITS files. It will be removed from a future major release. Use one of the more appropriate other <code>write()</code> methods instead. Writes the contents to an external file or stream. The file or stream remains open and it is up to the caller to close it as appropriate. | 1587 |
| use {@link FitsCheckSum#setChecksum(BasicHDU)} | 1651 |
| use {@link FitsCheckSum#checksum(byte[])} | 1665 |
| nom.tam.fits.FitsFactory | Line |
| The FITS standard is very explicit that assignment must be "= " (equals followed by a space). If we allow skipping the space, it will result in a non-standard FITS, and may render it unreadable for other tools. | 200 |
| (<i>for internal use</i>) Will reduce visibility in the future | 274 |
| The FITS standard is very explicit that assignment must be "= " (equals followed by a blank space). If we allow skipping the space, it will result in a non-standard FITS, that is likely to break compatibility with other tools. | 443 |
| (<i>for internal use</i>)/ Will reduce visibility in the future | 457 |
| Use {@link Fits#makeHDU(Object)} instead (this method may either be migrated to {@link Fits} entirely or else have visibility reduced to the package level). | 519 |
| (<i>duplicate method for internal use</i>) Same as {@link #hduFactory(Header, Data)}, and will be removed in the future. | 549 |
| Use {@link Fits#makeHDU(Object)} instead (will removed in the future. Duplicate of {@link #hduFactory(Object)} | 575 |
| The FITS standard is very explicit that assignment must be "= " (equals followed by a blank space). It is also very specific that string values must have their opening quote in byte 11 (counted from 1). If we allow skipping the space, we will violate both standards in a way that is likely to break compatibility with other tools. | 682 |
| nom.tam.fits.FitsUtil | Line |
| use {@link #addPadding(long)} instead. Calculates the amount of padding needed to complete the last FITS block at the specified current size. | 88 |
| (<i>for internal use</i>) No longer used internally, will be removed in the future. | 371 |
| (<i>for internal use</i>) Visibility may be reduced to the package level in the future. | 459 |
| (<i>for internal use</i>) No longer used internally, may be removed in the future. | 502 |
| (<i>for internal use</i>) Visibility may be reduced to package level in the future | 589 |
| (<i>for internal use</i>) Visibility may be reduced to private in the future | 608 |
| see Use {@link #padding(long)} instead. | 625 |
| This method wraps an {@link IOException} into a {@link FitsException} for no good reason really. A revision of the API could reduce the visibility of this method, and/or procees the underlying exception instead. | 657 |
| (<i>for internal use</i>) Visibility may be reduced to package level in the future. | 746 |
| nom.tam.fits.Header | Line |
| We will disable changing alignment in the future because it may violate the standard for 'fixed-format' header entries, and result in files that are unreadable by some other software. This constant will be obsoleted and removed. | 142 |
| We will disable changing alignment in the future because it may violate the standard for 'fixed-format' header entries, and result in files that are unreadable by some other software. This constant will be obsoleted and removed. | 151 |
| Not supported by the FITS standard, so do not use. It was included due to a misreading of the standard itself. We will remove this method in the future. | 726 |
| Use {@link #findCard(String)} or {@link #getCard(String)} instead. Find the card associated with a given key. | 955 |
| The FITS header does not support decimal types beyond those that can be represented by a 64-bit IEEE double-precision floating point value. | 974 |
| The FITS header does not support decimal types beyond those that can be represented by a 64-bit IEEE double-precision floating point value. | 988 |
| The FITS header does not support decimal types beyond those that can be represented by a 64-bit IEEE double-precision floating point value. | 1003 |
| The FITS header does not support decimal types beyond those that can be represented by a 64-bit IEEE double-precision floating point value. | 1017 |
| The FITS header does not support integer types beyond those that can be represented by a 64-bit integer. | 1036 |
| The FITS header does not support integer types beyond those that can be represented by a 64-bit integer. | 1050 |
| The FITS header does not support integer types beyond those that can be represented by a 64-bit integer. | 1065 |
| The FITS header does not support integer types beyond those that can be represented by a 64-bit integer. | 1079 |
| An iterator from {@link #iterator(int)} or {@link #iterator()} should be used for sequential access to the header. | 1193 |
| An iterator from {@link #iterator(int)} or {@link #iterator()} should be used for sequential access to the header. | 1415 |
| Not supported by the FITS standard, so do not use. It was included due to a misreading of the standard itself. | 1478 |
| Not supported by the FITS standard, so do not use. It was included due to a misreading of the standard itself. | 1497 |
| <i>for internal use</i>) It should be a private method in the future. Returns the original size of the header in the stream from which it was read. | 1575 |
| We should never use indexed access to the header. This function will be removed in 2.0. | 1826 |
| (<i>for internal use</i>) Normally we either want to write a Java object to FITS (in which case we have the dataand want to make a header for it), or we read some data from a FITS input. In either case, there is no benefit of exposing such a function as this to the user. | 1890 |
| Use the appropriate <code>Header</code> constructor instead. Will remove in a future releae. | 1951 |
| (<i>duplicate method</i>) Use {@link #deleteKey(String)} instead. | 2159 |
| Use {@link #ensureCardSpace(int)} with 1 as the argument instead. <p> Resets any prior preallocated header space, such as was explicitly set by {@link #ensureCardSpace(int)}, or when the header was read from a stream to ensure it remains rewritable, if possible. </p> <p> For headers read from a stream, this will affect {@link #rewriteable()}, so users should not call this method unless they do not intend to {@link #rewrite()} this header into the original FITS. </p> | 2178 |
| Use the safer {@link #setBitpix(Bitpix)} instead. | 2232 |
| (<i>for internall use</i>) Visibility will be reduced to the package level in the future. | 2252 |
| (<i>for internal use</i>) Visibility will be reduced to the package level in the future. | 2279 |
| (<i>for internal use</i>) Visibility will be reduced to the package level in the future. | 2296 |
| (<i>for internall use</i>) Visibility will be reduced to the package level in the future. | 2322 |
| (<i>for internall use</i>) Visibility will be reduced to the package level in the future. | 2352 |
| use {@link #getNumberOfCards()}. The units of the size of the header may be unclear. | 2371 |
| Use {@link NullDataHDU} instead. Create a header for a null image. | 2778 |
| Not recommended as it may violate the FITS standart for 'fixed-format' header entries, and make our FITS files unreadable by software that expects strict adherence to the standard. We will remove this feature in the future. | 3012 |
| nom.tam.fits.HeaderCard | Line |
| (<i>for internal use</i>) Its visibility may be reduced or may be removed entirely in the future. Card counting should be internal to {@link HeaderCard}. | 181 |
| Use {@link #HeaderCard(String, String, String)}, or {@link #createCommentStyleCard(String, String)} instead. | 429 |
| Use {@link #HeaderCard(String, String, String)}, or {@link #createCommentStyleCard(String, String)} instead. | 460 |
| Not supported by the FITS standard, so do not use. It was included due to a misreading of the standard itself. | 673 |
| Not supported by the FITS standard, so do not use. It was included due to a misreading of the standard itself. | 1053 |
| Not supported by the FITS standard, so do not use. It was included due to a misreading of the standard itself. | 1700 |
| Not supported by the FITS standard, so do not use. It was included due to a misreading of the standard itself. | 1720 |
| This was to be used internally only, without public visibility. It will become unexposed to users in a future release... | 1844 |
| nom.tam.fits.HeaderCardBuilder | Line |
| Use {@link #precision(int)} instead. | 200 |
| Use {@link #autoPrecision()} instead | 227 |
| nom.tam.fits.HeaderCardCountingArrayDataInput | Line |
| (<i>for internal use</i>) This class should not have public visibility. And really, the counting should be completely internalized by {@link HeaderCard}. Perhaps remove in a future major release. | 43 |
| (<i>for internal use</i>) Visibility will be reduced to the package level, or will be removed entirely. | 66 |
| (<i>for internal use</i>) Visibility will be reduced to the package level, or will be removed entirely. | 76 |
| (<i>for internal use</i>) Visibility will be reduced to the package level, or will be removed entirely. | 86 |
| (<i>for internal use</i>) Visibility will be reduced to the package level, or will be removed entirely. | 98 |
| (<i>for internal use</i>) Visibility will be reduced to the package level, or will be removed entirely. | 108 |
| (<i>for internal use</i>) Visibility will be reduced to the package level, or will be removed entirely. | 120 |
| (<i>for internal use</i>) Visibility will be reduced to the package level, or will be removed entirely. | 133 |
| nom.tam.fits.HeaderCommentsMap | Line |
| (<i>for internal use</i>) No longer needed | 44 |
| nom.tam.fits.HeaderOrder | Line |
| (<i>for internal use</i>) Visibility should be reduced to package level in the future | 52 |
| nom.tam.fits.ImageHDU | Line |
| (<i>for internal use</i>) Use {@link ImageData#from(Object)} instead. Will reduce visibility in the future | 69 |
| (<i>for internal use</i>) Will reduce visibility in the future | 86 |
| (<i>for internal use</i>) Will reduce visibility in the future | 105 |
| (<i>for internal use</i>) Will reduce visibility in the future | 130 |
| (<i>for internal use</i>) Will reduce visibility in the future | 146 |
| (<i>for internal use</i>) Its visibility should be reduced to package level in the future. | 169 |
| nom.tam.fits.RandomGroupsHDU | Line |
| (<i>for internal use</i>) Will reduce visibility in the future | 89 |
| (<i>for internal use</i>) Will reduce visibility in the future | 137 |
| (<i>for internal use</i>) Will reduce visibility in the future | 159 |
| (<i>for internal use</i>) Will reduce visibility in the future | 184 |
| (<i>for internal use</i>) Will reduce visibility in the future | 207 |
| (<i>for internal use</i>) Its visibility should be reduced to package level in the future. | 283 |
| nom.tam.fits.TableData | Line |
| It is not entirely foolproof for keeping the header in sync -- it is better to (re)wrap tables in a new HDU after column deletions, and then edit the new header as necessary to incorporate custom entries. May be removed from the API in the future. | 319 |
| nom.tam.fits.TableHDU | Line |
| intended for internal use. Its visibility should be reduced to package level in the future. | 70 |
| It is not entirely foolproof for keeping the header in sync -- it is better to use {@link TableData#deleteColumns(int, int)} to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries. May be removed from the API in the future. | 131 |
| It is not entirely foolproof for keeping the header in sync -- it is better to use {@link TableData#deleteColumns(int, int)} to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries. May be removed from the API in the future. | 149 |
| It is not entirely foolproof for keeping the header in sync -- it is better to use {@link TableData#deleteColumns(int, int)} to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries. May be removed from the API in the future. | 166 |
| It is not entirely foolproof for keeping the header in sync -- it is better to use {@link TableData#deleteColumns(int, int)} to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries. May be removed from the API in the future. | 184 |
| It is not entirely foolproof for keeping the header in sync -- it is better to use {@link TableData#deleteRows(int, int)} to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries. May be removed from the API in the future. | 236 |
| It is not entirely foolproof for keeping the header in sync -- it is better to use {@link TableData#deleteRows(int, int)} to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries. May be removed from the API in the future. | 255 |
| use {@link #setColumnMeta(int, IFitsHeader, String, String, boolean)} | 624 |
| (<i>for internal use</i>) Will be removed int the future (no longer used). | 664 |
| (<i>for internal use</i>) Will have private access in the future. | 678 |
| nom.tam.fits.UndefinedData | Line |
| (<i>for internal use</i>). Visibility will be reduced to the package level in the future. | 74 |
| (<i>for internal use</i>). Users should always construct known data types. Reduce visibility to the package level. | 105 |
| nom.tam.fits.UndefinedHDU | Line |
| (<i>for internal use</i>) Will reduce visibility in the future | 54 |
| (<i>for internal use</i>) Will reduce visibility in the future | 71 |
| (<i>for internal use</i>) Will reduce visibility in the future | 88 |
| (<i>for internal use</i>) Will reduce visibility in the future | 111 |
| (<i>for internal use</i>) Will reduce visibility in the future | 125 |
| (<i>for internal use</i>) Its visibility should be reduced to package level in the future. | 145 |
| nom.tam.fits.compress.BasicCompressProvider | Line |
| Use {@link ZCompressionProvider}. or the more generic {@link CompressionManager} with a preference toward using the system command if possible. instead. | 55 |
| nom.tam.fits.compress.CloseIS | Line |
| Needed only by deprecated compression classes. And it should not have visibility outside of this package anyway. | 54 |
| nom.tam.fits.compress.CompressionLibLoaderProtection | Line |
| (<i>for internal use</i>) The visibility of this class may be reduced to package level in the future. | 41 |
| nom.tam.fits.compress.ExternalBZip2CompressionProvider | Line |
| Use {@link ZCompressionProvider}, or the more generic {@link CompressionManager} with a preference toward using the system command if possible, instead. | 53 |
| nom.tam.fits.compression.algorithm.hcompress.HCompressorQuantizeOption | Line |
| (<i>for internal use</i>) This class should not be exposed to users. <p> Options to the HCompress compression algorithm when the compression includes quantization. When compressing tables and images using the HCompress 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. </p> | 37 |
| nom.tam.fits.compression.algorithm.quant.Quantize | Line |
| (<i>for internal use</i>) This class sohuld have visibility reduced to the package level | 40 |
| nom.tam.fits.compression.algorithm.quant.QuantizeOption | Line |
| use {@link #getBNull()} instead (duplicate method). Returns the integer value that represents missing data (<code>null</code>) in the quantized representation. | 257 |
| {@link #setBNull(Integer)} controls this feature automatically as needed. Sets whether we should expect the floating-point data to contain <code>null</code> values (normally NaNs). | 472 |
| It is strongly discouraged to treat 0.0 values as special. FITS only recognises NaN as a special floating-point value marking missing data. All other floating point values are considered valid measurements. | 499 |
| The use of null values other than <code>NaN</code> for floating-point data types is not standard in FITS. You should therefore avoid using this method to change it. Returns the floating-point value that indicates a <code>null</code> datum in the image before quantization is applied. Normally, the FITS standard is that NaN values indicate <code>null</code> values in floating-point images. While this class allows using other values also, they are not recommended since they are not supported by FITS in a standard way. | 605 |
| nom.tam.fits.compression.algorithm.rice.BitBuffer | Line |
| (<i>for internal use</i>) Its visibility may be reduced to the package level in the future. | 39 |
| nom.tam.fits.compression.algorithm.rice.RiceQuantizeCompressOption | Line |
| (<i>for internal use</i>) This class should not be exposed to users. <p> 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. </p> | 37 |
| nom.tam.fits.compression.provider.param.api.HeaderAccess | Line |
| This class serves no purpose since 1.19. Will remove in some future. Prior to 1.19 {@link Header} threw hard {@link HeaderCardException}, and this class was added so we can convert these into soft {@link IllegalArgumentException} instead. However, now that we demoted <code>HeaderCardException</code> to be soft exceptions itself, there is no reason to convert. It just adds confusion. | 47 |
| nom.tam.fits.compression.provider.param.api.HeaderCardAccess | Line |
| This class serves no purpose since 1.19. Will remove in some future. Prior to 1.19 {@link Header} threw hard {@link HeaderCardException}, and this class was added so we can convert these into soft {@link IllegalArgumentException} instead. However, now that we demoted <code>HeaderCardException</code> to be soft exceptions itself, there is no reason to convert. It just adds confusion. | 56 |
| nom.tam.fits.compression.provider.param.api.ICompressColumnParameter | Line |
| Provided for back compatibility only. Use {@link #getColumnData()} instead. | 62 |
| Provided for back compatibility only. Use {@link #getColumnData()} instead. | 72 |
| Provided for back compatibility only. Use {@link #setColumnData(Object, int)} instead. | 97 |
| Provided for back compatibility only. Use {@link #setValueInColumn(int)} instead. | 131 |
| nom.tam.fits.compression.provider.param.api.ICompressHeaderParameter | Line |
| Use {@link #getValueFromHeader(Header)} instead. | 47 |
| Use {@link #setValueInHeader(Header)} instead | 58 |
| nom.tam.fits.compression.provider.param.api.ICompressParameters | Line |
| Use {@link #getValuesFromHeader(Header)} instead. | 93 |
| Use {@link #initializeColumns(Header, BinaryTable, int)} instead | 108 |
| Old, inconsistent method naming. Use {@link #setValuesInColumn(int)} instead. set the option values, that are column based, into the columns at the specified index. | 150 |
| Use {@link #setValuesInHeader(Header)} instead | 167 |
| nom.tam.fits.compression.provider.param.api.IHeaderAccess | Line |
| This internal interface serves no purpose since 1.19. Will remove in some future. Prior to 1.19 {@link Header} threw hard {@link HeaderCardException}, and this class was added so we can convert these into soft {@link IllegalArgumentException} instead. However, now that we demoted <code>HeaderCardException</code> to be soft exceptions itself, there is no reason to convert. It just adds confusion. | 56 |
| Just add values to the header directly | 81 |
| Just add values to the header directly | 95 |
| Use {@link Header#getCard(IFitsHeader)} instead. | 109 |
| Use {@link Header#getCard(String)} instead. | 123 |
| nom.tam.fits.compression.provider.param.base.CompressHeaderParameter | Line |
| Use {@link #findZVal(Header)} instead. | 57 |
| Use {@link #nextFreeZVal(Header)} instead. | 64 |
| nom.tam.fits.compression.provider.param.quant.ZBlankColumnParameter | Line |
| (<i>for internal use</i>) the visibility of this constructor may be reduced to the package level in future releases. | 44 |
| nom.tam.fits.compression.provider.param.rice.RiceBlockSizeParameter | Line |
| (<i>for internal use</i>) the visibility of this constructor may be reduced to the package level in future releases. | 48 |
| nom.tam.fits.compression.provider.param.rice.RiceBytePixParameter | Line |
| (<i>for internal use</i>) the visibility of this constructor may be reduced to the package level in future releases. | 48 |
| nom.tam.fits.header.DataDescription | Line |
| Use {@link Standard#TDMAXn} instead. | 154 |
| Use {@link Standard#TDMINn} instead. | 163 |
| Use {@link Standard#TLMAXn} instead. | 180 |
| Use {@link Standard#TLMINn} instead. | 191 |
| nom.tam.fits.header.DateTime | Line |
| Deprecated by the FITS standard, use {@link #TIMESYS_TAI} instead. | 313 |
| Greenwich Mean time (GMT) timescale value; deprecated by the FITS standard, use {@link #TIMESYS_UTC} instead. | 323 |
| nom.tam.fits.header.FitsHeaderImpl | Line |
| Use the more intuitively named {@link FitsKey} class instead. This class is provided for compatibility with prior releases. | 39 |
| nom.tam.fits.header.GenericKey | Line |
| This class duplicates functionality that is available in {@link FitsKey}, {@link Standard}, ans/or {@link IFitsHeader}. | 42 |
| Use {@link FitsKey#FitsKey(String, VALUE, String)} instead. | 56 |
| (<i>for internal use</i>) Creates a array of generic FITS header keys. The resulting keys have no HDU assignment or value type restrictions, not default comments. As such they may be used for accessing existing keys by the specified names, more so than for adding new values. | 67 |
| Use {@link IFitsHeader#extractIndices(String)} instead. | 95 |
| Use {@link Standard#match(String)} instead. | 123 |
| nom.tam.fits.header.IFitsHeader | Line |
| Use {@link #ANY} instead. | 69 |
| nom.tam.fits.header.NonStandard | Line |
| The CONTINUE key is now part of the FITS 4.0 standard, so use {@link Standard#CONTINUE} instead. | 49 |
| Part of the FITS standard, use {@link Standard#INHERIT} instead. | 79 |
| nom.tam.fits.header.ObservationDurationDescription | Line |
| Part of the FITS standard, use {@link DateTime#DATE_END} instead | 57 |
| Part of the FITS standard, use {@link DateTime#TELAPSE} instead. | 103 |
| nom.tam.fits.header.Standard | Line |
| no blocksize other that 2880 may be used. | 93 |
| Deprecated by the FITS standard in favor of {@link #EQUINOX}. | 226 |
| Deprecated in the current FITS satndard, use {@link #RADESYS} instead. | 389 |
| Deprecated in the current FITS standard, use {@link #RESTFRQ} instead. | 405 |
| (<i>for internal use</i>) Using {@link nom.tam.fits.HeaderCard#setComment(String)} after creating a header card with this keyword provides a more transparent way of setting context-specific comments. This convoluted approach is no longer supported and will be removed in the future. | 660 |
| (<i>)for internal use</i>) | 680 |
| (<i>)for internal use</i>) | 701 |
| nom.tam.fits.header.StandardCommentReplacement | Line |
| (<i>for internal use</i>) Visibility may be reduced to package level in the future. | 39 |
| nom.tam.fits.header.WCS | Line |
| Deprecated in the current FITS standard, use {@link #RADESYSa} instead. | 71 |
| Deprecated in the current FITS standard, use {@link #EQUINOXa} instead. | 95 |
| Deprecated in the current FITS standard, use {@link #RESTFRQa} instead. | 186 |
| The FITS standard deprecated this keyword. Use {@link WCS#nnPCna} and {@link WCS#nnCDna}instead. [deg] The coordinate axis rotation in the physical unit of the axis (if defined) for array entries in this column (trailing index). The number of coordinate axes (leading index) defined this way should match the dimensionality of the array elements in the column. | 524 |
| The FITS standard deprecated this keyword. Use {@link WCS#TPCn_na} and {@link WCS#TCDn_na}instead. [deg] The coordinate axis rotation in the physical unit of the axis (if defined) for the (1D) pixel lists in this column (trailing index). | 784 |
| nom.tam.fits.header.extra.CXCStclSharedExt | Line |
| These are available both in the {@link CXCExt} and {@link STScIExt} enums. This class may be removed in the future. | 44 |
| nom.tam.fits.header.extra.MaxImDLExt | Line |
| Not part of the current MaxIm DL specification | 432 |
| Not part of the current MaxIm DL specification | 439 |
| Not part of the current MaxIm DL specification | 446 |
| Not part of the current MaxIm DL specification | 453 |
| Not part of the current MaxIm DL specification | 460 |
| Not part of the current MaxIm DL specification | 467 |
| Not part of the current MaxIm DL specification | 474 |
| Not part of the current MaxIm DL specification | 481 |
| nom.tam.fits.header.extra.STScIExt | Line |
| In truth this is an illegal FITS keyword, as the character '/' is not allowed in standard FITS keywords. If possible, avoid using it since it may result in FITS that is not readable by some software. | 103 |
| Use the standard {@link DateTime#MJD_OBS} instead. | 135 |
| Use the standard {@link DateTime#MJDREF} instead. | 140 |
| Use the standard {@link WCS#TCDLTn} instead. | 215 |
| Use the standard {@link WCS#TCRPXn} instead. | 220 |
| Use the standard {@link WCS#TCRVLn} instead. | 225 |
| Use the standard {@link WCS#TCTYPn} instead | 231 |
| nom.tam.fits.header.hierarch.BlanksDotHierarchKeyFormatter | Line |
| Non-standard HIERARCH keyword formatter that separates hierarchical keyword component by multiple while spaces. Otherwise, it is similar to {@link StandardIHierarchKeyFormatter}. Its use over the more standard formatter is discouraged. | 41 |
| nom.tam.fits.utilities.FitsCheckSum | Line |
| Use {@link BasicHDU#verifyIntegrity()} instead. | 277 |
| Use {@link BasicHDU#verifyIntegrity()} instead. | 301 |
| Use {@link BasicHDU#verifyIntegrity()} instead to verify checksums. | 332 |
| Use {@link #encode(long, boolean)} instead. | 381 |
| Not foolproof, because of the carry over handling in checksums, some additionas are not reversible. E.g. 0xffffffff + 0xffffffff = 0xffffffff, but 0xffffffff - 0xffffffff = 0; | 542 |
| Not very useful, since it has no meaning other than ensuring that the checksum of the HDU yields <code>(int) -1</code> (that is <code>0xffffffff</code>) after including this value for the CHECKSUM keyword in the header. It will be removed in the future. | 652 |
| nom.tam.fits.utilities.FitsLineAppender | Line |
| (<i>for internal use</i>) Replaced by the package-level <code>nom.tam.fits.HeaderCardFormatter</code>. | 49 |
| nom.tam.fits.utilities.FitsSubString | Line |
| (<i>for internal use</i>) Was used by {@link FitsLineAppender} only. | 40 |
| nom.tam.image.compression.bintable.BinaryTableTile | Line |
| (<i> for internal use</i>) No longer used. | 93 |
| nom.tam.image.compression.bintable.BinaryTableTileCompressor | Line |
| (<i>for internal use</i>) Its visibility will be reduced in the future, not to mention that it should take a BinaryTable as its argument with heap and all. It cannot be used for compressing binary tables with variable-length columns. | 69 |
| nom.tam.image.compression.bintable.BinaryTableTileDecompressor | Line |
| (<i>for internal use</i>) The visibility will be reduced in the future, not to mention that it should take a binary table as its argument, with heap and all. It cannot be used for decompressing binary tables with variable-length columns. | 61 |
| nom.tam.image.compression.hdu.CompressedImageHDU | Line |
| (<i>for internal use</i>) Will reduce visibility in the future | 198 |
| (<i>for internal use</i>) Will reduce visibility in the future | 218 |
| (<i>for internal use</i>) There is no reason why this should be exposed to users. Use {@link #asImageHDU()} instead. Future release may restrict the visibility to private. | 455 |
| nom.tam.image.compression.hdu.CompressedTableData | Line |
| (<i>for internal use</i>) This should only be called by {@link CompressedTableHDU}, and its visibility will be reduced accordingly in the future, not to mention that it should take a BinaryTable as its argument. | 150 |
| nom.tam.image.compression.hdu.CompressedTableHDU | Line |
| (<i>for internal use</i>) Will reduce visibility in the future | 220 |
| (<i>for internal use</i>) Will reduce visibility in the future | 232 |
| nom.tam.image.compression.tile.mask.AbstractNullPixelMask | Line |
| (<i>for internal use</i>) Visibility may be reduced to package level in the future. | 96 |
| nom.tam.image.tile.operation.AbstractTiledImageOperation | Line |
| (<i>for internal use</i>) This constructor should have protected visibility. | 70 |
| nom.tam.image.tile.operation.buffer.TileBufferFactory | Line |
| for internal use only | 46 |
| nom.tam.image.tile.operation.buffer.TileBufferRowBased | Line |
| Use {@link TileBufferFactory} instead to construct and access via {@link TileBuffer} interface. Its visiv=bility should be reduced to the package level in the future. | 44 |
| nom.tam.util.ArrayDataInput | Line |
| Use {@link #readLArray(Object)} instead. | 317 |
| This call is handled by {@link #skipAllBytes(long)}, without the need for a separate implementation. Skips a number of bytes from the input. See {@link #skipAllBytes(long)}. | 447 |
| nom.tam.util.ArrayFuncs | Line |
| Use {@link FitsEncoder#computeSize(Object)} instead. | 119 |
| Use {@link FitsEncoder#computeSize(Object)} instead. | 132 |
| (<i>for internal use</i>) | 204 |
| May silently underestimate size if number is > 2 G. | 517 |
| Use the more aptly named {@link #countElements(Object)} instead. | 546 |
| nom.tam.util.AsciiFuncs | Line |
| Use {@link Character#isWhitespace(char)} instead. | 92 |
| nom.tam.util.BufferDecoder | Line |
| Use {@link FitsDecoder} instead which provides a similar function but in a more consistent way and with a less misleading name. This is a rusty rail implementation for of an older abandoned class only, unsafe for general use. For reading non-FITS encoding you may also use {@link InputDecoder} as a base for implementing efficient custom decoding of binary inputs in general. | 38 |
| No longer used internally, kept only for back-compatibility since it used to be a needed abstract method. It's safest if you never override or call this method from your code! | 102 |
| No longer used internally, kept only for back-compatibility since it used to be a needed abstract method. | 121 |
| nom.tam.util.BufferEncoder | Line |
| Use {@link FitsEncoder} instead which provides a similar function but in a more consistent way and with a less misleading name. This is a rusty rail implementation for of an older abandoned class only, unsafe for general use. For writing non-FITS encoding you may also use {@link OutputEncoder} as a base for implementing efficient custom encoding of binary outputs in general. | 37 |
| No longer used internally, kept only for back-compatibility since it used to be a needed abstract method. It's safest if you never override or call this method from your code! | 93 |
| nom.tam.util.BufferPointer | Line |
| (<i>for internal use</i>) It is a rusty-rail compatibility implementation only, unsafe for general use. No longer used within the FITS package itself. If you do attempt to use it with the deprecated APIs, beware that no data will be filled into the buffer of this object ever by the library, although its length and position fields may be updated to pretend as if the buffer were always hall full / half available... | 37 |
| Rusty rail implementation only. | 67 |
| Rusty rail implementation only. | 77 |
| Rusty rail implementation only. | 92 |
| nom.tam.util.BufferedDataInputStream | Line |
| Use {@link FitsInputStream} instead which provides the same functionality with a less misleading name, or else use {@link ArrayInputStream} as a base for a more generic implementation for any (non-FITS) encoding. | 37 |
| nom.tam.util.BufferedDataOutputStream | Line |
| Use {@link FitsOutputStream}, which provides the exact same functionality but with a less misleading name, or else use {@link ArrayOutputStream} as a base for an implementation with any (non-FITS) encoding. | 39 |
| No longer used internally, but kept for back compatibility (and it does exactly nothing) | 66 |
| nom.tam.util.BufferedFile | Line |
| Use {@link FitsFile} instead, which replaces the old <code>BufferedFile</code> with a less misleading name, or else {@link ArrayDataFile}, which provides a base for a more more generic implementation for efficient reading/writing arrays using any (non-FITS) encoding. | 38 |
| nom.tam.util.ByteFormatter | Line |
| This class should not be exposed in the public API and is intended for internal use only in ASCII tables. Also, it may have overlapping functionality with other classes, which should probably be eliminated for simplicity's sake (and thus less chance of nasty bugs). | 51 |
| nom.tam.util.ByteParser | Line |
| This class should not be exposed in the public API and is intended for internal use only in ASCII tables. Also, it may have overlapping functionality with other classes, which should probably be eliminated for simplicity's sake (and thus less chance of nasty bugs). | 52 |
| nom.tam.util.ColumnTable | Line |
| Use {@link #getElementClass(int)} instead. This method may be removed in the future. | 592 |
| (<i>for internal use</i>) No longer used, will be removed in the future. | 682 |
| Use {@link #getElementSize(int)} instead. This method may be removed in the future. | 732 |
| Use {@link #getTypeChar(int)} instead. This method may be removed in the future. | 762 |
| (<i>for internal use</i>) No longer used, will be removed in the future. We used the extra state to carry properties of an enclosing class in this enclosed object, so we could inherit those to new enclosing class instances. This is bad practie. If one needs data from the enclosing object, it should be handled by passing the enclsing object, and not this enclosed table. | 890 |
| nom.tam.util.Cursor | Line |
| Use {@link #add(Object)} instead | 50 |
| nom.tam.util.FitsDecoder | Line |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 116 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 130 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 148 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 165 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 178 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 196 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 210 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 225 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 240 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 255 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 270 |
| nom.tam.util.FitsEncoder | Line |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 100 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 113 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 306 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 319 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 333 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 347 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally by this library only. | 361 |
| (<i>for internal use</i>) Low-level reading/writing should be handled internally as arrays by this library only. | 375 |
| nom.tam.util.FitsInputStream | Line |
| use {@link #readLArray(Object)} instead | 213 |
| nom.tam.util.FitsOutputStream | Line |
| use {@link #writeArray(Object)} instead | 207 |
| nom.tam.util.SafeClose | Line |
| Use <b>try-with-resources</b> constructs of Java 8+ instead. | 40 |
| nom.tam.util.array.MultiArrayCopyFactory | Line |
| (<i>for internal use</i>) use {@link MultiArrayCopier} instead. Make copies of multi-dimensional arrays. | 41 |
| for internal use only. This ought to be private. | 563 |
| nom.tam.util.array.MultiArrayPointer | Line |
| (<i>)for internal use</i>) Visibility may be reduced to the package level in the future. A multi-dimensional array index. Used only by {@link MultiArrayCopier} and {@link MultiArrayIterator}. | 37 |
| (<i>)for internal use</i>) Visibility may be reduced to private. | 61 |
| (<i>)for internal use</i>) Visibility may be reduced to private. | 138 |
| nom.tam.util.type.ElementType | Line |
| (<i>for internal use</i>) It's visibility may be reduced to the package level in the future. | 64 |
| Use {@link #isVariableSize()} instead. | 244 |
| nom.tam.util.type.PrimitiveType | Line |
| Use {@link ElementType} instead. | 37 |
| nom.tam.util.type.PrimitiveTypeBase | Line |
| Use {@link ElementType} instead. | 37 |
| nom.tam.util.type.PrimitiveTypeHandler | Line |
| Use equivalent static methods of {@link ElementType} instead. | 37 |
| Use {@link ElementType#forDataID(char)} instead. | 43 |
| Use {@link ElementType#forClass(Class)} instead. | 55 |
| Use {@link ElementType#forBitpix(int)} instead. | 69 |
| Use {@link ElementType#forNearestBitpix(int)} instead. | 81 |
| nom.tam.util.type.PrimitiveTypes | Line |
| Use identical static fields of {@link ElementType} instead. | 43 |
| Use {@link ElementType#BOOLEAN} instead | 48 |
| Use {@link ElementType#BYTE} instead | 52 |
| Use {@link ElementType#CHAR} instead | 56 |
| Use {@link ElementType#DOUBLE} instead | 60 |
| Use {@link ElementType#FLOAT} instead | 64 |
| Use {@link ElementType#INT} instead | 68 |
| Use {@link ElementType#LONG} instead | 72 |
| Use {@link ElementType#SHORT} instead | 76 |
| Use {@link ElementType#STRING} instead | 80 |
| Use {@link ElementType#UNKNOWN} instead | 84 |