org.lsst.ccs.utilities.image

Class DefaultFitsHeaderMetadataProvider

java.lang.Object

org.lsst.ccs.utilities.image.DefaultFitsHeaderMetadataProvider

All Implemented Interfaces:

FitsHeaderMetadataProvider

public class DefaultFitsHeaderMetadataProvider
extends Object
implements FitsHeaderMetadataProvider

Default implementation of the FitsHeaderMetadataProvider interface. It defines internal structures and utility methods to fill them.

Author:

turri

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Map<String,Map<String,Object>>>	extendedHeaderMetadataList
protected Map<String,Map<String,Object>>	primaryHeaderMetadata

Constructor Summary

Constructors

Constructor and Description
DefaultFitsHeaderMetadataProvider(ImageSet imageSet) Create a default FitsHeaderMetadataProvider for the given ImageSet.

Method Summary

Modifier and Type	Method and Description
void	addToDataExtendedHeaderMetadata(int extendedHeaderIndex, String extendedHeaderKey, Map<String,Object> map) Add a map to a data extended header by index.
void	addToPrimaryHeaderMetadata(String primaryKey, Map<String,Object> map) Add a map to the primary Header metadata.
Map<String,Map<String,Object>>	getAdditionalExtendedHeaderMetadata(String extendedKeyword) Get the metadata for an additional extended Headers by key.
Map<String,Map<String,Object>>	getDataExtendedHeaderMetadata(int extendedIndex) Get the metadata for the extended Headers with data by index.
Map<String,Map<String,Object>>	getPrimaryHeaderMetadata() Get the metadata for the primary Header
void	setDataExtendedHeaderMetadata(int extendedHeaderIndex, String extendedHeaderKey, Map<String,Object> map) Set a map to a data extended header by index.
void	setPrimaryHeaderMetadata(String primaryKey, Map<String,Object> map) Set a map in the primary Header metadata.

Methods inherited from class java.lang.Object

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

Field Detail

primaryHeaderMetadata

protected final Map<String,Map<String,Object>> primaryHeaderMetadata

extendedHeaderMetadataList

protected final List<Map<String,Map<String,Object>>> extendedHeaderMetadataList

Constructor Detail

DefaultFitsHeaderMetadataProvider

public DefaultFitsHeaderMetadataProvider(ImageSet imageSet)

Create a default FitsHeaderMetadataProvider for the given ImageSet. At creation, if the ImageSet has metadata available, it will be added to the primary header metadata. Similarly each Image metadata, if available, will be added to the Data extended headers metadata.

Parameters:

imageSet - The ImageSet for which this FitsHeaderMetadataProvider is created.

Method Detail

getAdditionalExtendedHeaderMetadata

public Map<String,Map<String,Object>> getAdditionalExtendedHeaderMetadata(String extendedKeyword)

Description copied from interface: FitsHeaderMetadataProvider

Get the metadata for an additional extended Headers by key. 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.

Specified by:

getAdditionalExtendedHeaderMetadata in interface FitsHeaderMetadataProvider

Parameters:

extendedKeyword - The keyword identifying the extended header.

Returns:

The metadata for the requested extended header

getDataExtendedHeaderMetadata

public Map<String,Map<String,Object>> getDataExtendedHeaderMetadata(int extendedIndex)

Description copied from interface: FitsHeaderMetadataProvider

Get the metadata for the extended Headers with data by index. These are the headers containing the actual images.

Specified by:

getDataExtendedHeaderMetadata in interface FitsHeaderMetadataProvider

Parameters:

extendedIndex - The index of the extended header.

Returns:

The metadata for the requested extended header

getPrimaryHeaderMetadata

public Map<String,Map<String,Object>> getPrimaryHeaderMetadata()

Description copied from interface: FitsHeaderMetadataProvider

Get the metadata for the primary Header

Specified by:

getPrimaryHeaderMetadata in interface FitsHeaderMetadataProvider

Returns:

The metadata for the primary header

setPrimaryHeaderMetadata

public void setPrimaryHeaderMetadata(String primaryKey,
                                     Map<String,Object> map)

Set a map in the primary Header metadata. This method replaces any existing metadata.

Parameters:

primaryKey - The Key in the primary header for the provided metadata.

map - The map with the metadata to be added.

setDataExtendedHeaderMetadata

public void setDataExtendedHeaderMetadata(int extendedHeaderIndex,
                                          String extendedHeaderKey,
                                          Map<String,Object> map)

Set a map to a data extended header by index. This method replaces any existing metadata.

Parameters:

extendedHeaderIndex - The extended header index to which the provided metadata is set.

extendedHeaderKey - The Key in the indexed extended data header to which the provided metadata is set.

map - The map containing the metadata to be set.

addToPrimaryHeaderMetadata

public void addToPrimaryHeaderMetadata(String primaryKey,
                                       Map<String,Object> map)

Add a map to the primary Header metadata. The provided map is added on top of any existing map.

Parameters:

primaryKey - The Key in the primary header to which the provided metadata is added.

map - The map with the metadata to be added.

addToDataExtendedHeaderMetadata

public void addToDataExtendedHeaderMetadata(int extendedHeaderIndex,
                                            String extendedHeaderKey,
                                            Map<String,Object> map)

Add a map to a data extended header by index. The provided map is added on top of any existing map.

Parameters:

extendedHeaderIndex - The extended header index to add to.

extendedHeaderKey - The Key in the indexed extended data header to which the provided metadata is added.

map - The map containing the metadata to be added.