lsst.skymap  22.0.1-3-g997b569+171bbdfcff
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.skymap.dodecaSkyMap.DodecaSkyMap Class Reference
Inheritance diagram for lsst.skymap.dodecaSkyMap.DodecaSkyMap:
lsst.skymap.baseSkyMap.BaseSkyMap

Public Member Functions

def __init__ (self, config=None)
 
def __getstate__ (self)
 
def __setstate__ (self, stateDict)
 
def findTract (self, coord)
 
def getVersion (self)
 
def getWithTractsOnPoles (self)
 
def updateSha1 (self, sha1)
 
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 logSkyMapInfo (self, log)
 
def getSha1 (self)
 
def register (self, name, butler)
 

Public Attributes

 config
 

Static Public Attributes

 ConfigClass = DodecaSkyMapConfig
 
string SKYMAP_RUN_COLLECTION_NAME = "skymaps"
 
string SKYMAP_DATASET_TYPE_NAME = "skyMap"
 

Detailed Description

Dodecahedron-based sky map pixelization.

DodecaSkyMap divides the sky into 12 overlapping Tracts arranged as the
faces of a dodecahedron.

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

Definition at line 54 of file dodecaSkyMap.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.__init__ (   self,
  config = None 
)

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 68 of file dodecaSkyMap.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 212 of file baseSkyMap.py.

◆ __getitem__()

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

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 200 of file baseSkyMap.py.

◆ __getstate__()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.__getstate__ (   self)
Support pickle.

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

Definition at line 95 of file dodecaSkyMap.py.

◆ __hash__()

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

Definition at line 209 of file baseSkyMap.py.

◆ __iter__()

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

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 203 of file baseSkyMap.py.

◆ __len__()

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

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 206 of file baseSkyMap.py.

◆ __ne__()

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

Definition at line 218 of file baseSkyMap.py.

◆ __setstate__()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.__setstate__ (   self,
  stateDict 
)
Support unpickle

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

Definition at line 110 of file dodecaSkyMap.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 177 of file baseSkyMap.py.

◆ findTract()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.findTract (   self,
  coord 
)
Find the tract whose inner region includes the coord.

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

Returns
-------
tractInfo : `TractInfo`
    Info for tract whose inner region includes the coord.

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 124 of file dodecaSkyMap.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).

Reimplemented in lsst.skymap.ringsSkyMap.RingsSkyMap.

Definition at line 149 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 245 of file baseSkyMap.py.

◆ getVersion()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.getVersion (   self)
Return version (e.g. for pickle).

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

Definition at line 139 of file dodecaSkyMap.py.

◆ getWithTractsOnPoles()

def lsst.skymap.dodecaSkyMap.DodecaSkyMap.getWithTractsOnPoles (   self)
Return True if there are tracts centered on the poles.

Definition at line 149 of file dodecaSkyMap.py.

◆ logSkyMapInfo()

def lsst.skymap.baseSkyMap.BaseSkyMap.logSkyMapInfo (   self,
  log 
)
inherited
Write information about a sky map to supplied log

Parameters
----------
log : `lsst.log.Log`
    Log object that information about skymap will be written

Definition at line 221 of file baseSkyMap.py.

◆ register()

def lsst.skymap.baseSkyMap.BaseSkyMap.register (   self,
  name,
  butler 
)
inherited
Add skymap, tract, and patch Dimension entries to the given Gen3
Butler.

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

Raises
------
lsst.daf.butler.registry.ConflictingDefinitionError
    Raised if a different skymap exists with the same name.

Notes
-----
Registering the same skymap multiple times (with the exact same
definition) is safe, but inefficient; most of the work of computing
the rows to be inserted must be done first in order to check for
consistency between the new skymap and any existing one.

Re-registering a skymap with different tract and/or patch definitions
but the same summary information may not be detected as a conflict but
will never result in updating the skymap; there is intentionally no
way to modify a registered skymap (aside from manual administrative
operations on the database), as it is hard to guarantee that this can
be done without affecting reproducibility.

Definition at line 297 of file baseSkyMap.py.

◆ updateSha1()

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

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 154 of file dodecaSkyMap.py.

Member Data Documentation

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config
inherited

Definition at line 107 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.dodecaSkyMap.DodecaSkyMap.ConfigClass = DodecaSkyMapConfig
static

Definition at line 65 of file dodecaSkyMap.py.

◆ SKYMAP_DATASET_TYPE_NAME

string lsst.skymap.baseSkyMap.BaseSkyMap.SKYMAP_DATASET_TYPE_NAME = "skyMap"
staticinherited

Definition at line 295 of file baseSkyMap.py.

◆ SKYMAP_RUN_COLLECTION_NAME

string lsst.skymap.baseSkyMap.BaseSkyMap.SKYMAP_RUN_COLLECTION_NAME = "skymaps"
staticinherited

Definition at line 293 of file baseSkyMap.py.


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