lsst.obs.base  20.0.0-20-g8c202bc
Public Member Functions | Public Attributes | List of all members
lsst.obs.base.mapping.DatasetMapping Class Reference
Inheritance diagram for lsst.obs.base.mapping.DatasetMapping:
lsst.obs.base.mapping.Mapping

Public Member Functions

def __init__ (self, datasetType, policy, registry, root, **kwargs)
 
def template (self)
 
def keys (self)
 
def map (self, mapper, dataId, write=False)
 
def lookup (self, properties, dataId)
 
def have (self, properties, dataId)
 
def need (self, properties, dataId)
 

Public Attributes

 storage
 
 datasetType
 
 registry
 
 rootStorage
 
 keyDict
 
 python
 
 persistable
 
 level
 
 tables
 
 range
 
 columns
 
 obsTimeName
 
 recipe
 

Detailed Description

DatasetMapping is a Mapping subclass for non-Exposure datasets that can
be retrieved by the standard daf_persistence mechanism.

The differences are that the Storage type must be specified and no
Exposure standardization is performed.

The "storage" entry in the Policy is mandatory; the "tables" entry is
optional; no "level" entry is allowed.

Parameters
----------
datasetType : `str`
    Butler dataset type to be mapped.
policy : `daf_persistence.Policy`
    Mapping Policy.
registry : `lsst.obs.base.Registry`
    Registry for metadata lookups
root : `str`
    Path of root directory

Definition at line 543 of file mapping.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.mapping.DatasetMapping.__init__ (   self,
  datasetType,
  policy,
  registry,
  root,
**  kwargs 
)

Definition at line 565 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.

Parameters
----------
properties : `list of `str`
    Properties required.
dataId : `dict`
    Dataset identifier.

Returns
-------
bool
    True if all properties are present.

Definition at line 269 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.Mapping.lookup (   self,
  properties,
  dataId 
)
inherited
Look up properties for in a metadata registry given a partial
dataset identifier.

Parameters
----------
properties : `list` of `str`
    What to look up.
dataId : `dict`
    Dataset identifier

Returns
-------
`list` of `tuple`
    Values of properties.

Reimplemented in lsst.obs.base.mapping.CalibrationMapping.

Definition at line 187 of file mapping.py.

◆ map()

def lsst.obs.base.mapping.Mapping.map (   self,
  mapper,
  dataId,
  write = False 
)
inherited
Standard implementation of map function.

Parameters
----------
mapper: `lsst.daf.persistence.Mapper`
    Object to be mapped.
dataId: `dict`
    Dataset identifier.

Returns
-------
lsst.daf.persistence.ButlerLocation
    Location of object that was mapped.

Reimplemented in lsst.obs.base.mapping.CalibrationMapping.

Definition at line 137 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.

Parameters
----------
properties : `list` of `str`
    Properties required.
dataId : `dict`
    Partial dataset identifier

Returns
-------
`dict`
    Copy of dataset identifier with enhanced values.

Definition at line 290 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.Mapping.columns
inherited

Definition at line 121 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.

◆ 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.Mapping.range
inherited

Definition at line 120 of file mapping.py.

◆ recipe

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

Definition at line 123 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.

◆ storage

lsst.obs.base.mapping.DatasetMapping.storage

Definition at line 567 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: