org.lsst.ccs.utilities.image

Class FitsHeadersSpecifications

java.lang.Object

org.lsst.ccs.utilities.image.FitsHeadersSpecifications

public class FitsHeadersSpecifications
extends Object

Utility class for the generation of header specifications objects. These objects create a map between fits header keywords and quantities that are loaded at runtime. Each spec file is linked to a named header. Default name headers that must be provided when writing fits files are "primary" for the primary header and "extended" for any data header file extension, i.e. extensions containing image data. Any additional header name (beside "primary" and "extended") will create an additional extension in which the fits keywords are stored in a binary table.

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
FitsHeadersSpecifications()

Method Summary

Modifier and Type	Method and Description
static void	addSpecFile(String fileName) Add the a header specification file.
static void	addSpecFile(String fileName, String headerName) Add the a header specification file.
static Map<String,HeaderSpecification>	getHeaderSpecifications() Get the HeaderSpecifications as built from the read spec files.

Methods inherited from class java.lang.Object

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

Constructor Detail

FitsHeadersSpecifications

public FitsHeadersSpecifications()

Method Detail

addSpecFile

public static final void addSpecFile(String fileName)

Add the a header specification file. This information will be used to generate the Header configuration map. The name of the file (excluding the .spec extension if provided) will be used as the name of the header extension. If a Header already exists for the provided name, the new header lines will be superimposed with the existing ones.

Parameters:

fileName - The name of the file to be loaded. The extension may be omitted. No path information is to be provided. The file will be loaded as a Bootstrap resource.

addSpecFile

public static final void addSpecFile(String fileName,
                                     String headerName)

Add the a header specification file. This information will be used to generate the Header configuration map. The name of the file (excluding the .spec extension if provided) will be used as the name of the header extension unless a corresponding header name is provided. If a Header already exists for the provided name, the new header lines will be superimposed with the existing ones.

Parameters:

fileName - The name of the file to be loaded. The extension may be omitted. No path information is to be provided. The file will be loaded as a Bootstrap resource.

headerName - The headers name for which this spec file is added If no header name is provided, the file name will be used.

getHeaderSpecifications

public static final Map<String,HeaderSpecification> getHeaderSpecifications()

Get the HeaderSpecifications as built from the read spec files.

Returns:

The Map of HeaderSpecifications;