lsst.skymap  16.0-3-g6923fb6+7
Public Member Functions | Public Attributes | Static Public Attributes | 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)
 
def findTract (self, coord)
 
def findTractPatchList (self, coordList)
 
def findClosestTractPatchList (self, coordList)
 
def __hash__ (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def getSha1 (self)
 
def updateSha1 (self, sha1)
 
def register (self, name, registry)
 

Public Attributes

 config
 

Static Public Attributes

 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

◆ __eq__()

def lsst.skymap.baseSkyMap.BaseSkyMap.__eq__ (   self,
  other 
)
inherited

Definition at line 175 of file baseSkyMap.py.

◆ __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.

◆ __hash__()

def lsst.skymap.baseSkyMap.BaseSkyMap.__hash__ (   self)
inherited

Definition at line 172 of file baseSkyMap.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.

◆ __ne__()

def lsst.skymap.baseSkyMap.BaseSkyMap.__ne__ (   self,
  other 
)
inherited

Definition at line 181 of file baseSkyMap.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.

◆ findClosestTractPatchList()

def lsst.skymap.baseSkyMap.BaseSkyMap.findClosestTractPatchList (   self,
  coordList 
)
inherited
Find closest tract and patches that overlap coordinates

@param[in] coordList: list of ICRS sky coordinates (lsst.afw.geom.SpherePoint)
@return list of (TractInfo, list of PatchInfo) for tracts and patches that contain,
    or may contain, the specified region. The list will be empty if there is no overlap.

Definition at line 148 of file baseSkyMap.py.

◆ findTract()

def lsst.skymap.baseSkyMap.BaseSkyMap.findTract (   self,
  coord 
)
inherited
Find the tract whose center is nearest the specified coord.

@param[in] coord: ICRS sky coordinate (lsst.afw.geom.SpherePoint)
@return TractInfo of tract whose center is nearest the specified coord

@warning:
- if tracts do not cover the whole sky then the returned tract may not include the coord

@note
- This routine will be more efficient if coord is ICRS.
- If coord is equidistant between multiple sky tract centers then one is arbitrarily chosen.
- The default implementation is not very efficient; subclasses may wish to override.

Definition at line 109 of file baseSkyMap.py.

◆ findTractPatchList()

def lsst.skymap.baseSkyMap.BaseSkyMap.findTractPatchList (   self,
  coordList 
)
inherited
Find tracts and patches that overlap a region

@param[in] coordList: list of ICRS sky coordinates (lsst.afw.geom.SpherePoint)
@return list of (TractInfo, list of PatchInfo) for tracts and patches that contain,
    or may contain, the specified region. The list will be empty if there is no overlap.

@warning this uses a naive algorithm that may find some tracts and patches that do not overlap
    the region (especially if the region is not a rectangle aligned along patch x,y).

Definition at line 131 of file baseSkyMap.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.

◆ getSha1()

def lsst.skymap.baseSkyMap.BaseSkyMap.getSha1 (   self)
inherited
Return a SHA1 hash that uniquely identifies this SkyMap instance.

Returns
-------
sha1 : bytes
    A 20-byte hash that uniquely identifies this SkyMap instance.

Subclasses should almost always override `updateSha1()` instead of
this function to add subclass-specific state to the hash.

Definition at line 184 of file baseSkyMap.py.

◆ register()

def lsst.skymap.baseSkyMap.BaseSkyMap.register (   self,
  name,
  registry 
)
inherited
Add SkyMap, Tract, and Patch DataUnits to the given Gen3 Butler Registry.

Definition at line 228 of file baseSkyMap.py.

◆ updateSha1()

def lsst.skymap.baseSkyMap.BaseSkyMap.updateSha1 (   self,
  sha1 
)
inherited
Add subclass-specific state or configuration options to the SHA1.

Parameters
----------
sha1 : hashlib.sha1
    A hashlib object on which `update()` can be called to add
    additional state to the hash.

This method is conceptually "protected": it should be reimplemented by
all subclasses, but called only by the base class implementation of
`getSha1()`.

Definition at line 213 of file baseSkyMap.py.

Member Data Documentation

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config
inherited

Definition at line 100 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.baseSkyMap.BaseSkyMap.ConfigClass = BaseSkyMapConfig
staticinherited

Definition at line 90 of file baseSkyMap.py.


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