Inheritance diagram for lsst.skymap.ringsSkyMap.RingsSkyMap:

Public Member Functions
	__init__ (self, config, version=1)

	getRingIndices (self, index)

	generateTract (self, index)

	getRaDecRange (self, index)

	findTract (self, coord)

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

	findAllTracts (self, coord)

	findTractPatchList (self, coordList)

	updateSha1 (self, sha1)

	__reduce__ (self)

	__iter__ (self)

	__len__ (self)

	__getitem__ (self, index)

	findClosestTractPatchList (self, coordList)

	__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 Member Functions
	_decToRingNum (self, dec)

	_raToTractNum (self, ra, ringNum)

Protected Attributes
	_ringSize = math.pi / (config.numRings + 1)

list	_ringNums = []

	_raStart = self.config.raStart*geom.degrees

	_numTracts = numTracts

list	_tractCache = [None] * self._numTracts

	_tractInfo = None

	_version = version

list	_tractInfoList = []

	_wcsFactory

	_sha1 = None

	_tractBuilder = config.tractBuilder.apply()

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.

Rings are numbered in the rings from south to north. The south pole cap is
``tract=0``, then the tract at ``raStart`` in the southernmost ring is
``tract=1``. Numbering continues (in the positive RA direction) around that
ring and then continues in the same fashion with the next ring north, and
so on until all reaching the north pole cap, which is
``tract=len(skymap) - 1``.

However, ``version=0`` had a bug in the numbering of the tracts: the first
and last tracts in the first (southernmost) ring were identical, and the
first tract in the last (northernmost) ring was missing. When using
``version=0``, these tracts remain missing in order to preserve the
numbering scheme.

Parameters
----------
config : `lsst.skymap.RingsSkyMapConfig`
    The configuration for this SkyMap.
version : `int`, optional
    Software version of this class, to retain compatibility with old
    verisons. ``version=0`` covers the period from first implementation
    until DM-14809, at which point bugs were identified in the numbering
    of tracts (affecting only tracts at RA=0). ``version=1`` uses the
    post-DM-14809 tract numbering.

Definition at line 43 of file ringsSkyMap.py.

Constructor & Destructor Documentation

◆ init()

lsst.skymap.ringsSkyMap.RingsSkyMap.__init__	(	self,
		config,
		version = 1 )

Definition at line 79 of file ringsSkyMap.py.

Member Function Documentation

◆ eq()

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

inherited

Definition at line 311 of file baseSkyMap.py.

◆ getitem()

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 80 of file cachingSkyMap.py.

◆ hash()

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

inherited

Definition at line 308 of file baseSkyMap.py.

◆ iter()

lsst.skymap.cachingSkyMap.CachingSkyMap.__iter__ ( self )

inherited

Iterator over tracts.

Definition at line 71 of file cachingSkyMap.py.

◆ len()

lsst.skymap.cachingSkyMap.CachingSkyMap.__len__ ( self )

inherited

Length is number of tracts.

Definition at line 76 of file cachingSkyMap.py.

◆ ne()

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

inherited

Definition at line 317 of file baseSkyMap.py.

◆ reduce()

lsst.skymap.cachingSkyMap.CachingSkyMap.__reduce__ ( self )

inherited

To support pickling.

Notes
-----
**Warning:** This method assumes that the constructor is 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 58 of file cachingSkyMap.py.

◆ _decToRingNum()

lsst.skymap.ringsSkyMap.RingsSkyMap._decToRingNum	(		self,
			dec )

protected

Calculate ring number from Declination.

Parameters
----------
dec : `lsst.geom.Angle`
    Declination.

Returns
-------
ringNum : `int`
    Ring number: -1 for the south polar cap, and increasing to the
    north, ending with ``numRings`` for the north polar cap.

Definition at line 198 of file ringsSkyMap.py.

◆ _raToTractNum()

lsst.skymap.ringsSkyMap.RingsSkyMap._raToTractNum	(	self,
		ra,
		ringNum )

protected

Calculate tract number from the Right Ascension.

Parameters
----------
ra : `lsst.geom.Angle`
    Right Ascension.
ringNum : `int`
    Ring number (from ``_decToRingNum``).

Returns
-------
tractNum : `int`
    Tract number within the ring (starts at 0 for the tract at
    ``raStart``).

Definition at line 221 of file ringsSkyMap.py.

