lsst.skymap.cachingSkyMap.CachingSkyMap Class Reference

Inheritance diagram for lsst.skymap.cachingSkyMap.CachingSkyMap:

Public Member Functions
	__init__ (self, numTracts, config=None, version=0)
	__reduce__ (self)
	__iter__ (self)
	__len__ (self)
	__getitem__ (self, index)
	generateTract (self, index)

Public Attributes
	config

Protected Attributes
	_numTracts
	_tractCache
	_tractInfo
	_version

Detailed Description

A SkyMap that generates its tracts on request and caches them.

Parameters
----------
numTracts : `int`
    Number of tracts to create.
config : `lsst.skymap.BaseSkyMapConfig` (optional)
    The configuration for this SkyMap; if None use the default config.
version : `int` or `tuple` of `int` (optional)
    Software version of this class, to retain compatibility with old
    instances.

Notes
-----
A subclass should define
* __init__ to calculate the required number of tracts (and pass it up)
* generateTract to generate a tract

Subclassers should also check that the arguments to the constructor are
consistent with the below __reduce__ method.

Definition at line 28 of file cachingSkyMap.py.

Constructor & Destructor Documentation

__init__()

lsst.skymap.cachingSkyMap.CachingSkyMap.__init__	(		self,
			numTracts,
			config = None,
			version = 0 )

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Reimplemented in lsst.skymap.discreteSkyMap.DiscreteSkyMap, lsst.skymap.healpixSkyMap.HealpixSkyMap, and lsst.skymap.ringsSkyMap.RingsSkyMap.

Definition at line 51 of file cachingSkyMap.py.

    def __init__(self, numTracts, config=None, version=0):
        super(CachingSkyMap, self).__init__(config)
        self._numTracts = numTracts
        self._tractCache = [None] * self._numTracts
        self._tractInfo = None  # We shouldn't need this; we will generate tracts on demand
        self._version = version
 

Member Function Documentation

__getitem__()

lsst.skymap.cachingSkyMap.CachingSkyMap.__getitem__	(		self,
			index )

Get the TractInfo for a particular index.

The tract is returned from a cache, if available, otherwise generated
on the fly.

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 80 of file cachingSkyMap.py.

    def __getitem__(self, index):
        """Get the TractInfo for a particular index.
 
        The tract is returned from a cache, if available, otherwise generated
        on the fly.
        """
        if index < 0 or index > self._numTracts:
            raise IndexError("Index out of range: %d vs %d" % (index, self._numTracts))
        if self._tractCache[index] is not None:
            return self._tractCache[index]
        tract = self.generateTract(index)
        self._tractCache[index] = tract
        return tract
 

__iter__()

lsst.skymap.cachingSkyMap.CachingSkyMap.__iter__

(

self

)

Iterator over tracts.

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 71 of file cachingSkyMap.py.

    def __iter__(self):
        """Iterator over tracts."""
        for i in range(self._numTracts):
            yield self[i]
 

__len__()

lsst.skymap.cachingSkyMap.CachingSkyMap.__len__

(

self

)

Length is number of tracts.

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 76 of file cachingSkyMap.py.

    def __len__(self):
        """Length is number of tracts."""
        return self._numTracts
 

__reduce__()

lsst.skymap.cachingSkyMap.CachingSkyMap.__reduce__

(

self

)

To support pickling.

Notes
-----
**Warning:** This method assumes that the constructor is be defined:
    __init__(self, config, version=defaultVersion)
The use of 'config' is effectively set by the registry mechanism.
If additional optional arguments are added, this method should be
overridden to correspond.

Definition at line 58 of file cachingSkyMap.py.

    def __reduce__(self):
        """To support pickling.
 
        Notes
        -----
        **Warning:** This method assumes that the constructor is be defined:
            __init__(self, config, version=defaultVersion)
        The use of 'config' is effectively set by the registry mechanism.
        If additional optional arguments are added, this method should be
        overridden to correspond.
        """
        return (self.__class__, (self.config, self._version))
 

generateTract()

lsst.skymap.cachingSkyMap.CachingSkyMap.generateTract	(		self,
			index )

Generate TractInfo for the specified tract index.

Reimplemented in lsst.skymap.discreteSkyMap.DiscreteSkyMap, lsst.skymap.healpixSkyMap.HealpixSkyMap, and lsst.skymap.ringsSkyMap.RingsSkyMap.

Definition at line 94 of file cachingSkyMap.py.

    def generateTract(self, index):
        """Generate TractInfo for the specified tract index."""
        raise NotImplementedError("Subclasses must define this method.")

Member Data Documentation

_numTracts

lsst.skymap.cachingSkyMap.CachingSkyMap._numTracts

protected

Definition at line 53 of file cachingSkyMap.py.

_tractCache

lsst.skymap.cachingSkyMap.CachingSkyMap._tractCache

protected

Definition at line 54 of file cachingSkyMap.py.

_tractInfo

lsst.skymap.cachingSkyMap.CachingSkyMap._tractInfo

protected

Definition at line 55 of file cachingSkyMap.py.

_version

lsst.skymap.cachingSkyMap.CachingSkyMap._version

protected

Definition at line 56 of file cachingSkyMap.py.

config

lsst.skymap.cachingSkyMap.CachingSkyMap.config

Definition at line 69 of file cachingSkyMap.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/skymap/ga8c6da7877+4cf350ccb2/python/lsst/skymap/cachingSkyMap.py