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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FitsFileWriter.FitsIOException

Constructor Summary

Constructors

Constructor and Description
FitsFileWriter(File file) Construct a FitsFileWriter but do not create the HDUs.
FitsFileWriter(File file, ImageSet images) Deprecated.
FitsFileWriter(File file, ImageSet images, List<FitsHeaderMetadataProvider> providers) Deprecated.
FitsFileWriter(File file, ImageSet images, Map<String,HeaderSpecification> specs)
FitsFileWriter(File file, ImageSet images, Map<String,HeaderSpecification> specs, List<FitsHeaderMetadataProvider> providers)
FitsFileWriter(File file, ImageSet images, Map<String,HeaderSpecification> specs, MetaDataSet metaDataSet)
FitsFileWriter(File file, ImageSet images, MetaDataSet metaDataSet) Deprecated.
FitsFileWriter(File file, ImageSet images, MetaDataSet metaDataSet, List<FitsHeaderMetadataProvider> providers)
FitsFileWriter(File file, ImageSet images, MetaDataSet metaDataSet, List<FitsHeaderMetadataProvider> providers, RawImageData.BitsPerPixel bits) Deprecated.
FitsFileWriter(File file, ImageSet images, MetaDataSet metaDataSet, List<FitsHeaderMetadataProvider> providers, RawImageData.BitsPerPixel bits, Map<String,HeaderSpecification> specs) Construct a FitsFileWriter object for the provided ImageSet.

Method Summary

Modifier and Type	Method and Description
Future<Integer>	asyncWrite(String imageExtensionName, ByteBuffer src) Write a buffer to an image extension asynchronously
<A> void	asyncWrite(String imageExtensionName, ByteBuffer src, A attachment, CompletionHandler<Integer,? super A> handler) Write a buffer to an image extension asynchronously
void	close()
void	createHDUs(ImageSet images, MetaDataSet metaDataSet, List<FitsHeaderMetadataProvider> providers, RawImageData.BitsPerPixel bits, Map<String,HeaderSpecification> specs) Complete initialization of a file created with the single argument constructor
int	write(String imageExtensionName, 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

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

Deprecated.

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.

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

public FitsFileWriter(File file,
                      ImageSet images,
                      Map<String,HeaderSpecification> specs)
               throws IOException,
                      nom.tam.fits.FitsException

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

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

Deprecated.

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

public FitsFileWriter(File file,
                      ImageSet images,
                      Map<String,HeaderSpecification> specs,
                      MetaDataSet metaDataSet)
               throws IOException,
                      nom.tam.fits.FitsException

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

public FitsFileWriter(File file,
                      ImageSet images,
                      MetaDataSet metaDataSet,
                      List<FitsHeaderMetadataProvider> providers)
               throws IOException,
                      nom.tam.fits.FitsException

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

@Deprecated
public FitsFileWriter(File file,
                                  ImageSet images,
                                  List<FitsHeaderMetadataProvider> providers)
                           throws IOException,
                                  nom.tam.fits.FitsException

Deprecated.

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

public FitsFileWriter(File file,
                      ImageSet images,
                      Map<String,HeaderSpecification> specs,
                      List<FitsHeaderMetadataProvider> providers)
               throws IOException,
                      nom.tam.fits.FitsException

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

@Deprecated
public FitsFileWriter(File file,
                                  ImageSet images,
                                  MetaDataSet metaDataSet,
                                  List<FitsHeaderMetadataProvider> providers,
                                  RawImageData.BitsPerPixel bits)
                           throws IOException,
                                  nom.tam.fits.FitsException

Deprecated.

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

public FitsFileWriter(File file,
                      ImageSet images,
                      MetaDataSet metaDataSet,
                      List<FitsHeaderMetadataProvider> providers,
                      RawImageData.BitsPerPixel bits,
                      Map<String,HeaderSpecification> specs)
               throws IOException,
                      nom.tam.fits.FitsException

Construct a FitsFileWriter object for the provided ImageSet.

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.

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

providers -

bits - The number of bits per pixel for images

specs - The spec files used to create FITS file headers

Throws:

IOException

nom.tam.fits.FitsException

FitsFileWriter

public FitsFileWriter(File file)
               throws IOException

Construct a FitsFileWriter but do not create the HDUs. You must call createHDUs before attempting to write to the file.

Parameters:

file - The file to write

Throws:

IOException

Method Detail

createHDUs

public void createHDUs(ImageSet images,
                       MetaDataSet metaDataSet,
                       List<FitsHeaderMetadataProvider> providers,
                       RawImageData.BitsPerPixel bits,
                       Map<String,HeaderSpecification> specs)
                throws IOException,
                       nom.tam.fits.FitsException

Complete initialization of a file created with the single argument constructor

Parameters:

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.

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

providers -

bits - The number of bits per pixel for images

specs - The spec files used to create FITS file headers

Throws:

IOException

nom.tam.fits.FitsException

write

public int write(String imageExtensionName,
                 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:

imageExtensionName - The image extension name to which this data is to be written

src - The image

Returns:

The number of bytes written

Throws:

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

asyncWrite

public Future<Integer> asyncWrite(String imageExtensionName,
                                  ByteBuffer src)
                           throws IOException

Write a buffer to an image extension asynchronously

Parameters:

imageExtensionName - The image extension name to which this data is to be written

src - The buffer to write

Returns:

A future which will eventually return the number of bytes written

Throws:

IOException - If the operation cannot be queued.

asyncWrite

public <A> void asyncWrite(String imageExtensionName,
                           ByteBuffer src,
                           A attachment,
                           CompletionHandler<Integer,? super A> handler)
                    throws IOException

Write a buffer to an image extension asynchronously

Type Parameters:

A - The type of the attachment

Parameters:

imageExtensionName - The image extension name to which this data is to be written

src - The buffer to write

attachment - The object to attach to the I/O operation; can be null

handler - The handler for consuming the result

Throws:

IOException - If the operation cannot be queued.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException