lsst.obs.base  20.0.0-27-g22bab1b+60c4b1e1c0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.test.baseMapper.BaseMapper Class Reference
Inheritance diagram for lsst.obs.base.test.baseMapper.BaseMapper:
lsst.obs.base.cameraMapper.CameraMapper

Public Member Functions

def __init__ (self, root)
 
def getPackageDir (cls)
 
def backup (self, datasetType, dataId)
 
def keys (self)
 
def getKeys (self, datasetType, level)
 
def getDefaultLevel (self)
 
def getDefaultSubLevel (self, level)
 
def getCameraName (cls)
 
def getPackageName (cls)
 
def getGen3Instrument (cls)
 
def map_camera (self, dataId, write=False)
 
def bypass_camera (self, datasetType, pythonType, butlerLocation, dataId)
 
def map_expIdInfo (self, dataId, write=False)
 
def bypass_expIdInfo (self, datasetType, pythonType, location, dataId)
 
def std_bfKernel (self, item, dataId)
 
def std_raw (self, item, dataId)
 
def map_skypolicy (self, dataId)
 
def std_skypolicy (self, item, dataId)
 
def getRegistry (self)
 
def getImageCompressionSettings (self, datasetType, dataId)
 

Static Public Member Functions

def getShortCcdName (ccdName)
 

Public Attributes

 log
 
 root
 
 levels
 
 defaultLevel
 
 defaultSubLevels
 
 rootStorage
 
 registry
 
 calibRegistry
 
 keyDict
 
 cameraDataLocation
 
 camera
 
 filters
 
 makeRawVisitInfo
 
 mappings
 

Static Public Attributes

string packageName = 'base'
 
dictionary policy
 
 MakeRawVisitInfoClass = MakeRawVisitInfo
 
 PupilFactoryClass = afwCameraGeom.PupilFactory
 
 translatorClass = None
 

Detailed Description

Definition at line 28 of file baseMapper.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.test.baseMapper.BaseMapper.__init__ (   self,
  root 
)

Definition at line 41 of file baseMapper.py.

Member Function Documentation

◆ backup()

def lsst.obs.base.cameraMapper.CameraMapper.backup (   self,
  datasetType,
  dataId 
)
inherited
Rename any existing object with the given type and dataId.

The CameraMapper implementation saves objects in a sequence of e.g.:

- foo.fits
- foo.fits~1
- foo.fits~2

All of the backups will be placed in the output repo, however, and will
not be removed if they are found elsewhere in the _parent chain.  This
means that the same file will be stored twice if the previous version
was found in an input repo.

Definition at line 597 of file cameraMapper.py.

◆ bypass_camera()

def lsst.obs.base.cameraMapper.CameraMapper.bypass_camera (   self,
  datasetType,
  pythonType,
  butlerLocation,
  dataId 
)
inherited
Return the (preloaded) camera object.

Definition at line 748 of file cameraMapper.py.

◆ bypass_expIdInfo()

def lsst.obs.base.cameraMapper.CameraMapper.bypass_expIdInfo (   self,
  datasetType,
  pythonType,
  location,
  dataId 
)
inherited
Hook to retrieve an lsst.obs.base.ExposureIdInfo for an exposure

Definition at line 766 of file cameraMapper.py.

◆ getCameraName()

def lsst.obs.base.cameraMapper.CameraMapper.getCameraName (   cls)
inherited
Return the name of the camera that this CameraMapper is for.

Definition at line 691 of file cameraMapper.py.

◆ getDefaultLevel()

def lsst.obs.base.cameraMapper.CameraMapper.getDefaultLevel (   self)
inherited

Definition at line 682 of file cameraMapper.py.

◆ getDefaultSubLevel()

def lsst.obs.base.cameraMapper.CameraMapper.getDefaultSubLevel (   self,
  level 
)
inherited

Definition at line 685 of file cameraMapper.py.

◆ getGen3Instrument()

def lsst.obs.base.cameraMapper.CameraMapper.getGen3Instrument (   cls)
inherited
Return the gen3 Instrument class equivalent for this gen2 Mapper.

Returns
-------
instr : `type`
    A `~lsst.obs.base.Instrument` class.

Definition at line 709 of file cameraMapper.py.

◆ getImageCompressionSettings()

def lsst.obs.base.cameraMapper.CameraMapper.getImageCompressionSettings (   self,
  datasetType,
  dataId 
)
inherited
Stuff image compression settings into a daf.base.PropertySet

This goes into the ButlerLocation's "additionalData", which gets
passed into the boost::persistence framework.

Parameters
----------
datasetType : `str`
    Type of dataset for which to get the image compression settings.
dataId : `dict`
    Dataset identifier.

Returns
-------
additionalData : `lsst.daf.base.PropertySet`
    Image compression settings.

Definition at line 1202 of file cameraMapper.py.

◆ getKeys()

def lsst.obs.base.cameraMapper.CameraMapper.getKeys (   self,
  datasetType,
  level 
)
inherited
Return a dict of supported keys and their value types for a given
dataset type at a given level of the key hierarchy.

Parameters
----------
datasetType :  `str`
    Dataset type or None for all dataset types.
level :  `str` or None
    Level or None for all levels or '' for the default level for the
    camera.

Returns
-------
`dict`
    Keys are strings usable in a dataset identifier, values are their
    value types.

Definition at line 648 of file cameraMapper.py.

◆ getPackageDir()

def lsst.obs.base.test.baseMapper.BaseMapper.getPackageDir (   cls)
Return the base directory of this package

Reimplemented from lsst.obs.base.cameraMapper.CameraMapper.

Definition at line 46 of file baseMapper.py.

◆ getPackageName()

def lsst.obs.base.cameraMapper.CameraMapper.getPackageName (   cls)
inherited
Return the name of the package containing this CameraMapper.

