public abstract class AbstractWideFits extends Object implements WideFits
The Wide FITS convention is defined in the file (fits/src/docs/)wide-fits.txt
| Modifier and Type | Field and Description |
|---|---|
static String |
KEY_ICOL_CONTAINER
Index of container column hosting extended column data.
|
static String |
KEY_NCOL_EXT
Header key for extended column count - includes standard ones.
|
DEFAULT, MAX_NCOLSTD| Modifier | Constructor and Description |
|---|---|
protected |
AbstractWideFits(int icolContainer,
int extColMax,
CardFactory cardFactory,
String implName)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
static WideFits |
createAlphaWideFits(int icolContainer)
Returns a WideFits instance that uses normal TFORMaaa headers
where aaa is a 3-digit base-26 integer (each digit is [A-Z]).
|
static WideFits |
createHierarchWideFits(int icolContainer)
Returns a WideFits instance that uses headers of the form
HIERARCH XT TFORMnnnnn, using the ESO HIERARCH convention.
|
CardImage[] |
getContainerColumnCards(long nbyteExt,
long nslice)
Returns an array of per-HDU header cards
that describe the single container column (with index icolContainer)
used to implement this convention in a BINTABLE HDU.
|
int |
getContainerColumnIndex()
Returns the index of the column used (if any) by this specification
for extended column data.
|
int |
getExtColumnMax()
Maximum extended number of columns that can be represented by
this convention.
|
int |
getExtendedColumnCount(FitsHeader hdr,
int ncolStd)
Returns the total number of columns, including extended ones,
described by a FITS header according to this convention.
|
CardImage[] |
getExtensionCards(int ncolExt)
Returns an array of per-HDU header cards that announce the operation
of this convention in a BINTABLE HDU.
|
static void |
logWideRead(Logger logger,
int nStdcol,
int nAllcol)
Utility method to write a log message indicating that this
convention is being used to read a FITS file.
|
static void |
logWideWrite(Logger logger,
int nStdcol,
int nAllcol)
Utility method to write a log message indicating that this
convention is being used to write a FITS file.
|
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcreateExtendedHeaderpublic static final String KEY_ICOL_CONTAINER
public static final String KEY_NCOL_EXT
protected AbstractWideFits(int icolContainer,
int extColMax,
CardFactory cardFactory,
String implName)
icolContainer - 1-based index of container column
used for storing extended column data;
usually 999extColMax - maximum number of extended columns
(including standard columns) that can be
represented by this conventioncardFactory - object which should be used to construct
header cards associated with this implementationimplName - base name of this implementationpublic int getContainerColumnIndex()
WideFitsUnder normal circumstances, this returns 999 (WideFits.MAX_NCOLSTD).
getContainerColumnIndex in interface WideFitspublic int getExtColumnMax()
WideFitsgetExtColumnMax in interface WideFitspublic CardImage[] getContainerColumnCards(long nbyteExt, long nslice)
WideFitsgetContainerColumnCards in interface WideFitsnbyteExt - number of bytes per row in container columnnslice - if >0 this will result in a TDIMnnn header
that gives a 2-element shape, with the supplied
value being the second element;
if you don't want TDIMnnn, use 0public CardImage[] getExtensionCards(int ncolExt)
WideFitsgetExtensionCards in interface WideFitsncolExt - total column count including extendedpublic int getExtendedColumnCount(FitsHeader hdr, int ncolStd)
WideFitsgetExtendedColumnCount in interface WideFitshdr - FITS headerncolStd - number of 'standard' BINTABLE columns,
got from TFIELDS headerpublic static WideFits createAlphaWideFits(int icolContainer)
Note: this implementation is a historical relic. It could be removed if its maintenance becomes problematic.
icolContainer - 1-based index of container column
used for storing extended column data;
usually 999public static WideFits createHierarchWideFits(int icolContainer)
icolContainer - 1-based index of container column
used for storing extended column data;
usually 999public static void logWideWrite(Logger logger, int nStdcol, int nAllcol)
logger - loggernStdcol - number of standard FITS columnsnAllcol - total number of columns including extendedpublic static void logWideRead(Logger logger, int nStdcol, int nAllcol)
logger - loggernStdcol - number of standard FITS columnsnAllcol - total number of columns including extendedCopyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.