org.lsst.ccs.utilities.image

Class FitsFileWriter

java.lang.Object

org.lsst.ccs.utilities.image.FitsFileWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class FitsFileWriter
extends Object
implements Closeable

A utility for writing FITS files following LSST conventions.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
FitsFileWriter(File file, ImageSet images) Construct a FitsFileWriter object for the provided ImageSet.
FitsFileWriter(File file, ImageSet images, MetaDataSet metaDataSet)
FitsFileWriter(File file, ImageSet images, MetaDataSet metaDataSet, RawImageData.BitsPerPixel bits)

Method Summary

Modifier and Type	Method and Description
static void	addFitsHeaderMetadataProvider(FitsHeaderMetadataProvider metadataProvider) Add a FitsHeaderMetadataProvider to be used when writing out headers when writing out fits files.
FutureTask<Void>	asyncWrite(int imageIndex, ByteBuffer src)
void	close()
static void	removeFitsHeaderMetadataProvider(FitsHeaderMetadataProvider metadataProvider)
void	write(int imageIndex, ByteBuffer src) Write the actual image data to the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FitsFileWriter

public FitsFileWriter(File file,
                      ImageSet images)
               throws IOException,
                      nom.tam.fits.FitsException

Construct a FitsFileWriter object for the provided ImageSet. By default this will write 32 bit images.

Parameters:

file - The name of the output fits file

images - The ImageSet of images to write in the Data extended headers. Note that this specifies the images to write, not the actual data for the images.

images - The ImageSet to write to the file.

metaData - The meta-data maps to use to extract header info from

bits - The number of bits per pixel for images

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

public FitsFileWriter(File file,
                      ImageSet images,
                      MetaDataSet metaDataSet)
               throws IOException,
                      nom.tam.fits.FitsException

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

public FitsFileWriter(File file,
                      ImageSet images,
                      MetaDataSet metaDataSet,
                      RawImageData.BitsPerPixel bits)
               throws IOException,
                      nom.tam.fits.FitsException

Throws:

IOException

nom.tam.fits.FitsException

Method Detail

write

public void write(int imageIndex,
                  ByteBuffer src)
           throws IOException

Write the actual image data to the file. It is not necessary that all of the data for the image be available at once, this method will write whatever data is currently available in the byte buffer to the specified image, and will keep track of how much has been written to each image to allow more data to be written later. This method assumes the data is given in the order it is to be written to the file. If any data reordering is needed it needs to be done before calling this method.

Parameters:

imageIndex - The image to which this data is to be written

src - The image

Throws:

IOException - If an IOException is generated, or if more data is sent than was expected for a particular image.

asyncWrite

public FutureTask<Void> asyncWrite(int imageIndex,
                                   ByteBuffer src)
                            throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

addFitsHeaderMetadataProvider

public static void addFitsHeaderMetadataProvider(FitsHeaderMetadataProvider metadataProvider)

Add a FitsHeaderMetadataProvider to be used when writing out headers when writing out fits files. The order in which the headers are added is important if fits header keyword values are overwritten. The topmost provider will take precedence over providers added earlier in the list.

Parameters:

metadataProvider - The FitsHeaderMetadataProvider to be added

removeFitsHeaderMetadataProvider

public static void removeFitsHeaderMetadataProvider(FitsHeaderMetadataProvider metadataProvider)