|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eso.fits.FitsHeader
public class FitsHeader
FITS Header class which is an ordered set of FitsKeywords.
Constructor Summary | |
---|---|
FitsHeader()
Default constructor for empty FitsHeader class |
|
FitsHeader(java.io.DataInput file)
Constructor for FitsHeader class given a DataInput file positioned at the FITS header. |
Method Summary | |
---|---|
void |
addKeyword(FitsKeyword kw)
Append FITS keyword to the end of the header. |
long |
getDataSize()
Compute size of FITS data matrix in bytes |
int |
getHeaderSpace()
Get space in FITS header read from file in terms of number of keyword cards to can contain. |
FitsKeyword |
getKeyword(int no)
Return a keyword giving its relative position. |
FitsKeyword |
getKeyword(java.lang.String name)
Return a keyword giving its name. |
java.util.ListIterator |
getKeywords()
Obtain a ListIterator for keywords in the header. |
FitsKeyword[] |
getKeywords(java.lang.String name)
Return an array of keywords giving a name. |
java.lang.String |
getName()
Get name of FITS HUunit as given by the EXTNAME keyword. |
int |
getNoKeywords()
Obtain the total number of keywords in the header. |
int |
getType()
Return the type of the FITS header e.g. |
int |
getVersion()
Get version of FITS HUunit as given by the EXTVER keyword. |
void |
insertKeywordAt(FitsKeyword kw,
int index)
Insert FITS keyword at a given position in the header. |
void |
removeKeywordAt(int index)
Remove FITS keyword at a given position in the header. |
void |
setExtension(int type)
Sets the first keyword in the header to XTENSION with the type indicated. |
java.lang.String |
toString()
Generate a string with the FITS header. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FitsHeader()
public FitsHeader(java.io.DataInput file) throws FitsException
file
- RandomAccess file positioned at the start of a
FITS header
FitsException
Method Detail |
---|
public void addKeyword(FitsKeyword kw)
kw
- FitsKeyword to be appendedpublic void insertKeywordAt(FitsKeyword kw, int index)
kw
- FitsKeyword to be appendedindex
- place where the keyword should be insertedpublic void removeKeywordAt(int index)
index
- location of keyword which should be removedpublic final int getType()
public final long getDataSize()
public final java.lang.String getName()
public final int getVersion()
public final int getNoKeywords()
public final FitsKeyword getKeyword(int no)
no
- position of keyword in header (starting with 0)public final FitsKeyword getKeyword(java.lang.String name)
name
- string with name of keywordpublic final FitsKeyword[] getKeywords(java.lang.String name)
name
- string with name of keywordpublic final java.util.ListIterator getKeywords()
public java.lang.String toString()
toString
in class java.lang.Object
public int getHeaderSpace()
public void setExtension(int type)
type
- Type of FITS extension
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |