Inheritance diagram for lsst.skymap.dodecaSkyMap.DodecaSkyMap:

Public Member Functions
	__init__ (self, config=None)

	__getstate__ (self)

	__setstate__ (self, stateDict)

	findTract (self, coord)

	getVersion (self)

	getWithTractsOnPoles (self)

	updateSha1 (self, sha1)

	findTractIdArray (self, ra, dec, degrees=False)

	findTractPatchList (self, coordList)

	findClosestTractPatchList (self, coordList)

	__getitem__ (self, ind)

	__iter__ (self)

	__len__ (self)

	__hash__ (self)

	__eq__ (self, other)

	__ne__ (self, other)

	logSkyMapInfo (self, log)

	getSha1 (self)

	register (self, name, butler)

Public Attributes
	config = config

Static Public Attributes
	ConfigClass = BaseSkyMapConfig

str	SKYMAP_RUN_COLLECTION_NAME = "skymaps"

str	SKYMAP_DATASET_TYPE_NAME = "skyMap"

Protected Attributes
	_dodecahedron = detail.Dodecahedron(withFacesOnPoles=self.config.withTractsOnPoles)

list	_tractInfoList = []

	_wcsFactory

	_sha1 = None

	_tractBuilder = config.tractBuilder.apply()

Static Protected Attributes
tuple	_version = (1, 0)

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()

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

Definition at line 68 of file dodecaSkyMap.py.

    def __init__(self, config=None):
        BaseSkyMap.__init__(self, config)
        self._dodecahedron = detail.Dodecahedron(withFacesOnPoles=self.config.withTractsOnPoles)
 
        tractOverlap = geom.Angle(self.config.tractOverlap, geom.degrees)
 
        for id in range(12):
            tractVec = self._dodecahedron.getFaceCtr(id)
            tractCoord = detail.coordFromVec(tractVec, defRA=geom.Angle(0))
            tractRA = tractCoord.getLongitude()
            vertexVecList = self._dodecahedron.getVertices(id)
 
            # Make initial WCS; don't worry about crPixPos because TractInfo
            # will shift it as required.
            wcs = self._wcsFactory.makeWcs(crPixPos=geom.Point2D(0, 0), crValCoord=tractCoord)
 
            self._tractInfoList.append(
                TractInfo(
                    id=id,
                    tractBuilder=self._tractBuilder,
                    ctrCoord=tractCoord,
                    vertexCoordList=[detail.coordFromVec(vec, defRA=tractRA) for vec in vertexVecList],
                    tractOverlap=tractOverlap,
                    wcs=wcs,
                )
            )
 

Member Function Documentation

◆ eq()

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

inherited

Definition at line 311 of file baseSkyMap.py.

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

◆ getitem()

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

inherited

Definition at line 299 of file baseSkyMap.py.

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

◆ getstate()

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.

    def __getstate__(self):
        """Support pickle.
 
        Returns
        -------
        result : `dict`
            A dict containing:
            - version: a pair of ints
            - config: the config
        """
        return dict(
            version=self._version,
            config=self.config,
        )
 

◆ hash()

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

inherited

Definition at line 308 of file baseSkyMap.py.

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

◆ iter()

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

inherited

Definition at line 302 of file baseSkyMap.py.

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

◆ len()

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

inherited

Definition at line 305 of file baseSkyMap.py.

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

◆ ne()

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

inherited

Definition at line 317 of file baseSkyMap.py.

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

◆ setstate()

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.

    def __setstate__(self, stateDict):
        """Support unpickle
 
        Parameters
        ----------
        stateDict : `dict`
            - version: a pair of ints
            - config: the config
        """
        version = stateDict["version"]
        if version >= (2, 0):
            raise RuntimeError("Version = %s >= (2,0); cannot unpickle" % (version,))
        self.__init__(stateDict["config"])
 

◆ findClosestTractPatchList()

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 276 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()

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.

    def 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.
        """
        return self[self._dodecahedron.getFaceInd(coord.getVector())]
 

◆ findTractIdArray()

lsst.skymap.baseSkyMap.BaseSkyMap.findTractIdArray	(	self,
		ra,
		dec,
		degrees = False )

inherited

Find array of tract IDs with vectorized operations (where
supported).

If a given sky map does not support vectorized operations, then a loop
over findTract will be called.

Parameters
----------
ra : `numpy.ndarray`
    Array of Right Ascension.  Units are radians unless
    degrees=True.
dec : `numpy.ndarray`
    Array of Declination.  Units are radians unless
    degrees=True.
degrees : `bool`, optional
    Input ra, dec arrays are degrees if `True`.

Returns
-------
tractId : `numpy.ndarray`
    Array of tract IDs

Notes
-----
- If coord is equidistant between multiple sky tract centers then one
  is arbitrarily chosen.

.. warning::

   If tracts do not cover the whole sky then the returned tract may not
   include the given ra/dec.

Reimplemented in lsst.skymap.ringsSkyMap.RingsSkyMap.

Definition at line 206 of file baseSkyMap.py.

    def findTractIdArray(self, ra, dec, degrees=False):
        """Find array of tract IDs with vectorized operations (where
        supported).
 
        If a given sky map does not support vectorized operations, then a loop
        over findTract will be called.
 
        Parameters
        ----------
        ra : `numpy.ndarray`
            Array of Right Ascension.  Units are radians unless
            degrees=True.
        dec : `numpy.ndarray`
            Array of Declination.  Units are radians unless
            degrees=True.
        degrees : `bool`, optional
            Input ra, dec arrays are degrees if `True`.
 
        Returns
        -------
        tractId : `numpy.ndarray`
            Array of tract IDs
 
        Notes
        -----
        - If coord is equidistant between multiple sky tract centers then one
          is arbitrarily chosen.
 
        .. warning::
 
           If tracts do not cover the whole sky then the returned tract may not
           include the given ra/dec.
        """
        units = geom.degrees if degrees else geom.radians
        coords = [geom.SpherePoint(r*units, d*units) for r, d in zip(np.atleast_1d(ra),
                                                                     np.atleast_1d(dec))]
 
        tractId = np.array([self.findTract(coord).getId() for coord in coords])
 
        return tractId
 

◆ findTractPatchList()

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 247 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()

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 344 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 = self._tractBuilder.getPackedConfig(self.config)
            sha1.update(configPacked)
            self.updateSha1(sha1)
            self._sha1 = sha1.digest()
        return self._sha1
 

◆ getVersion()

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.

    def getVersion(self):
        """Return version (e.g. for pickle).
 
        Returns
        -------
        version : `tuple` of `int`
            Version as a pair of integers.
        """
        return self._version
 

◆ getWithTractsOnPoles()

lsst.skymap.dodecaSkyMap.DodecaSkyMap.getWithTractsOnPoles ( self )

Return True if there are tracts centered on the poles.

Definition at line 149 of file dodecaSkyMap.py.

    def getWithTractsOnPoles(self):
        """Return True if there are tracts centered on the poles.
        """
        return self._dodecahedron.getWithFacesOnPoles()
 

◆ logSkyMapInfo()

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

inherited

Write information about a sky map to supplied log

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

Definition at line 320 of file baseSkyMap.py.

    def logSkyMapInfo(self, log):
        """Write information about a sky map to supplied log
 
        Parameters
        ----------
        log : `logging.Logger`
            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()

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

    def register(self, name, butler):
        """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.
        """
        numPatches = [tractInfo.getNumPatches() for tractInfo in self]
        nxMax = max(nn[0] for nn in numPatches)
        nyMax = max(nn[1] for nn in numPatches)
 
        skyMapRecord = {
            "skymap": name,
            "hash": self.getSha1(),
            "tract_max": len(self),
            "patch_nx_max": nxMax,
            "patch_ny_max": nyMax,
        }
        butler.registry.registerRun(self.SKYMAP_RUN_COLLECTION_NAME)
        # Kind of crazy that we've got three different capitalizations of
        # "skymap" here, but that's what the various conventions (or at least
        # precedents) dictate.
        from lsst.daf.butler import DatasetType
        from lsst.daf.butler.registry import ConflictingDefinitionError
        datasetType = DatasetType(
            name=self.SKYMAP_DATASET_TYPE_NAME,
            dimensions=["skymap"],
            storageClass="SkyMap",
            universe=butler.dimensions
        )
        butler.registry.registerDatasetType(datasetType)
        with butler.transaction():
            try:
                inserted = butler.registry.syncDimensionData("skymap", skyMapRecord)
            except ConflictingDefinitionError as err:
                raise ConflictingDefinitionError(
                    f"SkyMap with hash {self.getSha1().hex()} is already registered with a different name."
                ) from err
            if inserted:
                for tractInfo in self:
                    tractId = tractInfo.getId()
                    tractRegion = tractInfo.getOuterSkyPolygon()
                    tractWcs = tractInfo.getWcs()
                    tractRecord = dict(
                        skymap=name,
                        tract=tractId,
                        region=tractRegion,
                    )
                    butler.registry.insertDimensionData("tract", tractRecord)
 
                    patchRecords = []
                    for patchInfo in tractInfo:
                        xx, yy = patchInfo.getIndex()
                        patchRecords.append(
                            dict(
                                skymap=name,
                                tract=tractId,
                                patch=tractInfo.getSequentialPatchIndex(patchInfo),
                                cell_x=xx,
                                cell_y=yy,
                                region=patchInfo.getOuterSkyPolygon(tractWcs),
                            )
                        )
                    butler.registry.insertDimensionData("patch", *patchRecords)
 
                butler.put(self, datasetType, {"skymap": name}, run=self.SKYMAP_RUN_COLLECTION_NAME)

