Class AsciiTableHDU

java.lang.Object

nom.tam.fits.BasicHDU<AsciiTable>

nom.tam.fits.TableHDU<AsciiTable>

nom.tam.fits.AsciiTableHDU

All Implemented Interfaces:

FitsElement

public class AsciiTableHDU
extends TableHDU<AsciiTable>

ASCII table header/data unit. ASCII table HDUs were desgined for human readability, e.g. on a console, without any special tools. However, they are far less flexible or compact than BinaryTableHDU. As such, users are generally discouraged from using this type of HDU to encapsulate FITS table data. FitsFactory.setUseAsciiTables(boolean) can be toggled to adjust whether Fits.makeHDU(Object) or similar methods should construct ASCII tables when possible. (The default setting is to produce binary tables always.)

See Also:

• AsciiTable
• BinaryTableHDU

Field Summary

Fields inherited from class BasicHDU

BITPIX_BYTE, BITPIX_DOUBLE, BITPIX_FLOAT, BITPIX_INT, BITPIX_LONG, BITPIX_SHORT

Modifier and Type	Field	Description
static final int	BITPIX_BYTE	Deprecated. Use Bitpix.VALUE_FOR_BYTE instead.
static final int	BITPIX_DOUBLE	Deprecated. Use Bitpix.VALUE_FOR_DOUBLE instead.
static final int	BITPIX_FLOAT	Deprecated. Use Bitpix.VALUE_FOR_FLOAT instead.
static final int	BITPIX_INT	Deprecated. Use Bitpix.VALUE_FOR_INT instead.
static final int	BITPIX_LONG	Deprecated. Use Bitpix.VALUE_FOR_LONG instead.
static final int	BITPIX_SHORT	Deprecated. Use Bitpix.VALUE_FOR_SHORT instead.

Constructor Summary

Constructors

Constructor	Description
AsciiTableHDU(Header h, AsciiTable d)	Deprecated. (for internal use) Its visibility should be reduced to package level in the future.

Method Summary

Modifier and Type	Method	Description
int	addColumn(Object newCol)	Add a column to the table without any associated header information.
static AsciiTable	encapsulate(Object o)	Deprecated. (for internal use) Use AsciiTable.fromColumnMajor(Object[]) instead.
void	info(PrintStream stream)	Print out some information about this HDU.
static boolean	isData(Object o)	Deprecated. (for internal use) Will reduce visibility in the future
static boolean	isHeader(Header header)	Deprecated. (for internal use) Will reduce visibility in the future
boolean	isNull(int row, int col)	Checks if a table entry is null
static AsciiTable	manufactureData(Header hdr)	Deprecated. (for internal use) Will reduce visibility in the future
static Header	manufactureHeader(Data d)	Deprecated. (for internal use) Will reduce visibility in the future
void	setColumnName(int index, String name, String comment)	Sets the name / ID of a specific column in this table.
void	setNull(int row, int col, boolean flag)	Mark an entry as null.
void	setNullString(int col, String newNull)	Set the null string for a column.

Methods inherited from class TableHDU

addRow, deleteColumnsIndexOne, deleteColumnsIndexOne, deleteColumnsIndexZero, deleteColumnsIndexZero, deleteRows, deleteRows, findColumn, getColumn, getColumn, getColumnFormat, getColumnMeta, getColumnMeta, getColumnName, getColumns, getDefaultColumnName, getElement, getNCols, getNRows, getRow, setColumn, setColumn, setColumnMeta, setColumnMeta, setColumnMeta, setColumnMeta, setColumnMeta, setColumnMeta, setColumnMeta, setCurrentColumn, setCurrentColumn, setElement, setRow

Modifier and Type	Method	Description
int	addRow(Object[] newRows)	Add a row to the end of the table.
void	deleteColumnsIndexOne(int column, int len)	Deprecated. It is not entirely foolproof for keeping the header in sync -- it is better to use TableData.deleteColumns(int, int) to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries.
void	deleteColumnsIndexOne(int column, int len, String[] fields)	Deprecated. It is not entirely foolproof for keeping the header in sync -- it is better to use TableData.deleteColumns(int, int) to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries.
void	deleteColumnsIndexZero(int column, int len)	Deprecated. It is not entirely foolproof for keeping the header in sync -- it is better to use TableData.deleteColumns(int, int) to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries.
void	deleteColumnsIndexZero(int column, int len, IFitsHeader[] fields)	Deprecated. It is not entirely foolproof for keeping the header in sync -- it is better to use TableData.deleteColumns(int, int) to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries.
void	deleteRows(int row)	Deprecated. It is not entirely foolproof for keeping the header in sync -- it is better to use TableData.deleteRows(int, int) to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries.
void	deleteRows(int firstRow, int nRow)	Deprecated. It is not entirely foolproof for keeping the header in sync -- it is better to use TableData.deleteRows(int, int) to edit tables before wrapping them in an HDU and editing the header as necessary to incorporate custom entries.
int	findColumn(String colName)	Find the 0-based column index corresponding to a particular column name.
Object	getColumn(int col)	Returns the data for a particular column in as an array of elements.
Object	getColumn(String colName)	Returns the data for a particular column in as an array of elements.
String	getColumnFormat(int index0)	Get the FITS type of a column in the table.
String	getColumnMeta(int index0, String keyBase)	Convenience method for getting column metadata, as a string.
String	getColumnMeta(int index0, IFitsHeader keyBase)	Convenience method for getting column metadata, as a string.
String	getColumnName(int index0)	Gets the name of a column in the table, as it appears in this HDU's header.
Object[]	getColumns()	Returns the data for all columns in as an array.
static String	getDefaultColumnName(int col)	Returns the default name for a columns with the specified index, to use if no column name was explicitly defined
Object	getElement(int row, int col)	Returns a specific element from this table
int	getNCols()	Get the number of columns for this table
int	getNRows()	Get the number of rows for this table
Object[]	getRow(int row)	Returns a specific row from this table
void	setColumn(int col, Object newCol)	Update a column within a table.
void	setColumn(String colName, Object newCol)	Update a column within a table.
void	setColumnMeta(int index0, String key, Boolean value, String comment, boolean after)	Specify column metadata for a given column in a way that allows all of the column metadata for a given column to be organized together.
void	setColumnMeta(int index0, String key, Number value, int precision, String comment, boolean after)	Specify column metadata for a given column in a way that allows all of the column metadata for a given column to be organized together.
void	setColumnMeta(int index0, String key, Number value, String comment, boolean after)	Specify column metadata for a given column in a way that allows all of the column metadata for a given column to be organized together.
void	setColumnMeta(int index0, String key, String value, String comment)	Specify column metadata for a given column in a way that allows all of the column metadata for a given column to be organized together.
void	setColumnMeta(int index0, String key, String value, String comment, boolean after)	Deprecated. use TableHDU.setColumnMeta(int, IFitsHeader, String, String, boolean)
void	setColumnMeta(int index0, IFitsHeader key, Number value, String comment, boolean after)	Specify column metadata for a given column in a way that allows all of the column metadata for a given column to be organized together.
void	setColumnMeta(int index0, IFitsHeader key, String value, String comment, boolean after)	Specify column metadata for a given column in a way that allows all of the column metadata for a given column to be organized together.
void	setCurrentColumn(int col)	Deprecated. (for internal use) Will be removed int the future (no longer used).
void	setCurrentColumn(int col0, boolean after)	Deprecated. (for internal use) Will have private access in the future.
void	setElement(int row, int col, Object element)	Update a single element within the table.
void	setRow(int row, Object[] newRow)	Update a row within a table.

Methods inherited from class BasicHDU

addValue, addValue, addValue, addValue, addValue, addValue, addValue, addValue, calcChecksum, card, getAuthor, getAxes, getBitpix, getBitPix, getBlankValue, getBScale, getBUnit, getBZero, getCreationDate, getData, getDummyHDU, getEpoch, getEquinox, getFileOffset, getGroupCount, getHeader, getInstrument, getKernel, getMaximumValue, getMinimumValue, getObject, getObservationDate, getObserver, getOrigin, getParameterCount, getReference, getSize, getStoredChecksum, getStoredDatasum, getTelescope, getTrimmedString, getTrimmedString, read, reset, rewrite, rewriteable, setChecksum, verifyDataIntegrity, verifyIntegrity, write

Modifier and Type	Method	Description
void	addValue(String key, boolean val, String comment)	Add information to the header.
void	addValue(String key, double val, String comment)	Add information to the header.
void	addValue(String key, int val, String comment)	Add information to the header.
void	addValue(String key, String val, String comment)	Add information to the header.
void	addValue(IFitsHeader key, boolean val)	Add information to the header.
void	addValue(IFitsHeader key, double val)	Add information to the header.
void	addValue(IFitsHeader key, int val)	Add information to the header.
void	addValue(IFitsHeader key, String val)	Add information to the header.
long	calcChecksum()	Deprecated. Use BasicHDU.verifyIntegrity() instead when appropriate.
HeaderCardBuilder	card(IFitsHeader key)	Returns a header card builder for filling the header cards using the builder pattern.
String	getAuthor()	Return the name of the person who compiled the information in the data associated with this header.
int[]	getAxes()	In FITS files the index represented by NAXIS1 is the index that changes most rapidly.
Bitpix	getBitpix()	Return the Bitpix enum type for this HDU.
final int	getBitPix()	Deprecated. (for internal use) Will reduce visibility or remove entirely in the future.
long	getBlankValue()	Deprecated. This is only applicable to ImageHDU or RandomGroupsHDU with integer type data and not for other HDU or data types.
double	getBScale()	Deprecated. This is only applicable to ImageHDU or RandomGroupsHDU with integer type data and not for other HDU or data types.
String	getBUnit()	Deprecated. This is only applicable to ImageHDU or RandomGroupsHDU and not for other HDU or data types.
double	getBZero()	Deprecated. This is only applicable to ImageHDU or RandomGroupsHDU with integer type data and not for other HDU or data types.
Date	getCreationDate()	Get the FITS file creation date as a Date object.
AsciiTable	getData()	Returns the data component of this HDU.
static NullDataHDU	getDummyHDU()	Deprecated. Use NullDataHDU instead.
double	getEpoch()	Deprecated. use BasicHDU.getEquinox() instead
double	getEquinox()	Get the equinox in years for the celestial coordinate system in which positions given in either the header or data are expressed.
long	getFileOffset()	Returns the byte offset at which this element starts ina file.
int	getGroupCount()	Deprecated. Should not be exposed outside of RandomGroupsHDU -- will reduce visibility in the future/
Header	getHeader()	Returns the FITS header component of this HDU
String	getInstrument()	Get the name of the instrument which was used to acquire the data in this FITS file.
final Object	getKernel()	Returns the underlying Java object (usually an array of some type) that stores the data internally.
double	getMaximumValue()	Return the minimum valid value in the array.
double	getMinimumValue()	Return the minimum valid value in the array.
String	getObject()	Get the name of the observed object in this FITS file.
Date	getObservationDate()	Get the FITS file observation date as a Date object.
String	getObserver()	Get the name of the person who acquired the data in this FITS file.
String	getOrigin()	Get the name of the organization which created this FITS file.
int	getParameterCount()	Deprecated. Should not be exposed outside of RandomGroupsHDU -- will reduce visibility in the future.
String	getReference()	Return the citation of a reference where the data associated with this header are published.
long	getSize()	Returns the size of this elements in the FITS representation.
long	getStoredChecksum()	Deprecated. Not very useful, since it has no meaning other than ensuring that the checksum of the HDU yields (int) -1 (that is 0xffffffff) after including this value for the CHECKSUM keyword in the header.
long	getStoredDatasum()	Returns the FITS checksum for the HDU's data that is stored in the header of this HDU under the DATASUM keyword.
String	getTelescope()	Get the name of the telescope which was used to acquire the data in this FITS file.
String	getTrimmedString(String keyword)	Deprecated. (for internal use) Will reduced visibility in the future.
String	getTrimmedString(IFitsHeader keyword)	Deprecated. (for internal use) Will reduced visibility in the future.
void	read(ArrayDataInput stream)	Read a FITS element from the input, starting at the current position.
boolean	reset()	Reset the input stream to point to the beginning of this element
void	rewrite()	Rewrite the contents of the element in place.
boolean	rewriteable()	Checks if we can write this element back to its source.
void	setChecksum()	Computes the checksums for this HDU and stores the CHECKSUM and DATASUM values in the header.
boolean	verifyDataIntegrity()	Checks that the HDUs data checksum is correct.
boolean	verifyIntegrity()	Checks the HDU's integrity, using the recorded CHECKSUM and/or DATASUM keywords if present.
void	write(ArrayDataOutput stream)	Writes the contents of the element to a data sink, adding padding as necessary if the element (such as a header or data segment) is expected to complete the FITS block of 2880 bytes.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AsciiTableHDU

@Deprecated
public AsciiTableHDU(Header h,
 AsciiTable d)

Deprecated.

(for internal use) Its visibility should be reduced to package level in the future.

Create an ASCII table header/data unit.

Parameters:

h - the template specifying the ASCII table.

d - the FITS data structure containing the table data.

Method Details

encapsulate

@Deprecated
public static AsciiTable encapsulate(Object o)
                              throws FitsException

Deprecated.

(for internal use) Use AsciiTable.fromColumnMajor(Object[]) instead. Will reduce visibility in the future

Parameters:

o - the array of object to create the ASCII table

Returns:

a ASCII table data structure from an array of objects representing the columns.

Throws:

FitsException - if the table could not be created.

isData

@Deprecated
public static boolean isData(Object o)

Deprecated.

(for internal use) Will reduce visibility in the future

Parameters:

o - object representing the data

Returns:

true if this data is usable as an ASCII table.

isHeader

@Deprecated
public static boolean isHeader(Header header)

Deprecated.

(for internal use) Will reduce visibility in the future

Check that this is a valid ascii table header.

Parameters:

header - to validate.

Returns:

true if this is an ascii table header.

manufactureData

@Deprecated
public static AsciiTable manufactureData(Header hdr)
                                  throws FitsException

Deprecated.

(for internal use) Will reduce visibility in the future

Prepares a data object into which the actual data can be read from an input subsequently or at a later time.

Parameters:

hdr - The FITS header that describes the data

Returns:

A data object that support reading content from a stream.

Throws:

FitsException - if the data could not be prepared to prescriotion.

manufactureHeader

@Deprecated
public static Header manufactureHeader(Data d)
                                throws FitsException

Deprecated.

(for internal use) Will reduce visibility in the future

Parameters:

d - data to create a header for

Returns:

a created header to match the input data.

Throws:

FitsException - if the header could not b e created

setColumnName

public void setColumnName(int index,
 String name,
 String comment)
                   throws IndexOutOfBoundsException,
HeaderCardException

Description copied from class: TableHDU

Sets the name / ID of a specific column in this table. Naming columns is generally a good idea so that people can figure out what sort of data actually appears in specific table columns.

Overrides:

setColumnName in class TableHDU<AsciiTable>

Parameters:

index - the 0-based column index

name - the name or ID we want to assing to the column

comment - Any additional comment we would like to store alongside in the FITS header. (The comment may be truncated or even ommitted, depending on space constraints in the FITS header.

Throws:

IndexOutOfBoundsException - if the table has no column matching the index

HeaderCardException - if there was a problem wil adding the associated descriptive FITS header keywords to this table's header.

See Also:

• TableHDU.getColumnName(int)
• TableHDU.getDefaultColumnName(int)

addColumn

public int addColumn(Object newCol)
              throws FitsException

Description copied from class: TableHDU

Add a column to the table without any associated header information.

Overrides:

addColumn in class TableHDU<AsciiTable>

Parameters:

newCol - the new column information. the newCol should be an Object[] where type of all of the constituents is identical. The length of data should match the other columns. Note: It is valid for data to be a 2 or higher dimensionality primitive array. In this case the column index is the first (in Java speak) index of the array. E.g., if called with int[30][20][10], the number of rows in the table should be 30 and this column will have elements which are 2-d integer arrays with TDIM = (10,20).

Returns:

the number of columns in the adapted table

Throws:

FitsException - if the operation failed

info

public void info(PrintStream stream)

Description copied from class: BasicHDU

Print out some information about this HDU.

Specified by:

info in class BasicHDU<AsciiTable>

Parameters:

stream - the printstream to write the info on

isNull

public boolean isNull(int row,
 int col)

Checks if a table entry is null

Parameters:

row - row index of the element

col - column index of the element

Returns:

true if the specified element is null

See Also:

• setNull(int, int, boolean)
• AsciiTable.isNull(int, int)

setNull

public void setNull(int row,
 int col,
 boolean flag)

Mark an entry as null.

Parameters:

row - row index of the element

col - column index of the element

flag - set to null or not

See Also:

• isNull(int, int)
• AsciiTable.setNull(int, int, boolean)

setNullString

public void setNullString(int col,
 String newNull)
                   throws IllegalArgumentException

Set the null string for a column.

Parameters:

col - the column index

newNull - the String representing null

Throws:

IllegalArgumentException - if the string argument contains characters that are not allowed in FITS headers. That is if it contains characters outside the range of 0x20 thru 0x7E.