lsst.obs.base  14.0-24-g714dd46+2
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__ (self, datasetType, policy, registry, calibRegistry, calibRoot, dataRoot=None, kwargs)
 
def map (self, mapper, dataId, write=False)
 
def lookup (self, properties, dataId)
 
def standardize (self, mapper, item, dataId)
 
def template (self)
 
def keys (self)
 
def have (self, properties, dataId)
 
def need (self, properties, dataId)
 

Public Attributes

 reference
 
 refCols
 
 refRegistry
 
 dataRoot
 
 range
 
 columns
 
 setFilter
 
 metadataKeys
 
 datasetType
 
 registry
 
 rootStorage
 
 keyDict
 
 python
 
 persistable
 
 storage
 
 level
 
 tables
 
 obsTimeName
 
 recipe
 

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 337 of file mapping.py.

Constructor & Destructor Documentation

◆ __init__()

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 369 of file mapping.py.

Member Function Documentation

◆ have()

def lsst.obs.base.mapping.Mapping.have (   self,
  properties,
  dataId 
)
inherited
Returns whether the provided data identifier has all
the properties in the provided list.
@param properties (list of strings) Properties required
@parm dataId      (dict) Dataset identifier
@return (bool) True if all properties are present

Definition at line 250 of file mapping.py.

◆ keys()

def lsst.obs.base.mapping.Mapping.keys (   self)
inherited
Return the dict of keys and value types required for this mapping.

Definition at line 133 of file mapping.py.

◆ lookup()

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 403 of file mapping.py.

◆ map()

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

Definition at line 396 of file mapping.py.

◆ need()

def lsst.obs.base.mapping.Mapping.need (   self,
  properties,
  dataId 
)
inherited
Ensures all properties in the provided list are present in
the data identifier, looking them up as needed.  This is only
possible for the case where the data identifies a single
exposure.
@param properties (list of strings) Properties required
@param dataId     (dict) Partial dataset identifier
@return (dict) copy of dataset identifier with enhanced values

Definition at line 261 of file mapping.py.

◆ standardize()

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

Definition at line 447 of file mapping.py.

◆ template()

def lsst.obs.base.mapping.Mapping.template (   self)
inherited

Definition at line 126 of file mapping.py.

Member Data Documentation

◆ columns

lsst.obs.base.mapping.CalibrationMapping.columns

Definition at line 389 of file mapping.py.

◆ dataRoot

lsst.obs.base.mapping.CalibrationMapping.dataRoot

Definition at line 385 of file mapping.py.

◆ datasetType

lsst.obs.base.mapping.Mapping.datasetType
inherited

Definition at line 89 of file mapping.py.

◆ keyDict

lsst.obs.base.mapping.Mapping.keyDict
inherited

Definition at line 100 of file mapping.py.

◆ level

lsst.obs.base.mapping.Mapping.level
inherited

Definition at line 115 of file mapping.py.

◆ metadataKeys

lsst.obs.base.mapping.CalibrationMapping.metadataKeys

Definition at line 392 of file mapping.py.

◆ obsTimeName

lsst.obs.base.mapping.Mapping.obsTimeName
inherited

Definition at line 122 of file mapping.py.

◆ persistable

lsst.obs.base.mapping.Mapping.persistable
inherited

Definition at line 112 of file mapping.py.

◆ python

lsst.obs.base.mapping.Mapping.python
inherited

Definition at line 111 of file mapping.py.

◆ range

lsst.obs.base.mapping.CalibrationMapping.range

Definition at line 387 of file mapping.py.

◆ recipe

lsst.obs.base.mapping.Mapping.recipe
inherited

Definition at line 123 of file mapping.py.

◆ refCols

lsst.obs.base.mapping.CalibrationMapping.refCols

Definition at line 383 of file mapping.py.

◆ reference

lsst.obs.base.mapping.CalibrationMapping.reference

Definition at line 382 of file mapping.py.

◆ refRegistry

lsst.obs.base.mapping.CalibrationMapping.refRegistry

Definition at line 384 of file mapping.py.

◆ registry

lsst.obs.base.mapping.Mapping.registry
inherited

Definition at line 90 of file mapping.py.

◆ rootStorage

lsst.obs.base.mapping.Mapping.rootStorage
inherited

Definition at line 91 of file mapping.py.

◆ setFilter

lsst.obs.base.mapping.CalibrationMapping.setFilter

Definition at line 391 of file mapping.py.

◆ storage

lsst.obs.base.mapping.Mapping.storage
inherited

Definition at line 113 of file mapping.py.

◆ tables

lsst.obs.base.mapping.Mapping.tables
inherited

Definition at line 117 of file mapping.py.


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