lsst.skymap  13.0-5-g2a40766+26
Public Member Functions | List of all members
lsst.skymap.cachingSkyMap.CachingSkyMap Class Reference
Inheritance diagram for lsst.skymap.cachingSkyMap.CachingSkyMap:
lsst.skymap.baseSkyMap.BaseSkyMap lsst.skymap.discreteSkyMap.DiscreteSkyMap lsst.skymap.healpixSkyMap.HealpixSkyMap lsst.skymap.ringsSkyMap.RingsSkyMap

Public Member Functions

def __init__ (self, numTracts, config=None, version=0)
 
def __reduce__ (self)
 
def __iter__ (self)
 
def __len__ (self)
 
def __getitem__ (self, index)
 
def generateTract (self, index)
 
- Public Member Functions inherited from lsst.skymap.baseSkyMap.BaseSkyMap
def __init__ (self, config=None)
 
def findTract (self, coord)
 
def findTractPatchList (self, coordList)
 
def findClosestTractPatchList (self, coordList)
 
def __getitem__ (self, ind)
 
def __iter__ (self)
 
def __len__ (self)
 

Additional Inherited Members

- Public Attributes inherited from lsst.skymap.baseSkyMap.BaseSkyMap
 config
 
- Static Public Attributes inherited from lsst.skymap.baseSkyMap.BaseSkyMap
 ConfigClass = BaseSkyMapConfig
 

Detailed Description

A SkyMap that generates its tracts on request and caches them

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__()

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

Definition at line 39 of file cachingSkyMap.py.

Member Function Documentation

◆ __getitem__()

def 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.

Definition at line 66 of file cachingSkyMap.py.

◆ __iter__()

def lsst.skymap.cachingSkyMap.CachingSkyMap.__iter__ (   self)
Iterator over tracts

Definition at line 57 of file cachingSkyMap.py.

◆ __len__()

def lsst.skymap.cachingSkyMap.CachingSkyMap.__len__ (   self)
Length is number of tracts

Definition at line 62 of file cachingSkyMap.py.

◆ __reduce__()

def lsst.skymap.cachingSkyMap.CachingSkyMap.__reduce__ (   self)
To support pickling

Warning: This method assumes that the constructor should 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 46 of file cachingSkyMap.py.

◆ generateTract()

def lsst.skymap.cachingSkyMap.CachingSkyMap.generateTract (   self,
  index 
)
Generate the TractInfo for the particular index

Definition at line 80 of file cachingSkyMap.py.


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