lsst.skymap  14.0-4-g3609236+11
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.skymap.ringsSkyMap.RingsSkyMap Class Reference
Inheritance diagram for lsst.skymap.ringsSkyMap.RingsSkyMap:
lsst.skymap.cachingSkyMap.CachingSkyMap lsst.skymap.baseSkyMap.BaseSkyMap

Public Member Functions

def __init__ (self, config, version=0)
 
def getRingIndices (self, index)
 
def generateTract (self, index)
 
def findTract (self, coord)
 
def findAllTracts (self, coord)
 
def findTractPatchList (self, coordList)
 
def updateSha1 (self, sha1)
 
def __reduce__ (self)
 
def __iter__ (self)
 
def __len__ (self)
 
def __getitem__ (self, index)
 
def findClosestTractPatchList (self, coordList)
 
def __hash__ (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def getSha1 (self)
 

Public Attributes

 config
 

Static Public Attributes

 ConfigClass = RingsSkyMapConfig
 

Detailed Description

Rings sky map pixelization.

We divide the sphere into N rings of Declination, plus the two polar
caps, which sets the size of the individual tracts.  The rings are
divided in RA into an integral number of tracts of this size; this
division is made at the Declination closest to zero so as to ensure
full overlap.

Definition at line 43 of file ringsSkyMap.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.skymap.ringsSkyMap.RingsSkyMap.__init__ (   self,
  config,
  version = 0 
)
Constructor

@param[in] config: an instance of self.ConfigClass; if None the default config is used
@param[in] version: software version of this class, to retain compatibility with old instances

Definition at line 55 of file ringsSkyMap.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 176 of file baseSkyMap.py.

◆ __getitem__()

def lsst.skymap.cachingSkyMap.CachingSkyMap.__getitem__ (   self,
  index 
)
inherited
Get the TractInfo for a particular index

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

Definition at line 67 of file cachingSkyMap.py.

◆ __hash__()

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

Definition at line 173 of file baseSkyMap.py.

◆ __iter__()

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

Definition at line 58 of file cachingSkyMap.py.

◆ __len__()

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

Definition at line 63 of file cachingSkyMap.py.

◆ __ne__()

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

Definition at line 182 of file baseSkyMap.py.

◆ __reduce__()

def lsst.skymap.cachingSkyMap.CachingSkyMap.__reduce__ (   self)
inherited
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 47 of file cachingSkyMap.py.

◆ findAllTracts()

def lsst.skymap.ringsSkyMap.RingsSkyMap.findAllTracts (   self,
  coord 
)
Find all tracts which include the specified coord.

@param[in] coord: sky coordinate (afwCoord.Coord)
@return List of TractInfo of tracts which include the specified coord

@note
- This routine will be more efficient if coord is ICRS.

Definition at line 147 of file ringsSkyMap.py.

◆ findClosestTractPatchList()

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

@param[in] coordList: list of sky coordinates (afwCoord.Coord)
@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 149 of file baseSkyMap.py.

◆ findTract()

def lsst.skymap.ringsSkyMap.RingsSkyMap.findTract (   self,
  coord 
)
Find the tract whose center is nearest the specified coord.

@param[in] coord: sky coordinate (afwCoord.Coord)
@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 111 of file ringsSkyMap.py.

◆ findTractPatchList()

def lsst.skymap.ringsSkyMap.RingsSkyMap.findTractPatchList (   self,
  coordList 
)
Find tracts and patches that overlap a region

@param[in] coordList: list of sky coordinates (afwCoord.Coord)
@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 197 of file ringsSkyMap.py.

◆ generateTract()

def lsst.skymap.ringsSkyMap.RingsSkyMap.generateTract (   self,
  index 
)
Generate the TractInfo for this index

Definition at line 94 of file ringsSkyMap.py.

◆ getRingIndices()

def lsst.skymap.ringsSkyMap.RingsSkyMap.getRingIndices (   self,
  index 
)
Calculate ring indices given a numerical index of a tract

The ring indices are the ring number and the tract number within
the ring.

The ring number is -1 for the south polar cap and increases to the
north.  The north polar cap has ring number = numRings.  The tract
number is zero for either of the polar caps.

Definition at line 73 of file ringsSkyMap.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 185 of file baseSkyMap.py.

◆ updateSha1()

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

Definition at line 215 of file ringsSkyMap.py.

Member Data Documentation

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config
inherited

Definition at line 101 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.ringsSkyMap.RingsSkyMap.ConfigClass = RingsSkyMapConfig
static

Definition at line 52 of file ringsSkyMap.py.


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