org.lsst.ccs.daq.utilities

Class FitsService

java.lang.Object

org.lsst.ccs.daq.utilities.FitsService

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.MessageListener, org.lsst.ccs.messaging.StatusMessageListener, org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider

public class FitsService
extends Object
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.StatusMessageListener, org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider

An AgentFitsHeaderService is responsible to load spec files for writing out fits headers. This Service is activated when a list of header files is provided via the "headerFilesList" configuration parameter. This list contains a list of file names to be loaded. Each file name can be specified as "fileName:fitsHeaderName". For example "ts8_primary:primary" to assign the ts8_primary.spec file to the primary header. If the name is already the name of the header, then the file name alone will suffice.

Author:

The LSST CCS Team

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FitsService.FitsServiceKeyReplacement

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMON_HEADER_NAME

Constructor Summary

Constructors

Constructor and Description
FitsService()

Method Summary

Modifier and Type	Method and Description
void	clearNonStickyHeaderKeywordValues() Method to clear the non-sticky header keyword values.
void	completedHeaderMetadata(org.lsst.ccs.utilities.image.ImageSet imageSet)
org.lsst.ccs.utilities.image.MetaDataSet	getAdditionalExtendedHeaderMetadata(org.lsst.ccs.utilities.image.ImageSet imageSet, String extendedKeyword)
org.lsst.ccs.utilities.image.MetaDataSet	getDataExtendedHeaderMetadata(org.lsst.ccs.utilities.image.ImageSet imageSet, int extendedIndex)
protected org.lsst.ccs.utilities.ccd.Reb	getGeometry()
Map<String,org.lsst.ccs.utilities.image.HeaderSpecification>	getHeaderSpecificationMap()
org.lsst.ccs.utilities.image.MetaDataSet	getPrimaryHeaderMetadata(org.lsst.ccs.utilities.image.ImageSet imageSet)
void	onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage msg)
void	postInit()
String	printHeaderSpecifications()
void	setGeometry(org.lsst.ccs.utilities.ccd.Geometry reb)
void	setHeaderFilesList(List<String> list)
void	setHeaderKeywordValue(String headerKeywordName, Object headerKeywordValue)
void	setHeaderKeywordValue(String headerKeywordName, Object headerKeywordValue, boolean sticky) Set a key for the Primary header of all CCDs.
void	setHeaderKeywordValue(String headerName, String headerKeywordName, Object headerKeywordValue)
void	setHeaderKeywordValue(String headerName, String headerKeywordName, Object headerKeywordValue, boolean sticky)
void	start()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, init, postBuild, postShutdown, postStart, shutdown

Field Detail

COMMON_HEADER_NAME

public static final String COMMON_HEADER_NAME

See Also:

Constant Field Values

Constructor Detail

FitsService

public FitsService()

Method Detail

setHeaderFilesList

@ConfigurationParameterChanger(propertyName="headerFilesList")
public void setHeaderFilesList(List<String> list)

postInit

public void postInit()

Specified by:

postInit in interface org.lsst.ccs.framework.HasLifecycle

getGeometry

protected org.lsst.ccs.utilities.ccd.Reb getGeometry()

setGeometry

public void setGeometry(org.lsst.ccs.utilities.ccd.Geometry reb)

start

public void start()

Specified by:

start in interface org.lsst.ccs.framework.HasLifecycle

onStatusMessage

public void onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage msg)

Specified by:

onStatusMessage in interface org.lsst.ccs.messaging.StatusMessageListener

getHeaderSpecificationMap

public Map<String,org.lsst.ccs.utilities.image.HeaderSpecification> getHeaderSpecificationMap()

printHeaderSpecifications

@Command(type=QUERY,
         category=SYSTEM)
public String printHeaderSpecifications()

setHeaderKeywordValue

public void setHeaderKeywordValue(String headerKeywordName,
                                  Object headerKeywordValue,
                                  boolean sticky)

Set a key for the Primary header of all CCDs.

Parameters:

headerKeywordName - The name of the Header to set

headerKeywordValue - The corresponding value

sticky - Boolean value to specify if the provided Header keyword value should be used across exposures. The default value is true. If false is provided, the provided Header keyword value will be reset after each exposure.

setHeaderKeywordValue

public void setHeaderKeywordValue(String headerKeywordName,
                                  Object headerKeywordValue)

setHeaderKeywordValue

public void setHeaderKeywordValue(String headerName,
                                  String headerKeywordName,
                                  Object headerKeywordValue)

setHeaderKeywordValue

public void setHeaderKeywordValue(String headerName,
                                  String headerKeywordName,
                                  Object headerKeywordValue,
                                  boolean sticky)

clearNonStickyHeaderKeywordValues

public void clearNonStickyHeaderKeywordValues()

Method to clear the non-sticky header keyword values.

getAdditionalExtendedHeaderMetadata

public org.lsst.ccs.utilities.image.MetaDataSet getAdditionalExtendedHeaderMetadata(org.lsst.ccs.utilities.image.ImageSet imageSet,
                                                                                    String extendedKeyword)

Specified by:

getAdditionalExtendedHeaderMetadata in interface org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider

getDataExtendedHeaderMetadata

public org.lsst.ccs.utilities.image.MetaDataSet getDataExtendedHeaderMetadata(org.lsst.ccs.utilities.image.ImageSet imageSet,
                                                                              int extendedIndex)

Specified by:

getDataExtendedHeaderMetadata in interface org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider

getPrimaryHeaderMetadata

public org.lsst.ccs.utilities.image.MetaDataSet getPrimaryHeaderMetadata(org.lsst.ccs.utilities.image.ImageSet imageSet)

Specified by:

getPrimaryHeaderMetadata in interface org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider

completedHeaderMetadata

public void completedHeaderMetadata(org.lsst.ccs.utilities.image.ImageSet imageSet)

Specified by:

completedHeaderMetadata in interface org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider