Inheritance diagram for lsst.skymap.baseSkyMap.BaseSkyMap:

Public Member Functions
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)

def	__hash__ (self)

def	__eq__ (self, other)

def	__ne__ (self, other)

def	logSkyMapInfo (self, log)

def	getSha1 (self)

def	updateSha1 (self, sha1)

def	register (self, name, registry)

Public Attributes
	config

Static Public Attributes
	ConfigClass

Detailed Description

A collection of overlapping Tracts that map part or all of the sky.

See TractInfo for more information.

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

Notes
-----
BaseSkyMap is an abstract base class. Subclasses must do the following:
define ``__init__`` and have it construct the TractInfo objects and put
them in ``__tractInfoList__`` define ``__getstate__`` and ``__setstate__``
to allow pickling (the butler saves sky maps using pickle);
see DodecaSkyMap for an example of how to do this. (Most of that code could
be moved into this base class, but that would make it harder to handle
older versions of pickle data.) define updateSha1 to add any
subclass-specific state to the hash.

All SkyMap subclasses must be conceptually immutable; they must always
refer to the same set of mathematical tracts and patches even if the in-
memory representation of those objects changes.

Definition at line 75 of file baseSkyMap.py.

Constructor & Destructor Documentation

◆ init()

def lsst.skymap.baseSkyMap.BaseSkyMap.__init__	(	self,
		config = `None`
	)

Reimplemented in lsst.skymap.dodecaSkyMap.DodecaSkyMap, and lsst.skymap.equatSkyMap.EquatSkyMap.

Definition at line 103 of file baseSkyMap.py.

     def __init__(self, config=None):
         if config is None:
             config = self.ConfigClass()
         config.freeze()  # just to be sure, e.g. for pickling
         self.config = config
         self._tractInfoList = []
         self._wcsFactory = detail.WcsFactory(
             pixelScale=Angle(self.config.pixelScale, arcseconds),
             projection=self.config.projection,
             rotation=Angle(self.config.rotation, degrees),
         )
         self._sha1 = None
  

Member Function Documentation

◆ eq()

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

Definition at line 212 of file baseSkyMap.py.

     def __eq__(self, other):
         try:
             return self.getSha1() == other.getSha1()
         except AttributeError:
             return NotImplemented
  

◆ getitem()

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

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 200 of file baseSkyMap.py.

     def __getitem__(self, ind):
         return self._tractInfoList[ind]
  

◆ hash()

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

Definition at line 209 of file baseSkyMap.py.

     def __hash__(self):
         return hash(self.getSha1())
  

◆ iter()

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

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 203 of file baseSkyMap.py.

     def __iter__(self):
         return iter(self._tractInfoList)
  

◆ len()

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

Reimplemented in lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 206 of file baseSkyMap.py.

     def __len__(self):
         return len(self._tractInfoList)
  

◆ ne()

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

Definition at line 218 of file baseSkyMap.py.

     def __ne__(self, other):
         return not (self == other)
  

◆ findClosestTractPatchList()

def lsst.skymap.baseSkyMap.BaseSkyMap.findClosestTractPatchList	(	self,
		coordList
	)

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.

     def findClosestTractPatchList(self, coordList):
         """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.
         """
         retList = []
         for coord in coordList:
             tractInfo = self.findTract(coord)
             patchList = tractInfo.findPatchList(coordList)
             if patchList and not (tractInfo, patchList) in retList:
                 retList.append((tractInfo, patchList))
         return retList
  

◆ findTract()

def lsst.skymap.baseSkyMap.BaseSkyMap.findTract	(	self,
		coord
	)

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.

Reimplemented in lsst.skymap.ringsSkyMap.RingsSkyMap, lsst.skymap.dodecaSkyMap.DodecaSkyMap, and lsst.skymap.healpixSkyMap.HealpixSkyMap.

Definition at line 116 of file baseSkyMap.py.

     def findTract(self, coord):
         """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.
         """
         distTractInfoList = []
         for i, tractInfo in enumerate(self):
             angSep = coord.separation(tractInfo.getCtrCoord()).asDegrees()
             # include index in order to disambiguate identical angSep values
             distTractInfoList.append((angSep, i, tractInfo))
         distTractInfoList.sort()
         return distTractInfoList[0][2]
  

◆ findTractPatchList()

def lsst.skymap.baseSkyMap.BaseSkyMap.findTractPatchList	(	self,
		coordList
	)

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.

     def findTractPatchList(self, coordList):
         """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).
         """
         retList = []
         for tractInfo in self:
             patchList = tractInfo.findPatchList(coordList)
             if patchList:
                 retList.append((tractInfo, patchList))
         return retList
  

◆ getSha1()

def lsst.skymap.baseSkyMap.BaseSkyMap.getSha1 ( self )

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.

     def getSha1(self):
         """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.
         """
         if self._sha1 is None:
             sha1 = hashlib.sha1()
             sha1.update(type(self).__name__.encode('utf-8'))
             configPacked = struct.pack(
                 "<iiidd3sd",
                 self.config.patchInnerDimensions[0],
                 self.config.patchInnerDimensions[1],
                 self.config.patchBorder,
                 self.config.tractOverlap,
                 self.config.pixelScale,
                 self.config.projection.encode('ascii'),
                 self.config.rotation
             )
             sha1.update(configPacked)
             self.updateSha1(sha1)
             self._sha1 = sha1.digest()
         return self._sha1
  

◆ logSkyMapInfo()

def lsst.skymap.baseSkyMap.BaseSkyMap.logSkyMapInfo	(	self,
		log
	)

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.

     def logSkyMapInfo(self, log):
         """Write information about a sky map to supplied log
  
         Parameters
         ----------
         log : `lsst.log.Log`
             Log object that information about skymap will be written
         """
         log.info("sky map has %s tracts" % (len(self),))
         for tractInfo in self:
             wcs = tractInfo.getWcs()
             posBox = geom.Box2D(tractInfo.getBBox())
             pixelPosList = (
                 posBox.getMin(),
                 geom.Point2D(posBox.getMaxX(), posBox.getMinY()),
                 posBox.getMax(),
                 geom.Point2D(posBox.getMinX(), posBox.getMaxY()),
             )
             skyPosList = [wcs.pixelToSky(pos).getPosition(geom.degrees) for pos in pixelPosList]
             posStrList = ["(%0.3f, %0.3f)" % tuple(skyPos) for skyPos in skyPosList]
             log.info("tract %s has corners %s (RA, Dec deg) and %s x %s patches" %
                      (tractInfo.getId(), ", ".join(posStrList),
                       tractInfo.getNumPatches()[0], tractInfo.getNumPatches()[1]))
  

◆ register()

def lsst.skymap.baseSkyMap.BaseSkyMap.register	(	self,
		name,
		registry
	)

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 293 of file baseSkyMap.py.

     def register(self, name, registry):
         """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.
         """
         nxMax = 0
         nyMax = 0
         records = {
             "skymap": [],
             "tract": [],
             "patch": [],
         }
         for tractInfo in self:
             nx, ny = tractInfo.getNumPatches()
             nxMax = max(nxMax, nx)
             nyMax = max(nyMax, ny)
             region = tractInfo.getOuterSkyPolygon()
             centroid = SpherePoint(region.getCentroid())
             records["tract"].append({
                 "skymap": name,
                 "tract": tractInfo.getId(),
                 "region": region,
                 "ra": centroid.getRa().asDegrees(),
                 "dec": centroid.getDec().asDegrees(),
             })
             for patchInfo in tractInfo:
                 cellX, cellY = patchInfo.getIndex()
                 records["patch"].append({
                     "skymap": name,
                     "tract": tractInfo.getId(),
                     "patch": tractInfo.getSequentialPatchIndex(patchInfo),
                     "cell_x": cellX,
                     "cell_y": cellY,
                     "region": patchInfo.getOuterSkyPolygon(tractInfo.getWcs()),
                 })
         records["skymap"].append({
             "skymap": name,
             "hash": self.getSha1(),
             "tract_max": len(self),
             "patch_nx_max": nxMax,
             "patch_ny_max": nyMax,
         })
         with registry.transaction():
             for dimension, recordsForDimension in records.items():
                 registry.insertDimensionData(dimension, *recordsForDimension)

◆ updateSha1()

def lsst.skymap.baseSkyMap.BaseSkyMap.updateSha1	(	self,
		sha1
	)

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.

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

Reimplemented in lsst.skymap.ringsSkyMap.RingsSkyMap, lsst.skymap.dodecaSkyMap.DodecaSkyMap, lsst.skymap.equatSkyMap.EquatSkyMap, lsst.skymap.healpixSkyMap.HealpixSkyMap, and lsst.skymap.discreteSkyMap.DiscreteSkyMap.

Definition at line 276 of file baseSkyMap.py.

     def updateSha1(self, sha1):
         """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.
  
         Notes
         -----
         This method is conceptually "protected" : it should be reimplemented by
         all subclasses, but called only by the base class implementation of
         `getSha1` .
         """
         raise NotImplementedError()
  

Member Data Documentation

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config

Definition at line 107 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.baseSkyMap.BaseSkyMap.ConfigClass

static

Definition at line 101 of file baseSkyMap.py.

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

/j/snowflake/release/lsstsw/stack/1a1d771/Linux64/skymap/20.0.0/python/lsst/skymap/baseSkyMap.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __getitem__()

◆ __hash__()

◆ __iter__()

◆ __len__()

◆ __ne__()

◆ findClosestTractPatchList()

◆ findTract()

◆ findTractPatchList()

◆ getSha1()

◆ logSkyMapInfo()

◆ register()

◆ updateSha1()

Member Data Documentation

◆ config

◆ ConfigClass

◆ init()

◆ eq()

◆ getitem()

◆ hash()

◆ iter()

◆ len()

◆ ne()