Definition at line 702 of file cameraMapper.py.

◆ getRegistry()

def lsst.obs.base.cameraMapper.CameraMapper.getRegistry (   self)
inherited
Get the registry used by this mapper.

Returns
-------
Registry or None
    The registry used by this mapper for this mapper's repository.

Definition at line 1192 of file cameraMapper.py.

◆ getShortCcdName()

def lsst.obs.base.cameraMapper.CameraMapper.getShortCcdName (   ccdName)
staticinherited
Convert a CCD name to a form useful as a filename

The default implementation converts spaces to underscores.

Definition at line 958 of file cameraMapper.py.

◆ keys()

def lsst.obs.base.cameraMapper.CameraMapper.keys (   self)
inherited
Return supported keys.

Returns
-------
iterable
    List of keys usable in a dataset identifier

Definition at line 638 of file cameraMapper.py.

◆ map_camera()

def lsst.obs.base.cameraMapper.CameraMapper.map_camera (   self,
  dataId,
  write = False 
)
inherited
Map a camera dataset.

Definition at line 733 of file cameraMapper.py.

◆ map_expIdInfo()

def lsst.obs.base.cameraMapper.CameraMapper.map_expIdInfo (   self,
  dataId,
  write = False 
)
inherited

Definition at line 755 of file cameraMapper.py.

◆ map_skypolicy()

def lsst.obs.base.cameraMapper.CameraMapper.map_skypolicy (   self,
  dataId 
)
inherited
Map a sky policy.

Definition at line 788 of file cameraMapper.py.

◆ std_bfKernel()

def lsst.obs.base.cameraMapper.CameraMapper.std_bfKernel (   self,
  item,
  dataId 
)
inherited
Disable standardization for bfKernel

bfKernel is a calibration product that is numpy array,
unlike other calibration products that are all images;
all calibration images are sent through _standardizeExposure
due to CalibrationMapping, but we don't want that to happen to bfKernel

Definition at line 772 of file cameraMapper.py.

◆ std_raw()

def lsst.obs.base.cameraMapper.CameraMapper.std_raw (   self,
  item,
  dataId 
)
inherited
Standardize a raw dataset by converting it to an Exposure instead
of an Image

Definition at line 782 of file cameraMapper.py.

◆ std_skypolicy()

def lsst.obs.base.cameraMapper.CameraMapper.std_skypolicy (   self,
  item,
  dataId 
)
inherited
Standardize a sky policy by returning the one we use.

Definition at line 794 of file cameraMapper.py.

Member Data Documentation

◆ calibRegistry

lsst.obs.base.cameraMapper.CameraMapper.calibRegistry
inherited

Definition at line 255 of file cameraMapper.py.

◆ camera

lsst.obs.base.cameraMapper.CameraMapper.camera
inherited

Definition at line 273 of file cameraMapper.py.

◆ cameraDataLocation

lsst.obs.base.cameraMapper.CameraMapper.cameraDataLocation
inherited

Definition at line 272 of file cameraMapper.py.

◆ defaultLevel

lsst.obs.base.cameraMapper.CameraMapper.defaultLevel
inherited

Definition at line 214 of file cameraMapper.py.

◆ defaultSubLevels

lsst.obs.base.cameraMapper.CameraMapper.defaultSubLevels
inherited

Definition at line 215 of file cameraMapper.py.

◆ filters

lsst.obs.base.cameraMapper.CameraMapper.filters
inherited

Definition at line 276 of file cameraMapper.py.

◆ keyDict

lsst.obs.base.cameraMapper.CameraMapper.keyDict
inherited

Definition at line 266 of file cameraMapper.py.

◆ levels

lsst.obs.base.cameraMapper.CameraMapper.levels
inherited

Definition at line 209 of file cameraMapper.py.

◆ log

lsst.obs.base.cameraMapper.CameraMapper.log
inherited

Definition at line 195 of file cameraMapper.py.

◆ makeRawVisitInfo

lsst.obs.base.cameraMapper.CameraMapper.makeRawVisitInfo
inherited

Definition at line 283 of file cameraMapper.py.

◆ MakeRawVisitInfoClass

lsst.obs.base.cameraMapper.CameraMapper.MakeRawVisitInfoClass = MakeRawVisitInfo
staticinherited

Definition at line 179 of file cameraMapper.py.

◆ mappings

lsst.obs.base.cameraMapper.CameraMapper.mappings
inherited

Definition at line 336 of file cameraMapper.py.

◆ packageName

string lsst.obs.base.test.baseMapper.BaseMapper.packageName = 'base'
static

Definition at line 29 of file baseMapper.py.

◆ policy

dictionary lsst.obs.base.test.baseMapper.BaseMapper.policy
static
Initial value:
= {
"camera": "camera",
"defaultLevel": "sensor",
"datasets": {},
"exposures": {},
"calibrations": {},
"images": {}
}

Definition at line 32 of file baseMapper.py.

◆ PupilFactoryClass

lsst.obs.base.cameraMapper.CameraMapper.PupilFactoryClass = afwCameraGeom.PupilFactory
staticinherited

Definition at line 182 of file cameraMapper.py.

◆ registry

lsst.obs.base.cameraMapper.CameraMapper.registry
inherited

Definition at line 247 of file cameraMapper.py.

◆ root

lsst.obs.base.cameraMapper.CameraMapper.root
inherited

Definition at line 198 of file cameraMapper.py.

◆ rootStorage

lsst.obs.base.cameraMapper.CameraMapper.rootStorage
inherited

Definition at line 224 of file cameraMapper.py.

◆ translatorClass

lsst.obs.base.cameraMapper.CameraMapper.translatorClass = None
staticinherited

Definition at line 185 of file cameraMapper.py.


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