Inheritance diagram for lsst.skymap.healpixSkyMap.HealpixSkyMap:

Public Member Functions
	__init__ (self, config, version=0)
	findTract (self, coord)
	generateTract (self, index)
	updateSha1 (self, sha1)
	__reduce__ (self)
	__iter__ (self)
	__len__ (self)
	__getitem__ (self, index)
	findTractIdArray (self, ra, dec, degrees=False)
	findTractPatchList (self, coordList)
	findClosestTractPatchList (self, coordList)
	findTractIdPatchIdArray (self, ra, dec, degrees=False)
	__hash__ (self)
	__eq__ (self, other)
	__ne__ (self, other)
	logSkyMapInfo (self, log)
	getSha1 (self)
	register (self, name, butler)

Public Attributes
	config = config

Static Public Attributes
int	numAngles = 4
	ConfigClass = BaseSkyMapConfig
str	SKYMAP_RUN_COLLECTION_NAME = "skymaps"
str	SKYMAP_DATASET_TYPE_NAME = "skyMap"

Protected Attributes
int	_nside = 1 << config.log2NSide
	_numTracts = numTracts
list	_tractCache = [None] * self._numTracts
	_tractInfo = None
	_version = version
list	_tractInfoList = []
	_wcsFactory
	_sha1 = None
	_tractBuilder = config.tractBuilder.apply()

Detailed Description

HEALPix-based sky map pixelization.

We put a Tract at the position of each HEALPixel.


Parameters
----------
config : `lsst.skymap.BaseSkyMapConfig`
    The configuration for this SkyMap.
version : `int` or `tuple` of `int` (optional)
    Software version of this class, to retain compatibility with old
    instances.

Definition at line 90 of file healpixSkyMap.py.

Constructor & Destructor Documentation

◆ init()

lsst.skymap.healpixSkyMap.HealpixSkyMap.__init__	(	self,
		config,
		version = 0 )

Definition at line 108 of file healpixSkyMap.py.

Member Function Documentation

◆ eq()

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

inherited

Definition at line 376 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 373 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 382 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.

◆ 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.healpixSkyMap.HealpixSkyMap.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 113 of file healpixSkyMap.py.

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

◆ findTractIdPatchIdArray()

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

inherited

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

If a given sky map does not support vectorized operations, then
loops 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.
patchId : `numpy.ndarray`
    Array of sequential patch IDs.  -1 if there is no appropriate
    patch.

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.

Definition at line 299 of file baseSkyMap.py.

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

◆ generateTract()

lsst.skymap.healpixSkyMap.HealpixSkyMap.generateTract	(		self,
			index )

Generate TractInfo for the specified tract index.

Reimplemented from lsst.skymap.cachingSkyMap.CachingSkyMap.

Definition at line 130 of file healpixSkyMap.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 409 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 385 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 452 of file baseSkyMap.py.

◆ updateSha1()

lsst.skymap.healpixSkyMap.HealpixSkyMap.updateSha1	(		self,
			sha1 )

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

Reimplemented from lsst.skymap.baseSkyMap.BaseSkyMap.

Definition at line 138 of file healpixSkyMap.py.

Member Data Documentation

◆ _nside

lsst.skymap.healpixSkyMap.HealpixSkyMap._nside = 1 << config.log2NSide

protected

Definition at line 109 of file healpixSkyMap.py.

◆ _numTracts

lsst.skymap.cachingSkyMap.CachingSkyMap._numTracts = numTracts

protectedinherited

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

◆ numAngles

int lsst.skymap.healpixSkyMap.HealpixSkyMap.numAngles = 4

static

Definition at line 106 of file healpixSkyMap.py.

◆ SKYMAP_DATASET_TYPE_NAME

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

staticinherited

Definition at line 450 of file baseSkyMap.py.

◆ SKYMAP_RUN_COLLECTION_NAME

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

staticinherited

Definition at line 448 of file baseSkyMap.py.

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

python/lsst/skymap/healpixSkyMap.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __getitem__()

◆ __hash__()

◆ __iter__()

◆ __len__()

◆ __ne__()

◆ __reduce__()

◆ findClosestTractPatchList()

◆ findTract()

◆ findTractIdArray()

◆ findTractIdPatchIdArray()

◆ findTractPatchList()

◆ generateTract()

◆ getSha1()

◆ logSkyMapInfo()

◆ register()

◆ updateSha1()

Member Data Documentation

◆ _nside

◆ _numTracts

◆ _sha1

◆ _tractBuilder

◆ _tractCache

◆ _tractInfo

◆ _tractInfoList

◆ _version

◆ _wcsFactory

◆ config

◆ ConfigClass

◆ numAngles

◆ SKYMAP_DATASET_TYPE_NAME

◆ SKYMAP_RUN_COLLECTION_NAME

◆ init()

◆ eq()

◆ getitem()

◆ hash()

◆ iter()

◆ len()

◆ ne()

◆ reduce()