lsst.skymap  17.0.1-3-g9d8f394+3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.skymap.equatSkyMap.EquatSkyMap Class Reference
Inheritance diagram for lsst.skymap.equatSkyMap.EquatSkyMap:
lsst.skymap.baseSkyMap.BaseSkyMap

Public Member Functions

def __init__ (self, config=None)
 
def __getstate__ (self)
 
def __setstate__ (self, stateDict)
 
def getVersion (self)
 
def updateSha1 (self, sha1)
 
def findTract (self, coord)
 
def findTractPatchList (self, coordList)
 
def findClosestTractPatchList (self, coordList)
 
def __getitem__ (self, ind)
 
def __iter__ (self)
 
def __len__ (self)
 
def __hash__ (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def getSha1 (self)
 
def register (self, name, registry)
 

Public Attributes

 config
 

Static Public Attributes

 ConfigClass = EquatSkyMapConfig
 

Detailed Description

Equatorial sky map pixelization, e.g. for SDSS stripe 82 image data.

EquatSkyMap represents an equatorial band of sky divided along declination
into overlapping tracts.

Parameters
----------
config : `lsst.skymap.BaseSkyMapConfig` (optional)
    The configuration for this SkyMap; if None use the default config.

Definition at line 50 of file equatSkyMap.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.skymap.equatSkyMap.EquatSkyMap.__init__ (   self,
  config = None 
)

Definition at line 64 of file equatSkyMap.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 211 of file baseSkyMap.py.

◆ __getitem__()

def lsst.skymap.baseSkyMap.BaseSkyMap.__getitem__ (   self,
  ind 
)
inherited

Definition at line 199 of file baseSkyMap.py.

◆ __getstate__()

def lsst.skymap.equatSkyMap.EquatSkyMap.__getstate__ (   self)
Support pickle.

Returns
-------
stateDict : `dict`
    a dict containing:
    - version: a pair of ints
    - config: the config

Definition at line 101 of file equatSkyMap.py.

◆ __hash__()

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

Definition at line 208 of file baseSkyMap.py.

◆ __iter__()

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

Definition at line 202 of file baseSkyMap.py.

◆ __len__()

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

Definition at line 205 of file baseSkyMap.py.

◆ __ne__()

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

Definition at line 217 of file baseSkyMap.py.

◆ __setstate__()

def lsst.skymap.equatSkyMap.EquatSkyMap.__setstate__ (   self,
  stateDict 
)
Support unpickle

Parameters
----------
stateDict : `dict`
    a dict containing:
    - version: a pair of ints
    - config: the config

Definition at line 116 of file equatSkyMap.py.

◆ findClosestTractPatchList()

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

Parameters
----------
coordList : `lsst.geom.SpherePoint`
    List of ICRS sky coordinates to search for.

Returns
-------
retList : `list`
    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 176 of file baseSkyMap.py.

◆ findTract()

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

Parameters
----------
coord : `lsst.geom.SpherePoint`
    ICRS sky coordinate to search for.

Returns
-------
result : `TractInfo`
    TractInfo of tract whose center is nearest the specified coord.

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

**Warning:**
If tracts do not cover the whole sky then the returned tract may not
include the coord.

Definition at line 115 of file baseSkyMap.py.

◆ findTractPatchList()

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

Parameters
----------
coordList : `list` of `lsst.geom.SpherePoint`
    List of ICRS sky coordinates to search for.

Returns
-------
reList : `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.

Notes
-----
**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 148 of file baseSkyMap.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.

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

Definition at line 220 of file baseSkyMap.py.

◆ getVersion()

def lsst.skymap.equatSkyMap.EquatSkyMap.getVersion (   self)
Return version (e.g. for pickle).

Returns
-------
result : `tuple` of `int`
    Version as a pair of integers.

Definition at line 131 of file equatSkyMap.py.

◆ register()

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

Parameters
----------
name : `str`
    The name of the skymap.
registry : `lsst.daf.butler.Registry`
    The registry to add to.

Definition at line 268 of file baseSkyMap.py.

◆ updateSha1()

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

Definition at line 141 of file equatSkyMap.py.

Member Data Documentation

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config
inherited

Definition at line 106 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.equatSkyMap.EquatSkyMap.ConfigClass = EquatSkyMapConfig
static

Definition at line 61 of file equatSkyMap.py.


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