|
|||||||||
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.
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 an uncompressed 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 uncompressed data stream. |
|
Fits(java.io.InputStream str,
boolean compressed)
Create a Fits object associated with a possibly compressed data stream. |
|
Fits(java.lang.String filename)
Associate the FITS object with a file or URL. |
|
Fits(java.net.URL myURL)
Associate the FITS object with a given uncompressed URL |
|
Fits(java.net.URL myURL,
boolean compressed)
Associate the FITS object with a given URL |
Method Summary | |
---|---|
void |
addHDU(BasicHDU myHDU)
Add an HDU to the Fits object. |
int |
currentSize()
Get the current number of HDUs in the Fits object. |
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. |
BufferedDataInputStream |
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 void |
main(java.lang.String[] args)
|
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 |
setStream(BufferedDataInputStream stream)
Set the data stream to be used for future input. |
int |
size()
Return the number of HDUs in the Fits object. |
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,
boolean compressed)
Do the stream initialization. |
static java.lang.String |
version()
Indicate the version of these classes |
void |
write(java.io.OutputStream 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?
FitsException
public Fits(java.io.File myFile, boolean compressed) throws FitsException
myFile
- The File object.compressed
- Is the data compressed?
FitsException
public Fits(java.io.File myFile) throws FitsException
myFile
- The File object.
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.net.URL myURL, boolean compressed) throws FitsException
myURL
- The URL to be associated with the FITS file.compressed
- Is the data compressed?
FitsException
- Thrown if unable to find or open
a file or URL from the string given.public Fits(java.net.URL myURL) throws FitsException
myURL
- The URL to be associated with the FITS file.
FitsException
- Thrown if unable to use the specified URL.Method Detail |
---|
public static java.lang.String version()
protected void streamInit(java.io.InputStream str, boolean compressed) throws FitsException
str
- The input stream. The Fits class
uses a BufferedDataInputStream internally
and will use this instance if
it's already of that class.compressed
- Is this data compressed? If so,
then the GZIPInputStream class will be
used to inflate it.
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.
If n is 0, then the previous initial HDU will
be converted into an IMAGE extension.
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.OutputStream os) throws FitsException
dos
- 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 BufferedDataInputStream getStream()
public void setStream(BufferedDataInputStream stream)
stream
- The data stream to be used.public static void main(java.lang.String[] args) throws FitsException
FitsException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |