lsst.obs.base  14.0
 All Classes Namespaces Files Functions Variables
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.mapping.CalibrationMapping Class Reference
Inheritance diagram for lsst.obs.base.mapping.CalibrationMapping:
lsst.obs.base.mapping.Mapping

Public Member Functions

def __init__
 
def map
 
def lookup
 
def standardize
 
- Public Member Functions inherited from lsst.obs.base.mapping.Mapping
def __init__
 
def keys
 
def map
 
def lookup
 
def have
 
def need
 

Public Attributes

 reference
 
 refCols
 
 refRegistry
 
 dataRoot
 
 range
 
 columns
 
 setFilter
 
 metadataKeys
 
- Public Attributes inherited from lsst.obs.base.mapping.Mapping
 datasetType
 
 registry
 
 rootStorage
 
 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 317 of file mapping.py.

Constructor & Destructor Documentation

def lsst.obs.base.mapping.CalibrationMapping.__init__ (   self,
  datasetType,
  policy,
  registry,
  calibRegistry,
  calibRoot,
  dataRoot = None,
  kwargs 
)
Constructor for Mapping class.
@param datasetType    (string)
@param policy         (daf_persistence.Policy, or pexPolicy.Policy (only for backward compatibility))
              Mapping Policy
@param registry       (lsst.obs.base.Registry) Registry for metadata lookups
@param calibRegistry  (lsst.obs.base.Registry) Registry for calibration metadata lookups
@param calibRoot      (string) Path of calibration root directory
@param dataRoot.      (string) Path of data root directory; used for outputs only

Definition at line 349 of file mapping.py.

Member Function Documentation

def lsst.obs.base.mapping.CalibrationMapping.lookup (   self,
  properties,
  dataId 
)
Look up properties for in a metadata registry given a partial
dataset identifier.
@param properties (list of strings)
@param dataId     (dict) Dataset identifier
@return (list of tuples) values of properties

Definition at line 383 of file mapping.py.

def lsst.obs.base.mapping.CalibrationMapping.map (   self,
  mapper,
  dataId,
  write = False 
)

Definition at line 376 of file mapping.py.

def lsst.obs.base.mapping.CalibrationMapping.standardize (   self,
  mapper,
  item,
  dataId 
)

Definition at line 427 of file mapping.py.

Member Data Documentation

lsst.obs.base.mapping.CalibrationMapping.columns

Definition at line 369 of file mapping.py.

lsst.obs.base.mapping.CalibrationMapping.dataRoot

Definition at line 365 of file mapping.py.

lsst.obs.base.mapping.CalibrationMapping.metadataKeys

Definition at line 372 of file mapping.py.

lsst.obs.base.mapping.CalibrationMapping.range

Definition at line 367 of file mapping.py.

lsst.obs.base.mapping.CalibrationMapping.refCols

Definition at line 363 of file mapping.py.

lsst.obs.base.mapping.CalibrationMapping.reference

Definition at line 362 of file mapping.py.

lsst.obs.base.mapping.CalibrationMapping.refRegistry

Definition at line 364 of file mapping.py.

lsst.obs.base.mapping.CalibrationMapping.setFilter

Definition at line 371 of file mapping.py.


The documentation for this class was generated from the following file: