DecamMapper¶

class lsst.obs.decam.DecamMapper(inputPolicy=None, **kwargs)¶

Bases: lsst.obs.base.CameraMapper

Attributes Summary

`detectorNames`
`packageName`
`translatorClass`

Methods Summary

`Mapper`(cfg)	Instantiate a Mapper from a configuration.
`backup`(datasetType, dataId)	Rename any existing object with the given type and dataId.
`bypass_camera`(datasetType, pythonType, …)	Return the (preloaded) camera object.
`bypass_ccdExposureId`(datasetType, …)
`bypass_ccdExposureId_bits`(datasetType, …)
`bypass_dcrCoaddId`(datasetType, pythonType, …)
`bypass_dcrCoaddId_bits`(args, *kwargs)
`bypass_dcrMergedCoaddId`(datasetType, …)
`bypass_dcrMergedCoaddId_bits`(args, *kwargs)
`bypass_deepCoaddId`(datasetType, pythonType, …)
`bypass_deepCoaddId_bits`(args, *kwargs)
`bypass_deepMergedCoaddId`(datasetType, …)
`bypass_deepMergedCoaddId_bits`(args, *kwargs)
`bypass_expIdInfo`(datasetType, pythonType, …)	Hook to retrieve an lsst.obs.base.ExposureIdInfo for an exposure
`bypass_instcal`(datasetType, pythonType, …)
`canStandardize`(datasetType)	Return true if this mapper can standardize an object of the given dataset type.
`getCameraName`()	Return the name of the camera that this CameraMapper is for.
`getCrosstalkDir`()	Directory containing crosstalk tables.
`getDatasetTypes`()	Return a list of the mappable dataset types.
`getDefaultLevel`()
`getDefaultSubLevel`(level)
`getGen3Instrument`()	Return the gen3 Instrument class equivalent for this gen2 Mapper.
`getImageCompressionSettings`(datasetType, dataId)	Stuff image compression settings into a daf.base.PropertySet
`getKeys`(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.
`getLinearizerDir`()	Directory containing linearizers
`getPackageDir`()	Return the base directory of this package
`getPackageName`()	Return the name of the package containing this CameraMapper.
`getRegistry`()	Get the registry used by this mapper.
`getShortCcdName`(ccdName)	Convert a CCD name to a form useful as a filename
`keys`()	Return supported keys.
`map`(datasetType, dataId[, write])	Map a data id using the mapping method for its dataset type.
`map_camera`(dataId[, write])	Map a camera dataset.
`map_expIdInfo`(dataId[, write])
`map_linearizer`(dataId[, write])	Map a linearizer
`map_skypolicy`(dataId)	Map a sky policy.
`queryMetadata`(datasetType, format, dataId)	Get possible values for keys given a partial data id.
`standardize`(datasetType, item, dataId)	Standardize an object using the standardization method for its data set type, if it exists.
`std_bfKernel`(item, dataId)	Disable standardization for bfKernel
`std_bias`(item, dataId)
`std_cpBias`(item, dataId)
`std_cpFlat`(item, dataId)
`std_cpIllumcor`(item, dataId)
`std_dark`(item, dataId)
`std_flat`(item, dataId)
`std_fringe`(item, dataId)
`std_illumcor`(item, dataId)
`std_raw`(item, dataId)	Standardize a raw dataset by converting it to an Exposure.
`std_skypolicy`(item, dataId)	Standardize a sky policy by returning the one we use.
`translate_dqmask`(dqmask)
`translate_wtmap`(wtmap)
`validate`(dataId)	Validate a dataId’s contents.

Attributes Documentation

detectorNames = {1: 'S29', 2: 'S30', 3: 'S31', 4: 'S25', 5: 'S26', 6: 'S27', 7: 'S28', 8: 'S20', 9: 'S21', 10: 'S22', 11: 'S23', 12: 'S24', 13: 'S14', 14: 'S15', 15: 'S16', 16: 'S17', 17: 'S18', 18: 'S19', 19: 'S8', 20: 'S9', 21: 'S10', 22: 'S11', 23: 'S12', 24: 'S13', 25: 'S1', 26: 'S2', 27: 'S3', 28: 'S4', 29: 'S5', 30: 'S6', 31: 'S7', 32: 'N1', 33: 'N2', 34: 'N3', 35: 'N4', 36: 'N5', 37: 'N6', 38: 'N7', 39: 'N8', 40: 'N9', 41: 'N10', 42: 'N11', 43: 'N12', 44: 'N13', 45: 'N14', 46: 'N15', 47: 'N16', 48: 'N17', 49: 'N18', 50: 'N19', 51: 'N20', 52: 'N21', 53: 'N22', 54: 'N23', 55: 'N24', 56: 'N25', 57: 'N26', 58: 'N27', 59: 'N28', 60: 'N29', 62: 'N31'}¶

packageName = 'obs_decam'¶

translatorClass = None¶

Methods Documentation

static Mapper(cfg)¶

Instantiate a Mapper from a configuration. In come cases the cfg may have already been instantiated into a Mapper, this is allowed and the input var is simply returned.

Parameters:	cfg – the cfg for this mapper. It is recommended this be created by calling Mapper.cfg()
Returns:	a Mapper instance

backup(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.

bypass_camera(datasetType, pythonType, butlerLocation, dataId)¶: Return the (preloaded) camera object.

bypass_ccdExposureId(datasetType, pythonType, location, dataId)¶

bypass_ccdExposureId_bits(datasetType, pythonType, location, dataId)¶

bypass_dcrCoaddId(datasetType, pythonType, location, dataId)¶

bypass_dcrCoaddId_bits(*args, **kwargs)¶

bypass_dcrMergedCoaddId(datasetType, pythonType, location, dataId)¶

bypass_dcrMergedCoaddId_bits(*args, **kwargs)¶

bypass_deepCoaddId(datasetType, pythonType, location, dataId)¶

bypass_deepCoaddId_bits(*args, **kwargs)¶

bypass_deepMergedCoaddId(datasetType, pythonType, location, dataId)¶

bypass_deepMergedCoaddId_bits(*args, **kwargs)¶

bypass_expIdInfo(datasetType, pythonType, location, dataId)¶: Hook to retrieve an lsst.obs.base.ExposureIdInfo for an exposure

bypass_instcal(datasetType, pythonType, butlerLocation, dataId)¶

canStandardize(datasetType)¶: Return true if this mapper can standardize an object of the given dataset type.

classmethod getCameraName()¶: Return the name of the camera that this CameraMapper is for.

classmethod getCrosstalkDir()¶: Directory containing crosstalk tables.

getDatasetTypes()¶: Return a list of the mappable dataset types.

getDefaultLevel()¶

getDefaultSubLevel(level)¶

classmethod getGen3Instrument()¶

Return the gen3 Instrument class equivalent for this gen2 Mapper.

Returns:	instr : `type` A `Instrument` class.

getImageCompressionSettings(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.

getKeys(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.

classmethod getLinearizerDir()¶: Directory containing linearizers

classmethod getPackageDir()¶: Return the base directory of this package

classmethod getPackageName()¶: Return the name of the package containing this CameraMapper.

getRegistry()¶

Get the registry used by this mapper.

Returns:	Registry or None The registry used by this mapper for this mapper’s repository.

static getShortCcdName(ccdName)¶

Convert a CCD name to a form useful as a filename

The default implementation converts spaces to underscores.

keys()¶

Return supported keys.

Returns:	iterable List of keys usable in a dataset identifier

map(datasetType, dataId, write=False)¶

Map a data id using the mapping method for its dataset type.

Parameters:	datasetType : string The datasetType to map dataId : DataId instance The dataId to use when mapping write : bool, optional Indicates if the map is being performed for a read operation (False) or a write operation (True)
Returns:	ButlerLocation or a list of ButlerLocation The location(s) found for the map operation. If write is True, a list is returned. If write is False a single ButlerLocation is returned.
Raises:	NoResults If no locaiton was found for this map operation, the derived mapper class may raise a lsst.daf.persistence.NoResults exception. Butler catches this and will look in the next Repository if there is one.

map_camera(dataId, write=False)¶: Map a camera dataset.

map_expIdInfo(dataId, write=False)¶

map_linearizer(dataId, write=False)¶: Map a linearizer

map_skypolicy(dataId)¶: Map a sky policy.

queryMetadata(datasetType, format, dataId)¶

Get possible values for keys given a partial data id.

Parameters:	datasetType – see documentation about the use of datasetType key – this is used as the ‘level’ parameter format – dataId – see documentation about the use of dataId
Returns:

standardize(datasetType, item, dataId)¶: Standardize an object using the standardization method for its data set type, if it exists.

std_bfKernel(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

std_bias(item, dataId)¶

std_cpBias(item, dataId)¶

std_cpFlat(item, dataId)¶

std_cpIllumcor(item, dataId)¶

std_dark(item, dataId)¶

std_flat(item, dataId)¶

std_fringe(item, dataId)¶

std_illumcor(item, dataId)¶

std_raw(item, dataId)¶

Standardize a raw dataset by converting it to an Exposure.

Raw images are MEF files with one HDU for each detector.

Parameters:	item : `lsst.afw.image.DecoratedImage` The image read by the butler. dataId : data ID Data identifier.
Returns:	result : `lsst.afw.image.Exposure` The standardized Exposure.

std_skypolicy(item, dataId)¶: Standardize a sky policy by returning the one we use.

translate_dqmask(dqmask)¶

translate_wtmap(wtmap)¶

validate(dataId)¶

Validate a dataId’s contents.

If the dataId is valid, return it. If an invalid component can be transformed into a valid one, copy the dataId, fix the component, and return the copy. Otherwise, raise an exception.

Navigation

DecamMapper¶