|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.fits.AbstractWideFits
public abstract class AbstractWideFits
Implementations of the WideFits interface. This class fills in the details of the general idea defined in WideFits. Static methods provide concrete implementations.
The Wide FITS convention is defined in the file (fits/src/docs/)wide-fits.txt
Field Summary | |
---|---|
static java.lang.String |
KEY_ICOL_CONTAINER
Index of container column hosting extended column data. |
static java.lang.String |
KEY_NCOL_EXT
Header key for extended column count - includes standard ones. |
Fields inherited from interface uk.ac.starlink.fits.WideFits |
---|
DEFAULT, MAX_NCOLSTD |
Constructor Summary | |
---|---|
protected |
AbstractWideFits(int icolContainer,
int extColMax,
java.lang.String implName)
Constructor. |
Method Summary | |
---|---|
void |
addContainerColumnHeader(nom.tam.fits.Header hdr,
long nbyteExt,
long nslice)
Adds the per-HDU header cards that describe the single container column (with index icolContainer) used to implement this convention in a BINTABLE HDU. |
void |
addExtensionHeader(nom.tam.fits.Header hdr,
int ncolExt)
Adds the per-HDU header cards that announce the operation of this convention in a BINTABLE HDU. |
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. |
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(HeaderCards cards,
int ncolStd)
Returns the total number of columns, including extended ones, described by a FITS header according to this convention. |
static void |
logWideRead(java.util.logging.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(java.util.logging.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. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface uk.ac.starlink.fits.WideFits |
---|
createExtendedHeader |
Field Detail |
---|
public static final java.lang.String KEY_ICOL_CONTAINER
public static final java.lang.String KEY_NCOL_EXT
Constructor Detail |
---|
protected AbstractWideFits(int icolContainer, int extColMax, java.lang.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 conventionimplName
- base name of this implementationMethod Detail |
---|
public int getContainerColumnIndex()
WideFits
Under normal circumstances, this returns 999 (WideFits.MAX_NCOLSTD
).
getContainerColumnIndex
in interface WideFits
public int getExtColumnMax()
WideFits
getExtColumnMax
in interface WideFits
public void addContainerColumnHeader(nom.tam.fits.Header hdr, long nbyteExt, long nslice)
WideFits
addContainerColumnHeader
in interface WideFits
hdr
- header to append tonbyteExt
- 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 void addExtensionHeader(nom.tam.fits.Header hdr, int ncolExt)
WideFits
addExtensionHeader
in interface WideFits
hdr
- header to append toncolExt
- total column count including extendedpublic int getExtendedColumnCount(HeaderCards cards, int ncolStd)
WideFits
getExtendedColumnCount
in interface WideFits
cards
- FITS headerncolStd
- number of 'standard' BINTABLE columns,
got from TFIELDS header
public java.lang.String toString()
toString
in class java.lang.Object
public 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 999
public static WideFits createHierarchWideFits(int icolContainer)
icolContainer
- 1-based index of container column
used for storing extended column data;
usually 999
public static void logWideWrite(java.util.logging.Logger logger, int nStdcol, int nAllcol)
logger
- loggernStdcol
- number of standard FITS columnsnAllcol
- total number of columns including extendedpublic static void logWideRead(java.util.logging.Logger logger, int nStdcol, int nAllcol)
logger
- loggernStdcol
- number of standard FITS columnsnAllcol
- total number of columns including extended
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |