lsst.daf.butlerUtils.mapping.CalibrationMapping Class Reference

Inheritance diagram for lsst.daf.butlerUtils.mapping.CalibrationMapping:

Public Member Functions
def	__init__
def	lookup
def	standardize
Public Member Functions inherited from lsst.daf.butlerUtils.mapping.Mapping
def	__init__
def	keys
def	map
def	lookup
def	have
def	need

Public Attributes
	reference
	refCols
	refRegistry
	range
	columns
	setFilter
Public Attributes inherited from lsst.daf.butlerUtils.mapping.Mapping
	datasetType
	registry
	root
	template
	keyDict
	python
	persistable
	storage
	level
	tables
	range
	columns
	obsTimeName

Detailed Description

CalibrationMapping is a Mapping subclass for calibration-type products.

The difference is that data properties in the query or template
can be looked up using a reference Mapping in addition to this one.

CalibrationMapping Policies can contain the following:

reference (string, optional): a list of tables for finding missing dataset
identifier components (including the observation time, if a validity range
is required) in the exposure registry; note that the "tables" entry refers
to the calibration registry

refCols (string, optional): a list of dataset properties required from the
reference tables for lookups in the calibration registry

validRange (bool): true if the calibration dataset has a validity range
specified by a column in the tables of the reference dataset in the
exposure registry) and two columns in the tables of this calibration
dataset in the calibration registry)

obsTimeName (string, optional): the name of the column in the reference
dataset tables containing the observation time (default "taiObs")

validStartName (string, optional): the name of the column in the
calibration dataset tables containing the start of the validity range
(default "validStart")

validEndName (string, optional): the name of the column in the
calibration dataset tables containing the end of the validity range
(default "validEnd") 

Definition at line 248 of file mapping.py.

Constructor & Destructor Documentation

def lsst.daf.butlerUtils.mapping.CalibrationMapping.__init__	(		self,
			datasetType,
			policy,
			registry,
			calibRegistry,
			calibRoot,
			kwargs
	)

Constructor for Mapping class.
@param datasetType    (string)
@param policy         (lsst.pex.policy.Policy) Mapping policy
@param registry       (lsst.daf.butlerUtils.Registry) Registry for metadata lookups
@param calibRegistry  (lsst.daf.butlerUtils.Registry) Registry for calibration metadata lookups
@param calibRoot      (string) Path of calibration root directory

Definition at line 280 of file mapping.py.

    def __init__(self, datasetType, policy, registry, calibRegistry, calibRoot, **kwargs):
        """Constructor for Mapping class.
        @param datasetType    (string)
        @param policy         (lsst.pex.policy.Policy) Mapping policy
        @param registry       (lsst.daf.butlerUtils.Registry) Registry for metadata lookups
        @param calibRegistry  (lsst.daf.butlerUtils.Registry) Registry for calibration metadata lookups
        @param calibRoot      (string) Path of calibration root directory"""

        Mapping.__init__(self, datasetType, policy, calibRegistry, calibRoot, **kwargs)
        self.reference = policy.getStringArray("reference") \
                if policy.exists("reference") else None
        self.refCols = policy.getStringArray("refCols") \
                if policy.exists("refCols") else None
        self.refRegistry = registry
        if policy.exists("validRange") and policy.getBool("validRange"):
            self.range = ("?", policy.getString("validStartName"),
                policy.getString("validEndName"))
        if policy.exists("columns"):
            self.columns = policy.getStringArray("columns")
        if policy.exists("filter"):
            self.setFilter = policy.getBool("filter")