lsst.obs.base
16.0-9-gf78d8dd
|
Public Member Functions | |
def | __init__ (self, policy, repositoryDir, root=None, registry=None, calibRoot=None, calibRegistry=None, provided=None, parentRegistry=None, repositoryCfg=None) |
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 | |
packageName = None | |
MakeRawVisitInfoClass = MakeRawVisitInfo | |
PupilFactoryClass = afwCameraGeom.PupilFactory | |
CameraMapper is a base class for mappers that handle images from a camera and products derived from them. This provides an abstraction layer between the data on disk and the code. Public methods: keys, queryMetadata, getDatasetTypes, map, canStandardize, standardize Mappers for specific data sources (e.g., CFHT Megacam, LSST simulations, etc.) should inherit this class. The CameraMapper manages datasets within a "root" directory. Note that writing to a dataset present in the input root will hide the existing dataset but not overwrite it. See #2160 for design discussion. A camera is assumed to consist of one or more rafts, each composed of multiple CCDs. Each CCD is in turn composed of one or more amplifiers (amps). A camera is also assumed to have a camera geometry description (CameraGeom object) as a policy file, a filter description (Filter class static configuration) as another policy file, and an optional defects description directory. Information from the camera geometry and defects are inserted into all Exposure objects returned. The mapper uses one or two registries to retrieve metadata about the images. The first is a registry of all raw exposures. This must contain the time of the observation. One or more tables (or the equivalent) within the registry are used to look up data identifier components that are not specified by the user (e.g. filter) and to return results for metadata queries. The second is an optional registry of all calibration data. This should contain validity start and end entries for each calibration dataset in the same timescale as the observation time. Subclasses will typically set MakeRawVisitInfoClass: MakeRawVisitInfoClass: a class variable that points to a subclass of MakeRawVisitInfo, a functor that creates an lsst.afw.image.VisitInfo from the FITS metadata of a raw image. Subclasses must provide the following methods: _extractDetectorName(self, dataId): returns the detector name for a CCD (e.g., "CFHT 21", "R:1,2 S:3,4") as used in the AFW CameraGeom class given a dataset identifier referring to that CCD or a subcomponent of it. _computeCcdExposureId(self, dataId): see below _computeCoaddExposureId(self, dataId, singleFilter): see below Subclasses may also need to override the following methods: _transformId(self, dataId): transformation of a data identifier from colloquial usage (e.g., "ccdname") to proper/actual usage (e.g., "ccd"), including making suitable for path expansion (e.g. removing commas). The default implementation does nothing. Note that this method should not modify its input parameter. getShortCcdName(self, ccdName): a static method that returns a shortened name suitable for use as a filename. The default version converts spaces to underscores. _getCcdKeyVal(self, dataId): return a CCD key and value by which to look up defects in the defects registry. The default value returns ("ccd", detector name) _mapActualToPath(self, template, actualId): convert a template path to an actual path, using the actual dataset identifier. The mapper's behaviors are largely specified by the policy file. See the MapperDictionary.paf for descriptions of the available items. The 'exposures', 'calibrations', and 'datasets' subpolicies configure mappings (see Mappings class). Common default mappings for all subclasses can be specified in the "policy/{images,exposures,calibrations,datasets}.yaml" files. This provides a simple way to add a product to all camera mappers. Functions to map (provide a path to the data given a dataset identifier dictionary) and standardize (convert data into some standard format or type) may be provided in the subclass as "map_{dataset type}" and "std_{dataset type}", respectively. If non-Exposure datasets cannot be retrieved using standard daf_persistence methods alone, a "bypass_{dataset type}" function may be provided in the subclass to return the dataset instead of using the "datasets" subpolicy. Implementations of map_camera and bypass_camera that should typically be sufficient are provided in this base class. Notes ----- TODO: - Handle defects the same was as all other calibration products, using the calibration registry - Instead of auto-loading the camera at construction time, load it from the calibration registry - Rewrite defects as AFW tables so we don't need astropy.io.fits to unpersist them; then remove all mention of astropy.io.fits from this package.
Definition at line 46 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.__init__ | ( | self, | |
policy, | |||
repositoryDir, | |||
root = None , |
|||
registry = None , |
|||
calibRoot = None , |
|||
calibRegistry = None , |
|||
provided = None , |
|||
parentRegistry = None , |
|||
repositoryCfg = None |
|||
) |
Initialize the CameraMapper. Parameters ---------- policy : daf_persistence.Policy, Can also be pexPolicy.Policy, only for backward compatibility. Policy with per-camera defaults already merged. repositoryDir : string Policy repository for the subclassing module (obtained with getRepositoryPath() on the per-camera default dictionary). root : string, optional Path to the root directory for data. registry : string, optional Path to registry with data's metadata. calibRoot : string, optional Root directory for calibrations. calibRegistry : string, optional Path to registry with calibrations' metadata. provided : list of string, optional Keys provided by the mapper. parentRegistry : Registry subclass, optional Registry from a parent repository that may be used to look up data's metadata. repositoryCfg : daf_persistence.RepositoryCfg or None, optional The configuration information for the repository this mapper is being used with.
Definition at line 162 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.backup | ( | self, | |
datasetType, | |||
dataId | |||
) |
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 560 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.bypass_camera | ( | self, | |
datasetType, | |||
pythonType, | |||
butlerLocation, | |||
dataId | |||
) |
Return the (preloaded) camera object.
Definition at line 691 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.bypass_defects | ( | self, | |
datasetType, | |||
pythonType, | |||
butlerLocation, | |||
dataId | |||
) |
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 715 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.bypass_expIdInfo | ( | self, | |
datasetType, | |||
pythonType, | |||
location, | |||
dataId | |||
) |
Hook to retrieve an lsst.obs.base.ExposureIdInfo for an exposure
Definition at line 758 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.getCameraName | ( | cls | ) |
Return the name of the camera that this CameraMapper is for.
Definition at line 654 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.getDefaultLevel | ( | self | ) |
Definition at line 645 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.getDefaultSubLevel | ( | self, | |
level | |||
) |
Definition at line 648 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.getImageCompressionSettings | ( | self, | |
datasetType, | |||
dataId | |||
) |
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 1207 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.getKeys | ( | self, | |
datasetType, | |||
level | |||
) |
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 611 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.getPackageDir | ( | cls | ) |
Return the base directory of this package
Definition at line 672 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.getPackageName | ( | cls | ) |
Return the name of the package containing this CameraMapper.
Definition at line 665 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.getRegistry | ( | self | ) |
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 1197 of file cameraMapper.py.
|
static |
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.
def lsst.obs.base.cameraMapper.CameraMapper.keys | ( | self | ) |
Return supported keys. Returns ------- iterable List of keys usable in a dataset identifier
Definition at line 601 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.map_camera | ( | self, | |
dataId, | |||
write = False |
|||
) |
Map a camera dataset.
Definition at line 676 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.map_defects | ( | self, | |
dataId, | |||
write = False |
|||
) |
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 698 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.map_expIdInfo | ( | self, | |
dataId, | |||
write = False |
|||
) |
Definition at line 747 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.map_skypolicy | ( | self, | |
dataId | |||
) |
Map a sky policy.
Definition at line 780 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.std_bfKernel | ( | self, | |
item, | |||
dataId | |||
) |
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 764 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.std_raw | ( | self, | |
item, | |||
dataId | |||
) |
Standardize a raw dataset by converting it to an Exposure instead of an Image
Definition at line 774 of file cameraMapper.py.
def lsst.obs.base.cameraMapper.CameraMapper.std_skypolicy | ( | self, | |
item, | |||
dataId | |||
) |
Standardize a sky policy by returning the one we use.
Definition at line 786 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.calibRegistry |
Definition at line 261 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.camera |
Definition at line 280 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.cameraDataLocation |
Definition at line 279 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.defaultLevel |
Definition at line 220 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.defaultSubLevels |
Definition at line 221 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.defectPath |
Definition at line 286 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.defectRegistry |
Definition at line 284 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.filters |
Definition at line 291 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.keyDict |
Definition at line 273 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.levels |
Definition at line 215 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.log |
Definition at line 193 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.makeRawVisitInfo |
Definition at line 298 of file cameraMapper.py.
|
static |
Definition at line 155 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.mappings |
Definition at line 344 of file cameraMapper.py.
|
static |
Definition at line 151 of file cameraMapper.py.
|
static |
Definition at line 158 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.registry |
Definition at line 253 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.root |
Definition at line 196 of file cameraMapper.py.
lsst.obs.base.cameraMapper.CameraMapper.rootStorage |
Definition at line 230 of file cameraMapper.py.