◆ updateSha1()

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.

    def updateSha1(self, sha1):
        """Add subclass-specific state or configuration options to the SHA1."""
        sha1.update(struct.pack("<?", self.config.withTractsOnPoles))

Member Data Documentation

◆ _dodecahedron

lsst.skymap.dodecaSkyMap.DodecaSkyMap._dodecahedron = detail.Dodecahedron(withFacesOnPoles=self.config.withTractsOnPoles)

protected

Definition at line 70 of file dodecaSkyMap.py.

◆ _sha1

lsst.skymap.baseSkyMap.BaseSkyMap._sha1 = None

protectedinherited

Definition at line 169 of file baseSkyMap.py.

◆ _tractBuilder

lsst.skymap.baseSkyMap.BaseSkyMap._tractBuilder = config.tractBuilder.apply()

protectedinherited

Definition at line 170 of file baseSkyMap.py.

◆ _tractInfoList

lsst.skymap.baseSkyMap.BaseSkyMap._tractInfoList = []

protectedinherited

Definition at line 163 of file baseSkyMap.py.

◆ _version

tuple lsst.skymap.dodecaSkyMap.DodecaSkyMap._version = (1, 0)

staticprotected

Definition at line 66 of file dodecaSkyMap.py.

◆ _wcsFactory

lsst.skymap.baseSkyMap.BaseSkyMap._wcsFactory

protectedinherited

Initial value:

=  detail.WcsFactory(
            pixelScale=Angle(self.config.pixelScale, arcseconds),
            projection=self.config.projection,
            rotation=Angle(self.config.rotation, degrees),
        )

Definition at line 164 of file baseSkyMap.py.

◆ config

lsst.skymap.baseSkyMap.BaseSkyMap.config = config

inherited

Definition at line 162 of file baseSkyMap.py.

◆ ConfigClass

lsst.skymap.baseSkyMap.BaseSkyMap.ConfigClass = BaseSkyMapConfig

staticinherited

Definition at line 156 of file baseSkyMap.py.

◆ SKYMAP_DATASET_TYPE_NAME

str lsst.skymap.baseSkyMap.BaseSkyMap.SKYMAP_DATASET_TYPE_NAME = "skyMap"

staticinherited

Definition at line 385 of file baseSkyMap.py.

◆ SKYMAP_RUN_COLLECTION_NAME

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

staticinherited

Definition at line 383 of file baseSkyMap.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/skymap/g1fd858c14a+7a7b9dd5ed/python/lsst/skymap/dodecaSkyMap.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __getitem__()

◆ __getstate__()

◆ __hash__()

◆ __iter__()

◆ __len__()

◆ __ne__()

◆ __setstate__()

◆ findClosestTractPatchList()

◆ findTract()

◆ findTractIdArray()

◆ findTractPatchList()

◆ getSha1()

◆ getVersion()

◆ getWithTractsOnPoles()

◆ logSkyMapInfo()

◆ register()

◆ updateSha1()

Member Data Documentation

◆ _dodecahedron

◆ _sha1

◆ _tractBuilder

◆ _tractInfoList

◆ _version

◆ _wcsFactory

◆ config

◆ ConfigClass

◆ SKYMAP_DATASET_TYPE_NAME

◆ SKYMAP_RUN_COLLECTION_NAME

◆ init()

◆ eq()

◆ getitem()

◆ getstate()

◆ hash()

◆ iter()

◆ len()

◆ ne()

◆ setstate()