lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper Class Reference

Inheritance diagram for lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper:

Public Member Functions
def	__init__ (self, root, **kwargs)
def	getDefaultLevel (self)
def	getKeys (self, datasetType, level)
def	update (self)
def	keys (self)
def	bypass_camera (self, datasetType, pythonType, location, dataId)
def	map_camera (self, dataId, write=False)
def	std_calexp (self, item, dataId)
def	bypass_ccdExposureId (self, datasetType, pythonType, location, dataId)
def	bypass_ccdExposureId_bits (self, datasetType, pythonType, location, dataId)
def	bypass_deepCoaddId (self, datasetType, pythonType, location, dataId)
def	bypass_deepCoaddId_bits (self, datasetType, pythonType, location, dataId)
def	bypass_deepMergedCoaddId (self, datasetType, pythonType, location, dataId)
def	bypass_deepMergedCoaddId_bits (self, datasetType, pythonType, location, dataId)
def	bypass_deepCoadd_filterLabel (self, *args, **kwargs)
def	__new__ (cls, *args, **kwargs)
def	__getstate__ (self)
def	__setstate__ (self, state)
def	queryMetadata (self, datasetType, format, dataId)
def	getDatasetTypes (self)
def	map (self, datasetType, dataId, write=False)
def	canStandardize (self, datasetType)
def	standardize (self, datasetType, item, dataId)
def	validate (self, dataId)
def	backup (self, datasetType, dataId)
def	getRegistry (self)

Static Public Member Functions
def	splitCcdExposureId (ccdExposureId)

Public Attributes
	storage
	root
	camera
	filterLabel
	index
	keyDict

Static Public Attributes
	mappings
	levels

Detailed Description

An extremely simple mapper for an imaginary camera for use in integration tests.

As SimpleMapper does not inherit from obs.base.CameraMapper, it does not
use a policy file to set mappings or a registry; all the information is here
(in the map_* and query_* methods).

The imaginary camera's raw data format has only 'visit' and 'ccd' keys, with
two CCDs per visit (by default).

Definition at line 254 of file simpleMapper.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.__init__	(		self,
			root,
		**	kwargs
	)

Definition at line 331 of file simpleMapper.py.

    def __init__(self, root, **kwargs):
        self.storage = lsst.daf.persistence.Storage.makeFromURI(root)
        super(SimpleMapper, self).__init__(**kwargs)
        self.root = root
        self.camera = makeSimpleCamera(nX=1, nY=2, sizeX=400, sizeY=200, gapX=2, gapY=2)
        # NOTE: we set band/physical here because CoaddsTestCase.testCoaddInputs()
        # expects "r" for both the input dataIds (gen2 dataIds could be either
        # physical or band) and the output CoaddInputRecords.
        # The original data had just `Filter("r")`, so this has always assumed
        # that physicalLabel==bandLabel, even though CoaddInputRecords are physical.
        self.filterLabel = afwImage.FilterLabel(band="r", physical="r")
        self.update()
 

Member Function Documentation

__getstate__()

def lsst.daf.persistence.mapper.Mapper.__getstate__ (   self )

inherited

Definition at line 103 of file mapper.py.

    def __getstate__(self):
        return self._arguments
 

__new__()

def lsst.daf.persistence.mapper.Mapper.__new__ (   cls, *  args, **  kwargs  )

inherited

Create a new Mapper, saving arguments for pickling.

This is in __new__ instead of __init__ to save the user
from having to save the arguments themselves (either explicitly,
or by calling the super's __init__ with all their
*args,**kwargs.  The resulting pickling system (of __new__,
__getstate__ and __setstate__ is similar to how __reduce__
is usually used, except that we save the user from any
responsibility (except when overriding __new__, but that
is not common).

Definition at line 84 of file mapper.py.

    def __new__(cls, *args, **kwargs):
        """Create a new Mapper, saving arguments for pickling.
 
        This is in __new__ instead of __init__ to save the user
        from having to save the arguments themselves (either explicitly,
        or by calling the super's __init__ with all their
        *args,**kwargs.  The resulting pickling system (of __new__,
        __getstate__ and __setstate__ is similar to how __reduce__
        is usually used, except that we save the user from any
        responsibility (except when overriding __new__, but that
        is not common).
        """
        self = super().__new__(cls)
        self._arguments = (args, kwargs)
        return self
 

__setstate__()

def lsst.daf.persistence.mapper.Mapper.__setstate__ (   self,   state  )

inherited

Definition at line 106 of file mapper.py.

    def __setstate__(self, state):
        self._arguments = state
        args, kwargs = state
        self.__init__(*args, **kwargs)
 

backup()

def lsst.daf.persistence.mapper.Mapper.backup (   self,   datasetType,   dataId  )

inherited

Rename any existing object with the given type and dataId.

Not implemented in the base mapper.

Definition at line 191 of file mapper.py.

    def backup(self, datasetType, dataId):
        """Rename any existing object with the given type and dataId.
 
        Not implemented in the base mapper.
        """
        raise NotImplementedError("Base-class Mapper does not implement backups")
 

bypass_camera()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.bypass_camera	(		self,
			datasetType,
			pythonType,
			location,
			dataId
	)

Definition at line 380 of file simpleMapper.py.

    def bypass_camera(self, datasetType, pythonType, location, dataId):
        return self.camera
 

bypass_ccdExposureId()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.bypass_ccdExposureId	(		self,
			datasetType,
			pythonType,
			location,
			dataId
	)

Definition at line 414 of file simpleMapper.py.

    def bypass_ccdExposureId(self, datasetType, pythonType, location, dataId):
        return self._computeCcdExposureId(dataId)
 

bypass_ccdExposureId_bits()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.bypass_ccdExposureId_bits	(		self,
			datasetType,
			pythonType,
			location,
			dataId
	)

Definition at line 417 of file simpleMapper.py.

    def bypass_ccdExposureId_bits(self, datasetType, pythonType, location, dataId):
        return 32
 

bypass_deepCoadd_filterLabel()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.bypass_deepCoadd_filterLabel	(		self,
		*	args,
		**	kwargs
	)

To return a useful filterLabel for MergeDetectionsTask.

Definition at line 432 of file simpleMapper.py.

    def bypass_deepCoadd_filterLabel(self, *args, **kwargs):
        """To return a useful filterLabel for MergeDetectionsTask."""
        return afwImage.FilterLabel(band=self.filterLabel.bandLabel)
 
 

bypass_deepCoaddId()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.bypass_deepCoaddId	(		self,
			datasetType,
			pythonType,
			location,
			dataId
	)

Definition at line 420 of file simpleMapper.py.

    def bypass_deepCoaddId(self, datasetType, pythonType, location, dataId):
        return self._computeCoaddId(dataId)
 

bypass_deepCoaddId_bits()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.bypass_deepCoaddId_bits	(		self,
			datasetType,
			pythonType,
			location,
			dataId
	)

Definition at line 423 of file simpleMapper.py.

    def bypass_deepCoaddId_bits(self, datasetType, pythonType, location, dataId):
        return 1 + 7 + 13*2 + 3
 

bypass_deepMergedCoaddId()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.bypass_deepMergedCoaddId	(		self,
			datasetType,
			pythonType,
			location,
			dataId
	)

Definition at line 426 of file simpleMapper.py.

    def bypass_deepMergedCoaddId(self, datasetType, pythonType, location, dataId):
        return self._computeCoaddId(dataId)
 

bypass_deepMergedCoaddId_bits()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.bypass_deepMergedCoaddId_bits	(		self,
			datasetType,
			pythonType,
			location,
			dataId
	)

Definition at line 429 of file simpleMapper.py.

    def bypass_deepMergedCoaddId_bits(self, datasetType, pythonType, location, dataId):
        return 1 + 7 + 13*2 + 3
 

canStandardize()

def lsst.daf.persistence.mapper.Mapper.canStandardize (   self,   datasetType  )

inherited

Return true if this mapper can standardize an object of the given
dataset type.

Definition at line 167 of file mapper.py.

    def canStandardize(self, datasetType):
        """Return true if this mapper can standardize an object of the given
        dataset type."""
 
        return hasattr(self, 'std_' + datasetType)
 

getDatasetTypes()

def lsst.daf.persistence.mapper.Mapper.getDatasetTypes (   self )

inherited

Return a list of the mappable dataset types.

Definition at line 128 of file mapper.py.

    def getDatasetTypes(self):
        """Return a list of the mappable dataset types."""
 
        list = []
        for attr in dir(self):
            if attr.startswith("map_"):
                list.append(attr[4:])
        return list
 

getDefaultLevel()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.getDefaultLevel

(

self

)

Definition at line 344 of file simpleMapper.py.

    def getDefaultLevel(self):
        return "ccd"
 

getKeys()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.getKeys	(		self,
			datasetType,
			level
	)

Definition at line 347 of file simpleMapper.py.

    def getKeys(self, datasetType, level):
        if datasetType is None:
            keyDict = self.keyDict
        else:
            keyDict = self.mappings[datasetType].keys
        if level is not None and level in self.levels:
            keyDict = dict(keyDict)
            for lev in self.levels[level]:
                if lev in keyDict:
                    del keyDict[lev]
        return keyDict
 

getRegistry()

def lsst.daf.persistence.mapper.Mapper.getRegistry (   self )

inherited

Get the registry

Definition at line 198 of file mapper.py.

    def getRegistry(self):
        """Get the registry"""
        return None

keys()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.keys

(

self

)

Reimplemented from lsst.daf.persistence.mapper.Mapper.

Definition at line 377 of file simpleMapper.py.

    def keys(self):
        return self.keyDict
 

map()

def lsst.daf.persistence.mapper.Mapper.map (   self,   datasetType,   dataId,   write = False  )

inherited

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.

Definition at line 137 of file mapper.py.

    def map(self, 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.
        """
        func = getattr(self, 'map_' + datasetType)
        return func(self.validate(dataId), write)
 

map_camera()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.map_camera	(		self,
			dataId,
			write = False
	)

Definition at line 383 of file simpleMapper.py.

    def map_camera(self, dataId, write=False):
        return lsst.daf.persistence.ButlerLocation(
            "lsst.afw.cameraGeom.Camera", "Camera", None, [], dataId, mapper=self, storage=self.storage
        )
 

queryMetadata()

def lsst.daf.persistence.mapper.Mapper.queryMetadata (   self,   datasetType,   format,   dataId  )

inherited

Get possible values for keys given a partial data id.

:param datasetType: see documentation about the use of datasetType
:param key: this is used as the 'level' parameter
:param format:
:param dataId: see documentation about the use of dataId
:return:

Definition at line 114 of file mapper.py.

    def queryMetadata(self, datasetType, format, dataId):
        """Get possible values for keys given a partial data id.
 
        :param datasetType: see documentation about the use of datasetType
        :param key: this is used as the 'level' parameter
        :param format:
        :param dataId: see documentation about the use of dataId
        :return:
        """
        func = getattr(self, 'query_' + datasetType)
 
        val = func(format, self.validate(dataId))
        return val
 

splitCcdExposureId()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.splitCcdExposureId (   ccdExposureId )

static

Definition at line 411 of file simpleMapper.py.

    def splitCcdExposureId(ccdExposureId):
        return dict(visit=(int(ccdExposureId) // 10), ccd=(int(ccdExposureId) % 10))
 

standardize()

def lsst.daf.persistence.mapper.Mapper.standardize (   self,   datasetType,   item,   dataId  )

inherited

Standardize an object using the standardization method for its data
set type, if it exists.

Definition at line 173 of file mapper.py.

    def standardize(self, datasetType, item, dataId):
        """Standardize an object using the standardization method for its data
        set type, if it exists."""
 
        if hasattr(self, 'std_' + datasetType):
            func = getattr(self, 'std_' + datasetType)
            return func(item, self.validate(dataId))
        return item
 

std_calexp()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.std_calexp	(		self,
			item,
			dataId
	)

Definition at line 388 of file simpleMapper.py.

    def std_calexp(self, item, dataId):
        detectorId = dataId["ccd"]
        detector = self.camera[detectorId]
        item.setDetector(detector)
        item.setFilterLabel(self.filterLabel)
        return item
 

update()

def lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.update

(

self

)

Definition at line 359 of file simpleMapper.py.

    def update(self):
        filenames = os.listdir(self.root)
        rawRegex = re.compile(r"(?P<dataset>\w+)-(?P<visit>\d+)-(?P<ccd>\d).*")
        self.index = {}
        for filename in filenames:
            m = rawRegex.match(filename)
            if not m:
                continue
            index = self.index.setdefault(m.group('dataset'), dict(ccd={None: []}, visit={None: []}))
            visit = int(m.group('visit'))
            ccd = int(m.group('ccd'))
            d1 = dict(visit=visit, ccd=ccd)
            d2 = dict(visit=visit)
            index['ccd'].setdefault(visit, []).append(d1)
            index['ccd'][None].append(d1)
            index['visit'][visit] = [d2]
            index['visit'][None].append(d1)
 

validate()

def lsst.daf.persistence.mapper.Mapper.validate (   self,   dataId  )

inherited

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.

Definition at line 182 of file mapper.py.

    def validate(self, 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."""
 
        return dataId
 

Member Data Documentation

camera

lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.camera

Definition at line 335 of file simpleMapper.py.

filterLabel

lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.filterLabel

Definition at line 341 of file simpleMapper.py.

index

lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.index

Definition at line 362 of file simpleMapper.py.

keyDict

lsst.pipe.tasks.mocks.simpleMapper.MapperMeta.keyDict

inherited

Definition at line 243 of file simpleMapper.py.

levels

lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.levels

static

Initial value:

=  dict(
        visit=['ccd'],
        ccd=[],
    )

Definition at line 326 of file simpleMapper.py.

mappings

lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.mappings

static

Definition at line 266 of file simpleMapper.py.

root

lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.root

Definition at line 334 of file simpleMapper.py.

storage

lsst.pipe.tasks.mocks.simpleMapper.SimpleMapper.storage

Definition at line 332 of file simpleMapper.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/mocks/simpleMapper.py