lsst.skymap ge3564fa9f0+8223ad0938
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
lsst.skymap.ringsSkyMap.RingsSkyMap Class Reference
Inheritance diagram for lsst.skymap.ringsSkyMap.RingsSkyMap:
lsst.skymap.cachingSkyMap.CachingSkyMap lsst.skymap.baseSkyMap.BaseSkyMap

Public Member Functions

 __init__ (self, config, version=1)
 
 getRingIndices (self, index)
 
 generateTract (self, index)
 
 findTract (self, coord)
 
 findTractIdArray (self, ra, dec, degrees=False)
 
 findAllTracts (self, coord)
 
 findTractPatchList (self, coordList)
 
 updateSha1 (self, sha1)
 

Static Public Attributes

 ConfigClass = RingsSkyMapConfig
 

Protected Member Functions

 _decToRingNum (self, dec)
 
 _raToTractNum (self, ra, ringNum)
 

Protected Attributes

 _ringSize
 
 _ringNums
 
 _raStart
 
 _version
 
 _tractBuilder
 

Static Protected Attributes

tuple _version = (1, 0)
 

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

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 78 of file ringsSkyMap.py.

Member Function Documentation

◆ _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 143 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 166 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 255 of file ringsSkyMap.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 189 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 207 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 306 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 125 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 94 of file ringsSkyMap.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 315 of file ringsSkyMap.py.

Member Data Documentation

◆ _raStart

lsst.skymap.ringsSkyMap.RingsSkyMap._raStart
protected

Definition at line 92 of file ringsSkyMap.py.

◆ _ringNums

lsst.skymap.ringsSkyMap.RingsSkyMap._ringNums
protected

Definition at line 84 of file ringsSkyMap.py.

◆ _ringSize

lsst.skymap.ringsSkyMap.RingsSkyMap._ringSize
protected

Definition at line 83 of file ringsSkyMap.py.

◆ _tractBuilder

lsst.skymap.ringsSkyMap.RingsSkyMap._tractBuilder
protected

Definition at line 139 of file ringsSkyMap.py.

◆ _version [1/2]

tuple lsst.skymap.ringsSkyMap.RingsSkyMap._version = (1, 0)
staticprotected

Definition at line 76 of file ringsSkyMap.py.

◆ _version [2/2]

lsst.skymap.ringsSkyMap.RingsSkyMap._version
protected

Definition at line 112 of file ringsSkyMap.py.

◆ ConfigClass

lsst.skymap.ringsSkyMap.RingsSkyMap.ConfigClass = RingsSkyMapConfig
static

Definition at line 75 of file ringsSkyMap.py.


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