|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnom.tam.fits.Fits
public class Fits
This class provides access to routines to allow users to read and write FITS files.
Description of the Package
This FITS package attempts to make using FITS files easy, but does not do exhaustive error checking. Users should not assume that just because a FITS file can be read and written that it is necessarily legal FITS. These classes try to make it easy to transform between arrays of Java primitives and their FITS encodings.
Constructor Summary | |
---|---|
Fits()
Create an empty Fits object which is not associated with an input stream. |
|
Fits(java.io.File myFile)
Associate FITS object with a File. |
|
Fits(java.io.File myFile,
boolean compressed)
Associate the Fits object with a File |
|
Fits(java.io.InputStream str)
Create a Fits object associated with the given data stream. |
|
Fits(java.io.InputStream str,
boolean compressed)
Create a Fits object associated with a data stream. |
|
Fits(java.lang.String filename)
Associate the FITS object with a file or URL. |
|
Fits(java.lang.String filename,
boolean compressed)
Associate the FITS object with a file or URL. |
|
Fits(java.net.URL myURL)
Associate the FITS object with a given URL |
|
Fits(java.net.URL myURL,
boolean compressed)
Associate the FITS object with a given uncompressed URL |
Method Summary | |
---|---|
void |
addHDU(BasicHDU myHDU)
Add an HDU to the Fits object. |
static long |
checksum(byte[] data)
Calculate the Seaman-Pence 32-bit 1's complement checksum over the byte stream. |
int |
currentSize()
Deprecated. See getNumberOfHDUs() |
void |
deleteHDU(int n)
Delete an HDU from the HDU list. |
protected void |
fileInit(java.io.File myFile,
boolean compressed)
Get a stream from the file and then use the stream initialization. |
BasicHDU |
getHDU(int n)
Return the n'th HDU. |
int |
getNumberOfHDUs()
Get the current number of HDUs in the Fits object. |
ArrayDataInput |
getStream()
Get the data stream used for the Fits Data. |
void |
insertHDU(BasicHDU myHDU,
int n)
Insert a FITS object into the list of HDUs. |
static BasicHDU |
makeHDU(Data datum)
Create an HDU from the given Data. |
static BasicHDU |
makeHDU(Header h)
Create an HDU from the given header. |
static BasicHDU |
makeHDU(java.lang.Object o)
Create an HDU from the given data kernel. |
protected void |
randomInit(java.io.File f)
Initialize using buffered random access. |
BasicHDU[] |
read()
Return all HDUs for the Fits object. |
void |
read(java.io.InputStream is)
Read a FITS file from an InputStream object. |
BasicHDU |
readHDU()
Read the next HDU on the default input stream. |
void |
setChecksum()
Add or Modify the CHECKSUM keyword in all headers. |
static void |
setChecksum(BasicHDU hdu)
Add or update the CHECKSUM keyword. |
void |
setStream(ArrayDataInput stream)
Set the data stream to be used for future input. |
int |
size()
Deprecated. The meaning of size of ambiguous. Use |
void |
skipHDU()
Skip the next HDU on the default input stream. |
void |
skipHDU(int n)
Skip HDUs on the associate input stream. |
protected void |
streamInit(java.io.InputStream str)
Initialize the input stream. |
protected void |
streamInit(java.io.InputStream str,
boolean seekable)
Initialize the stream. |
protected void |
streamInit(java.io.InputStream str,
boolean compressed,
boolean seekable)
Do the stream initialization. |
static java.lang.String |
version()
Indicate the version of these classes |
void |
write(java.io.DataOutput os)
Write a Fits Object to an external Stream. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Fits()
public Fits(java.io.InputStream str) throws FitsException
str
- The data stream.
FitsException
public Fits(java.io.InputStream str, boolean compressed) throws FitsException
str
- The data stream.compressed
- Is the stream compressed? This is currently ignored.
Compression is determined from the first two bytes in the stream.
FitsException
public Fits(java.io.File myFile) throws FitsException
myFile
- The File object.
FitsException
public Fits(java.io.File myFile, boolean compressed) throws FitsException
myFile
- The File object.compressed
- Is the data compressed?
FitsException
public Fits(java.lang.String filename) throws FitsException
filename
- The name of the file or URL to be processed.
FitsException
- Thrown if unable to find or open
a file or URL from the string given.public Fits(java.lang.String filename, boolean compressed) throws FitsException
filename
- The name of the file or URL to be processed.
FitsException
- Thrown if unable to find or open
a file or URL from the string given.public Fits(java.net.URL myURL, boolean compressed) throws FitsException
myURL
- The URL to be associated with the FITS file.compressed
- Compression flag, ignored.
FitsException
- Thrown if unable to use the specified URL.public Fits(java.net.URL myURL) throws FitsException
myURL
-
FitsException
- Thrown if unable to find or open
a file or URL from the string given.Method Detail |
---|
public static java.lang.String version()
protected void streamInit(java.io.InputStream str, boolean seekable) throws FitsException
str
- The user specified input streamseekable
- ignored
FitsException
protected void streamInit(java.io.InputStream str, boolean compressed, boolean seekable) throws FitsException
str
- The input stream.compressed
- Is this data compressed? This flag
is ignored. The compression is determined from the stream content.seekable
- Can one seek on the stream. This parameter is ignored.
FitsException
protected void streamInit(java.io.InputStream str) throws FitsException
str
-
FitsException
protected void randomInit(java.io.File f) throws FitsException
f
-
FitsException
protected void fileInit(java.io.File myFile, boolean compressed) throws FitsException
myFile
- The File to be associated.compressed
- Is the data compressed?
FitsException
public BasicHDU[] read() throws FitsException
FitsException
public BasicHDU readHDU() throws FitsException, java.io.IOException
FitsException
java.io.IOException
public void skipHDU(int n) throws FitsException, java.io.IOException
n
- The number of HDUs to be skipped.
FitsException
java.io.IOException
public void skipHDU() throws FitsException, java.io.IOException
FitsException
java.io.IOException
public BasicHDU getHDU(int n) throws FitsException, java.io.IOException
n
- The index of the HDU to be read. The primary HDU is index 0.
FitsException
java.io.IOException
public int size() throws FitsException
FitsException
public void addHDU(BasicHDU myHDU) throws FitsException
myHDU
- The HDU to be added to the end of the FITS object.
FitsException
public void insertHDU(BasicHDU myHDU, int n) throws FitsException
myHDU
- The HDU to be inserted into the list of HDUs.n
- The location at which the HDU is to be inserted.
FitsException
public void deleteHDU(int n) throws FitsException
n
- The index of the HDU to be deleted.
If n is 0 and there is more than one HDU present, then
the next HDU will be converted from an image to
primary HDU if possible. If not a dummy header HDU
will then be inserted.
FitsException
public void write(java.io.DataOutput os) throws FitsException
os
- A DataOutput stream.
FitsException
public void read(java.io.InputStream is) throws FitsException, java.io.IOException
is
- The InputStream stream whence the FITS information
is found.
FitsException
java.io.IOException
public int currentSize()
public int getNumberOfHDUs()
public ArrayDataInput getStream()
public void setStream(ArrayDataInput stream)
stream
- The data stream to be used.public static BasicHDU makeHDU(Header h) throws FitsException
h
- The header which describes the FITS extension
FitsException
public static BasicHDU makeHDU(java.lang.Object o) throws FitsException
o
- The data to be described in this HDU.
FitsException
public static BasicHDU makeHDU(Data datum) throws FitsException
datum
- The data to be described in this HDU.
FitsException
public static void setChecksum(BasicHDU hdu) throws HeaderCardException, FitsException, java.io.IOException
hdu
- the HDU to be updated.
HeaderCardException
FitsException
java.io.IOException
public void setChecksum() throws HeaderCardException, FitsException, java.io.IOException
HeaderCardException
FitsException
java.io.IOException
public static long checksum(byte[] data)
data
- the byte sequence
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |