Package nom.tam.fits

Class RandomGroupsData

java.lang.Object

nom.tam.fits.Data

nom.tam.fits.RandomGroupsData

All Implemented Interfaces:

FitsElement

public class RandomGroupsData
extends Data

This class instantiates FITS Random Groups data. Random groups are instantiated as a two-dimensional array of objects. The first dimension of the array is the number of groups. The second dimension is 2. The first object in every row is a one dimensional parameter array. The second element is the n-dimensional data array.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Object[][]	dataArray

Fields inherited from class nom.tam.fits.Data

dataSize, fileOffset, input

Constructor Summary

Constructors

Constructor	Description
RandomGroupsData()	Create the equivalent of a null data element.
RandomGroupsData(java.lang.Object[][] x)	Create a RandomGroupsData object using the specified object to initialize the data array.

Method Summary

Modifier and Type	Method	Description
protected void	fillHeader(Header h)	Modify a header to point to this data, this differs per subclass, they all need oder provided different informations to the header.
java.lang.Object	getData()
protected long	getTrueSize()	Get the size of the actual data element.
void	read(ArrayDataInput str)	Read the RandomGroupsData
void	write(ArrayDataOutput str)	Write the RandomGroupsData

Methods inherited from class nom.tam.fits.Data

getFileOffset, getKernel, getSize, reset, rewrite, rewriteable, setFileOffset

Methods inherited from class java.lang.Object

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

Field Detail

dataArray

private final java.lang.Object[][] dataArray

Constructor Detail

RandomGroupsData

public RandomGroupsData()

Create the equivalent of a null data element.

RandomGroupsData

public RandomGroupsData(java.lang.Object[][] x)

Create a RandomGroupsData object using the specified object to initialize the data array.

Parameters:

x - The initial data array. This should a two-d array of objects as described above.

Method Detail

fillHeader

protected void fillHeader(Header h)
                   throws FitsException

Description copied from class: Data

Modify a header to point to this data, this differs per subclass, they all need oder provided different informations to the header. Basically they describe the structure of this data object.

Specified by:

fillHeader in class Data

Parameters:

h - header to fill with the data from the current data object

Throws:

FitsException - if the operation fails

getData

public java.lang.Object getData()

Specified by:

getData in class Data

Returns:

the data array object.

getTrueSize

protected long getTrueSize()

Get the size of the actual data element.

Specified by:

getTrueSize in class Data

read

public void read(ArrayDataInput str)
          throws FitsException

Read the RandomGroupsData

Specified by:

read in interface FitsElement

Specified by:

read in class Data

Parameters:

str - The input data stream

Throws:

FitsException - if the read was unsuccessful.

write

public void write(ArrayDataOutput str)
           throws FitsException

Write the RandomGroupsData

Specified by:

write in interface FitsElement

Specified by:

write in class Data

Parameters:

str - The output stream on which to write the data.

Throws:

FitsException - if the write was unsuccessful.