◆ findAllTracts()

lsst.skymap.ringsSkyMap.RingsSkyMap.findAllTracts	(		self,
			coord )

Find all tracts which include the specified coord.

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

Returns
-------
tractList : `list` of `TractInfo`
    The tracts which include the specified coord.

Definition at line 310 of file ringsSkyMap.py.

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

◆ findTract()

lsst.skymap.ringsSkyMap.RingsSkyMap.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 from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 244 of file ringsSkyMap.py.

◆ findTractIdArray()

lsst.skymap.ringsSkyMap.RingsSkyMap.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.

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 262 of file ringsSkyMap.py.

◆ findTractPatchList()

lsst.skymap.ringsSkyMap.RingsSkyMap.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 from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 361 of file ringsSkyMap.py.

◆ generateTract()

lsst.skymap.ringsSkyMap.RingsSkyMap.generateTract	(		self,
			index )

Generate TractInfo for the specified tract index.

Reimplemented from lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 126 of file ringsSkyMap.py.

◆ getRaDecRange()

lsst.skymap.ringsSkyMap.RingsSkyMap.getRaDecRange	(		self,
			index )

Get the ra and dec ranges for the inner region of a
specified tract index.

Parameters
----------
index : `int`
    Tract index number.

Returns
-------
raMin, raMax, decMin, decMax : `lsst.geom.Angle`
    RA/Dec boundaries of the inner region.

Definition at line 158 of file ringsSkyMap.py.

◆ getRingIndices()

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 95 of file ringsSkyMap.py.

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

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

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

◆ updateSha1()

lsst.skymap.ringsSkyMap.RingsSkyMap.updateSha1	(		self,
			sha1 )

Add subclass-specific state or configuration options to the SHA1.

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 370 of file ringsSkyMap.py.

Member Data Documentation

◆ _numTracts

lsst.skymap.cachingSkyMap.CachingSkyMap._numTracts = numTracts

protectedinherited

Definition at line 53 of file cachingSkyMap.py.

◆ _raStart

lsst.skymap.ringsSkyMap.RingsSkyMap._raStart = self.config.raStart*geom.degrees

protected

Definition at line 93 of file ringsSkyMap.py.

◆ _ringNums

list lsst.skymap.ringsSkyMap.RingsSkyMap._ringNums = []

protected

Definition at line 85 of file ringsSkyMap.py.

◆ _ringSize

lsst.skymap.ringsSkyMap.RingsSkyMap._ringSize = math.pi / (config.numRings + 1)

protected

Definition at line 84 of file ringsSkyMap.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.

◆ _tractCache

list lsst.skymap.cachingSkyMap.CachingSkyMap._tractCache = [None] * self._numTracts

protectedinherited

Definition at line 54 of file cachingSkyMap.py.

◆ _tractInfo

lsst.skymap.cachingSkyMap.CachingSkyMap._tractInfo = None

protectedinherited

Definition at line 55 of file cachingSkyMap.py.

◆ _tractInfoList

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

protectedinherited

Definition at line 163 of file baseSkyMap.py.

◆ _version

lsst.skymap.cachingSkyMap.CachingSkyMap._version = version

protectedinherited

Definition at line 56 of file cachingSkyMap.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:

python/lsst/skymap/ringsSkyMap.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __getitem__()

◆ __hash__()

◆ __iter__()

◆ __len__()

◆ __ne__()

◆ __reduce__()

◆ _decToRingNum()

◆ _raToTractNum()

◆ findAllTracts()

◆ findClosestTractPatchList()

◆ findTract()

◆ findTractIdArray()

◆ findTractPatchList()

◆ generateTract()

◆ getRaDecRange()

◆ getRingIndices()

◆ getSha1()

◆ logSkyMapInfo()

◆ register()

◆ updateSha1()

Member Data Documentation

◆ _numTracts

◆ _raStart

◆ _ringNums

◆ _ringSize

◆ _sha1

◆ _tractBuilder

◆ _tractCache

◆ _tractInfo

◆ _tractInfoList

◆ _version

◆ _wcsFactory

◆ config

◆ ConfigClass

◆ SKYMAP_DATASET_TYPE_NAME

◆ SKYMAP_RUN_COLLECTION_NAME

◆ init()

◆ eq()

◆ getitem()

◆ hash()

◆ iter()

◆ len()

◆ ne()

◆ reduce()