org.lsst.ccs.utilities.image

Interface FitsHeaderMetadataProvider

public interface FitsHeaderMetadataProvider

An interface to provide MetaDataSets to fill the content of Fits Headers. According to the syntax used in header specification (spec) files the meta-data is in the form of a MetaDataSet, that is a Map of Maps: the key names for the maps are defined as "mapName" and are used to determine at runtime the value of a fits keyword defined in the spec file as ${"mapName"."mapKey"}. The fits keyword is assigned the value corresponding to key "mapKey" in the map stored with key "mapName". If "mapName" is not specified (i.e. ${"mapKey"}) then all the maps are searched and the first one found containing key "mapKey" will yield the value. This interface is designed to be able to provide all the meta-data needed to write a single fits file. Since a single fit file is meant to be written for each CCD, the primary header meta-data should contain information for the CCD itself, the Reb used to read it, the Raft in which it is embedded etc. The extended data header should be written for each of the CCD segments, containing information for the specific segment.

Author:

The LSST CCS Team

Method Summary

Modifier and Type	Method and Description
default void	completedHeaderMetadata(ImageSet imageSet) Method invoked when the headers have been written for this ImageSet.
default MetaDataSet	getAdditionalExtendedHeaderMetadata(ImageSet imageSet, String extendedKeyword) Get the metadata for an additional extended Headers by key for a given ImageSet.
default MetaDataSet	getDataExtendedHeaderMetadata(ImageSet imageSet, int extendedIndex) Get the extended header meta-data by index for a given ImageSet.
default MetaDataSet	getPrimaryHeaderMetadata(ImageSet imageSet) Get the primary Header MetaDataSet for a given ImageSet

Method Detail

getPrimaryHeaderMetadata

default MetaDataSet getPrimaryHeaderMetadata(ImageSet imageSet)

Get the primary Header MetaDataSet for a given ImageSet

Parameters:

imageSet - the ImageSet for which the primary header meta-data is needed.

Returns:

The primary header meta-data for provided ImageSet.

getDataExtendedHeaderMetadata

default MetaDataSet getDataExtendedHeaderMetadata(ImageSet imageSet,
                                                  int extendedIndex)

Get the extended header meta-data by index for a given ImageSet. These are the headers containing the actual images. The index starts from 0.

Parameters:

extendedIndex - The index of the extended header.

imageSet - the ImageSet for which the extended header meta-data is needed.

Returns:

The extended header meta-data by index for the provided ImageSet

getAdditionalExtendedHeaderMetadata

default MetaDataSet getAdditionalExtendedHeaderMetadata(ImageSet imageSet,
                                                        String extendedKeyword)

Get the metadata for an additional extended Headers by key for a given ImageSet. The information in these extended headers is stored as BinaryTables. These are all the headers defined in the spec files with keywords other than "primary" and "extended"; this keyword will be used in this method to identify which metadata map to return.

Parameters:

imageSet - the ImageSet for which the extended header meta-data is needed.

extendedKeyword - The keyword identifying the extended header.

Returns:

The metadata for the requested extended header

completedHeaderMetadata

default void completedHeaderMetadata(ImageSet imageSet)

Method invoked when the headers have been written for this ImageSet. This is to be used for memory management, cleaning all the data that is not needed.

Parameters:

imageSet - the ImageSet for which the headers have been completed.