LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | List of all members
lsst.sphgeom.pixelization_abc.PixelizationABC Class Reference
Inheritance diagram for lsst.sphgeom.pixelization_abc.PixelizationABC:
lsst.sphgeom._healpixPixelization.HealpixPixelization

Public Member Functions

RangeSet universe (self)
 
Region pixel (self, i)
 
int index (self, UnitVector3d v)
 
str toString (self, int i)
 
def envelope (self, Region region, int maxRanges=0)
 
def interior (self, Region region, int maxRanges=0)
 

Detailed Description

Pixelization ABC class that should be a base for
Python implementations of pixelization.

Definition at line 27 of file pixelization_abc.py.

Member Function Documentation

◆ envelope()

def lsst.sphgeom.pixelization_abc.PixelizationABC.envelope (   self,
Region  region,
int   maxRanges = 0 
) 
Return the indexes of the pixels intersecting the spherical region.

The ``maxRanges`` parameter can be used to limit both these costs -
setting it to a non-zero value sets a cap on the number of ranges
returned by this method. To meet this constraint, implementations are
allowed to return pixels that do not intersect the region along with
those, that do.
This allows two ranges [a, b) and [c, d), a < b < c < d, to be
merged into one range [a, d) (by adding in the pixels [b, c)). Since
simplification proceeds by adding pixels, the return value will always
be a superset of the intersecting pixels.

Parameters
----------
region : `lsst.sphgeom.Region`
maxRanges : `int`

Returns
-------
rangeSet : `lsst.sphgeom.RangeSet`

Reimplemented in lsst.sphgeom._healpixPixelization.HealpixPixelization.

Definition at line 99 of file pixelization_abc.py.

99  def envelope(self, region: Region, maxRanges: int = 0):
100  """Return the indexes of the pixels intersecting the spherical region.
101 
102  The ``maxRanges`` parameter can be used to limit both these costs -
103  setting it to a non-zero value sets a cap on the number of ranges
104  returned by this method. To meet this constraint, implementations are
105  allowed to return pixels that do not intersect the region along with
106  those, that do.
107  This allows two ranges [a, b) and [c, d), a < b < c < d, to be
108  merged into one range [a, d) (by adding in the pixels [b, c)). Since
109  simplification proceeds by adding pixels, the return value will always
110  be a superset of the intersecting pixels.
111 
112  Parameters
113  ----------
114  region : `lsst.sphgeom.Region`
115  maxRanges : `int`
116 
117  Returns
118  -------
119  rangeSet : `lsst.sphgeom.RangeSet`
120  """
121  pass
122 

◆ index()

int lsst.sphgeom.pixelization_abc.PixelizationABC.index (   self,
UnitVector3d  v 
) 
 Compute the index of the pixel.

Parameters
----------
v : `lsst.sphgeom.UnitVector3d`

Returns
-------
i : `int`
    The index of the pixel.

Reimplemented in lsst.sphgeom._healpixPixelization.HealpixPixelization.

Definition at line 70 of file pixelization_abc.py.

70  def index(self, v: UnitVector3d) -> int:
71  """ Compute the index of the pixel.
72 
73  Parameters
74  ----------
75  v : `lsst.sphgeom.UnitVector3d`
76 
77  Returns
78  -------
79  i : `int`
80  The index of the pixel.
81  """
82  pass
83 

◆ interior()

def lsst.sphgeom.pixelization_abc.PixelizationABC.interior (   self,
Region  region,
int   maxRanges = 0 
) 
Return the indexes of the pixels within the spherical region.

The ``maxRanges`` argument is analogous to the identically named
envelope() argument. The only difference is that implementations must
remove interior pixels to keep the number of ranges at or below the
maximum. The return value is therefore always a subset of the interior
pixels.

Parameters
----------
region : `lsst.sphgeom.Region`
maxRanges : `int`

Returns
-------
rangeSet : `lsst.sphgeom.RangeSet`

Reimplemented in lsst.sphgeom._healpixPixelization.HealpixPixelization.

Definition at line 124 of file pixelization_abc.py.

124  def interior(self, region: Region, maxRanges: int = 0):
125  """Return the indexes of the pixels within the spherical region.
126 
127  The ``maxRanges`` argument is analogous to the identically named
128  envelope() argument. The only difference is that implementations must
129  remove interior pixels to keep the number of ranges at or below the
130  maximum. The return value is therefore always a subset of the interior
131  pixels.
132 
133  Parameters
134  ----------
135  region : `lsst.sphgeom.Region`
136  maxRanges : `int`
137 
138  Returns
139  -------
140  rangeSet : `lsst.sphgeom.RangeSet`
141  """
142  pass

◆ pixel()

Region lsst.sphgeom.pixelization_abc.PixelizationABC.pixel (   self,
  i 
) 
Return the spherical region corresponding to the pixel index ``i``.

This region will contain all unit vectors v with ``index(v) == i``.
But it may also contain points with index not equal to ``i``.
To see why, consider a point that lies on the edge of a polygonal
pixel - it is inside the polygons for both pixels sharing the edge,
but must be assigned to exactly one pixel by the pixelization.

Parameters
----------
i : `int`
    Pixel index.

Returns
-------
region : `lsst.sphgeom.Region`
    The spherical region corresponding to the pixel with index ``i``

Raises
------
`InvalidArgumentException`
    Raised if ``i`` is not a valid pixel index.

Reimplemented in lsst.sphgeom._healpixPixelization.HealpixPixelization.

Definition at line 43 of file pixelization_abc.py.

43  def pixel(self, i) -> Region:
44  """Return the spherical region corresponding to the pixel index ``i``.
45 
46  This region will contain all unit vectors v with ``index(v) == i``.
47  But it may also contain points with index not equal to ``i``.
48  To see why, consider a point that lies on the edge of a polygonal
49  pixel - it is inside the polygons for both pixels sharing the edge,
50  but must be assigned to exactly one pixel by the pixelization.
51 
52  Parameters
53  ----------
54  i : `int`
55  Pixel index.
56 
57  Returns
58  -------
59  region : `lsst.sphgeom.Region`
60  The spherical region corresponding to the pixel with index ``i``
61 
62  Raises
63  ------
64  `InvalidArgumentException`
65  Raised if ``i`` is not a valid pixel index.
66  """
67  pass
68 
pixel
table::PointKey< int > pixel
Definition: DeltaFunctionKernel.cc:101

◆ toString()

str lsst.sphgeom.pixelization_abc.PixelizationABC.toString (   self,
int  i 
) 
Convert the given pixel index to a human-readable string.

Parameters
----------
i : `int`

Returns
-------
s : `str`

Reimplemented in lsst.sphgeom._healpixPixelization.HealpixPixelization.

Definition at line 85 of file pixelization_abc.py.

85  def toString(self, i: int) -> str:
86  """Convert the given pixel index to a human-readable string.
87 
88  Parameters
89  ----------
90  i : `int`
91 
92  Returns
93  -------
94  s : `str`
95  """
96  pass
97 

◆ universe()

RangeSet lsst.sphgeom.pixelization_abc.PixelizationABC.universe (   self) 
Return the set of all pixel indexes for this pixelization.

Returns
-------
rangeSet : `lsst.sphgeom.RangeSet`

Reimplemented in lsst.sphgeom._healpixPixelization.HealpixPixelization.

Definition at line 33 of file pixelization_abc.py.

33  def universe(self) -> RangeSet:
34  """Return the set of all pixel indexes for this pixelization.
35 
36  Returns
37  -------
38  rangeSet : `lsst.sphgeom.RangeSet`
39  """
40  pass
41 
The documentation for this class was generated from the following file:
Generated on Fri Nov 26 2021 10:16:29 for LSST Applications by doxygen 1.9.1