lsst.obs.base  15.0-5-ga70c291+6
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.obs.base.test.compositeMapper.CompositeMapper Class Reference
Inheritance diagram for lsst.obs.base.test.compositeMapper.CompositeMapper:
lsst.obs.base.cameraMapper.CameraMapper

Public Member Functions

def __init__ (self, root, policy=None, kwargs)
 
def std_stdTestType (self, item, dataId)
 
def bypass_bypassTestType (self, datasetType, pythonType, location, dataId)
 
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 getPackageDir (cls)
 
def map_camera (self, dataId, write=False)
 
def bypass_camera (self, datasetType, pythonType, butlerLocation, dataId)
 
def map_defects (self, dataId, write=False)
 
def bypass_defects (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
 
 defectRegistry
 
 defectPath
 
 filters
 
 makeRawVisitInfo
 
 mappings
 

Static Public Attributes

string packageName = "obs_base"
 
 MakeRawVisitInfoClass = MakeRawVisitInfo
 
 PupilFactoryClass = afwCameraGeom.PupilFactory
 

Detailed Description

Definition at line 33 of file compositeMapper.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base.test.compositeMapper.CompositeMapper.__init__ (   self,
  root,
  policy = None,
  kwargs 
)

Definition at line 36 of file compositeMapper.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 555 of file cameraMapper.py.

◆ bypass_bypassTestType()

def lsst.obs.base.test.compositeMapper.CompositeMapper.bypass_bypassTestType (   self,
  datasetType,
  pythonType,
  location,
  dataId 
)

Definition at line 50 of file compositeMapper.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 685 of file cameraMapper.py.

◆ bypass_defects()

def lsst.obs.base.cameraMapper.CameraMapper.bypass_defects (   self,
  datasetType,
  pythonType,
  butlerLocation,
  dataId 
)
inherited
Return a defect based on the butler location returned by map_defects

Parameters
----------
butlerLocation : `lsst.daf.persistence.ButlerLocation`
    locationList = path to defects FITS file
dataId : `dict`
    Butler data ID; "ccd" must be set.

Note: the name "bypass_XXX" means the butler makes no attempt to convert the ButlerLocation
into an object, which is what we want for now, since that conversion is a bit tricky.

Definition at line 709 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 751 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 648 of file cameraMapper.py.

◆ getDefaultLevel()

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

Definition at line 639 of file cameraMapper.py.

◆ getDefaultSubLevel()

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

Definition at line 642 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 1194 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 605 of file cameraMapper.py.

◆ getPackageDir()

def lsst.obs.base.cameraMapper.CameraMapper.getPackageDir (   cls)
inherited
Return the base directory of this package

Definition at line 666 of file cameraMapper.py.

◆ getPackageName()

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

Definition at line 659 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 1184 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 949 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 595 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 670 of file cameraMapper.py.

◆ map_defects()

def lsst.obs.base.cameraMapper.CameraMapper.map_defects (   self,
  dataId,
  write = False 
)
inherited
Map defects dataset.

Returns
-------
`lsst.daf.butler.ButlerLocation`
    Minimal ButlerLocation containing just the locationList field
    (just enough information that bypass_defects can use it).

Definition at line 692 of file cameraMapper.py.

◆ map_expIdInfo()

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

Definition at line 740 of file cameraMapper.py.

◆ map_skypolicy()

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

Definition at line 772 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 757 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 767 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 778 of file cameraMapper.py.

◆ std_stdTestType()

def lsst.obs.base.test.compositeMapper.CompositeMapper.std_stdTestType (   self,
  item,
  dataId 
)

Definition at line 46 of file compositeMapper.py.

Member Data Documentation

◆ calibRegistry

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

Definition at line 258 of file cameraMapper.py.

◆ camera

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

Definition at line 277 of file cameraMapper.py.

◆ cameraDataLocation

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

Definition at line 276 of file cameraMapper.py.

◆ defaultLevel

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

Definition at line 217 of file cameraMapper.py.

◆ defaultSubLevels

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

Definition at line 218 of file cameraMapper.py.

◆ defectPath

lsst.obs.base.cameraMapper.CameraMapper.defectPath
inherited

Definition at line 283 of file cameraMapper.py.

◆ defectRegistry

lsst.obs.base.cameraMapper.CameraMapper.defectRegistry
inherited

Definition at line 281 of file cameraMapper.py.

◆ filters

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

Definition at line 288 of file cameraMapper.py.

◆ keyDict

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

Definition at line 270 of file cameraMapper.py.

◆ levels

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

Definition at line 212 of file cameraMapper.py.

◆ log

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

Definition at line 190 of file cameraMapper.py.

◆ makeRawVisitInfo

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

Definition at line 295 of file cameraMapper.py.

◆ MakeRawVisitInfoClass

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

Definition at line 152 of file cameraMapper.py.

◆ mappings

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

Definition at line 339 of file cameraMapper.py.

◆ packageName

string lsst.obs.base.test.compositeMapper.CompositeMapper.packageName = "obs_base"
static

Definition at line 34 of file compositeMapper.py.

◆ PupilFactoryClass

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

Definition at line 155 of file cameraMapper.py.

◆ registry

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

Definition at line 250 of file cameraMapper.py.

◆ root

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

Definition at line 193 of file cameraMapper.py.

◆ rootStorage

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

Definition at line 227 of file cameraMapper.py.


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