Public Member Functions
def	__init__ (self, index, innerBBox, outerBBox, sequentialIndex, tractWcs, cellInnerDimensions=(0, 0), cellBorder=0, numCellsPerPatchInner=0, numCellsInPatchBorder=0)

def	getIndex (self)

def	getSequentialIndex (self)

def	getWcs (self)

def	getInnerBBox (self)

def	getOuterBBox (self)

def	getInnerSkyPolygon (self, tractWcs=None)

def	inner_sky_polygon (self)

def	getOuterSkyPolygon (self, tractWcs=None)

def	outer_sky_polygon (self)

def	getNumCells (self)

def	getCellBorder (self)

def	getCellInfo (self, index)

def	getCellInnerDimensions (self)

def	getSequentialCellIndex (self, cellInfo)

def	getSequentialCellIndexFromPair (self, index)

def	getCellIndexPair (self, sequentialIndex)

def	__iter__ (self)

def	__len__ (self)

def	__getitem__ (self, index)

def	__eq__ (self, rhs)

def	__ne__ (self, rhs)

def	__str__ (self)

def	__repr__ (self)

Properties
	index = property(getIndex)

	sequential_index = property(getSequentialIndex)

	wcs = property(getWcs)

	inner_bbox = property(getInnerBBox)

	outer_bbox = property(getOuterBBox)

	num_cells = property(getNumCells)

	cell_border = property(getCellBorder)

	cell_inner_dimensions = property(getCellInnerDimensions)

Detailed Description

Information about a patch within a tract of a sky map.

If cellInnerDimensions and cellBorder are set then the patch
will be gridded with cells.

See `TractInfo` for more information.

Parameters
----------
index : `lsst.skymap.Index2D`
    x,y index of patch (a pair of ints)
innerBBox : `lsst.geom.Box2I`
    inner bounding box
outerBBox : `lsst.geom.Box2I`
    inner bounding box
sequentialIndex : `int`
    Patch sequential index
tractWcs : `lsst.afw.geom.SkyWcs`
    Tract WCS object.
cellInnerDimensions : `Iterable` [`int`, `int`] or `lsst.geom.Extent2I`, optional
    Inner dimensions of each cell (x,y pixels).
cellBorder : `int`, optional
    Cell border size (pixels).
numCellsPerPatchInner : `int`, optional
    Number of cells per inner patch region.
numCellsInPatchBorder : `int`, optional
    Number of cells in the patch border.

Definition at line 33 of file patchInfo.py.

Constructor & Destructor Documentation

◆ init()

def lsst.skymap.patchInfo.PatchInfo.__init__	(	self,
		index,
		innerBBox,
		outerBBox,
		sequentialIndex,
		tractWcs,
		cellInnerDimensions = `(0, 0)`,
		cellBorder = `0`,
		numCellsPerPatchInner = `0`,
		numCellsInPatchBorder = `0`
	)

Definition at line 63 of file patchInfo.py.

                  numCellsPerPatchInner=0, numCellsInPatchBorder=0):
         self._index = index
         self._sequentialIndex = sequentialIndex
         self._innerBBox = innerBBox
         self._outerBBox = outerBBox
         self._wcs = tractWcs
         if not outerBBox.contains(innerBBox):
             raise RuntimeError("outerBBox=%s does not contain innerBBox=%s" % (outerBBox, innerBBox))
         if not isinstance(cellInnerDimensions, (Iterable, Extent2I)):
             raise ValueError("Input cellInnerDimensions is not an iterable.")
         if len(cellInnerDimensions) != 2:
             raise ValueError("Input cellInnerDimensions does not have two values.")
         self._cellInnerDimensions = Extent2I(*cellInnerDimensions)
         self._cellBorder = cellBorder
         self._numCellsInPatchBorder = numCellsInPatchBorder
         if numCellsPerPatchInner == 0:
             self._numCells = Index2D(x=0, y=0)
         else:
             # There are numCellsInPatchBorder extra boundary cell on each side
             self._numCells = Index2D(x=numCellsPerPatchInner + 2*numCellsInPatchBorder,
                                      y=numCellsPerPatchInner + 2*numCellsInPatchBorder)
  

Member Function Documentation

◆ eq()

def lsst.skymap.patchInfo.PatchInfo.__eq__	(	self,
		rhs
	)

Definition at line 348 of file patchInfo.py.

     def __eq__(self, rhs):
         return (self.getIndex() == rhs.getIndex()) \
             and (self.getInnerBBox() == rhs.getInnerBBox()) \
             and (self.getOuterBBox() == rhs.getOuterBBox()) \
             and (self.getNumCells() == rhs.getNumCells()) \
             and (self.getCellBorder() == rhs.getCellBorder())
  

◆ getitem()

def lsst.skymap.patchInfo.PatchInfo.__getitem__	(	self,
		index
	)

Definition at line 345 of file patchInfo.py.

     def __getitem__(self, index):
         return self.getCellInfo(index)
  

◆ iter()

def lsst.skymap.patchInfo.PatchInfo.__iter__ ( self )

Definition at line 335 of file patchInfo.py.

     def __iter__(self):
         xNum, yNum = self.getNumCells()
         for y in range(yNum):
             for x in range(xNum):
                 yield self.getCellInfo(Index2D(x=x, y=y))
  

◆ len()

def lsst.skymap.patchInfo.PatchInfo.__len__ ( self )

Definition at line 341 of file patchInfo.py.

     def __len__(self):
         xNum, yNum = self.getNumCells()
         return xNum*yNum
  

◆ ne()

def lsst.skymap.patchInfo.PatchInfo.__ne__	(	self,
		rhs
	)

Definition at line 355 of file patchInfo.py.

     def __ne__(self, rhs):
         return not self.__eq__(rhs)
  

◆ repr()

def lsst.skymap.patchInfo.PatchInfo.__repr__ ( self )

Definition at line 361 of file patchInfo.py.

     def __repr__(self):
         if self.getNumCells()[0] > 0:
             return ("PatchInfo(index=%s, innerBBox=%s, outerBBox=%s, cellInnerDimensions=%s, "
                     "cellBorder=%s, numCellsPerPatchInner=%s)") % \
                 (self.getIndex(), self.getInnerBBox(), self.getOuterBBox(),
                  self.getCellInnerDimensions(), self.getCellBorder(),
                  self.getNumCells()[0])
         else:
             return "PatchInfo(index=%s, innerBBox=%s, outerBBox=%s)" % \
                 (self.getIndex(), self.getInnerBBox(), self.getOuterBBox())

◆ str()

def lsst.skymap.patchInfo.PatchInfo.__str__ ( self )

Definition at line 358 of file patchInfo.py.

     def __str__(self):
         return "PatchInfo(index=%s)" % (self.getIndex(),)
  

◆ getCellBorder()

def lsst.skymap.patchInfo.PatchInfo.getCellBorder ( self )

Definition at line 202 of file patchInfo.py.

     def getCellBorder(self):
         return self._cellBorder
  

◆ getCellIndexPair()

def lsst.skymap.patchInfo.PatchInfo.getCellIndexPair	(	self,
		sequentialIndex
	)

Convert a sequential index into an index pair.

Parameters
----------
sequentialIndex : `int`

Returns
-------
x, y : `lsst.skymap.Index2D`

Raises
------
IndexError
    If index is out of range.

Definition at line 311 of file patchInfo.py.

     def getCellIndexPair(self, sequentialIndex):
         """Convert a sequential index into an index pair.
  
         Parameters
         ----------
         sequentialIndex : `int`
  
         Returns
         -------
         x, y : `lsst.skymap.Index2D`
  
         Raises
         ------
         IndexError
             If index is out of range.
         """
         if self._numCells.x == 0 or self._numCells.y == 0:
             raise IndexError("Patch does not contain cells.")
  
         nx, ny = self.getNumCells()
         x = sequentialIndex % nx
         y = sequentialIndex // nx
         return Index2D(x=x, y=y)
  

◆ getCellInfo()

def lsst.skymap.patchInfo.PatchInfo.getCellInfo	(	self,
		index
	)

Return information for the specified cell.

Parameters
----------
index : `lsst.skymap.Index2D` or `int`
    Index of cell, as `Index2D`, or `Iterable` [`int`, `int`];
    or a sequential index as returned by getSequentialCellIndex;
    negative values are not supported.

Returns
-------
result : `lsst.skymap.CellInfo`
    The cell info for that index.

Raises
------
IndexError
    If index is out of range.

Definition at line 207 of file patchInfo.py.

     def getCellInfo(self, index):
         """Return information for the specified cell.
  
         Parameters
         ----------
         index : `lsst.skymap.Index2D` or `int`
             Index of cell, as `Index2D`, or `Iterable` [`int`, `int`];
             or a sequential index as returned by getSequentialCellIndex;
             negative values are not supported.
  
         Returns
         -------
         result : `lsst.skymap.CellInfo`
             The cell info for that index.
  
         Raises
         ------
         IndexError
             If index is out of range.
         """
         if self._numCells.x == 0 or self._numCells.y == 0:
             raise IndexError("Patch does not contain cells.")
         if isinstance(index, Index2D):
             _index = index
         else:
             if isinstance(index, numbers.Number):
                 _index = self.getCellIndexPair(index)
             else:
                 _index = Index2D(*index)
         if (not 0 <= _index.x < self._numCells.x) \
                 or (not 0 <= _index.y < self._numCells.y):
             raise IndexError("Cell index %s is not in range [0-%d, 0-%d]" %
                              (_index, self._numCells.x - 1, self._numCells.y - 1))
         # We offset the index by numCellsInPatchBorder because the cells
         # start outside the inner dimensions.
         # The cells are defined relative to the patch bounding box (within the tract).
         patchInnerBBox = self.getInnerBBox()
         innerMin = Point2I(*[(_index[i] - self._numCellsInPatchBorder)*self._cellInnerDimensions[i]
                              + patchInnerBBox.getBegin()[i]
                              for i in range(2)])
  
         innerBBox = Box2I(innerMin, self._cellInnerDimensions)
         outerBBox = Box2I(innerBBox)
         outerBBox.grow(self._cellBorder)
  
         return CellInfo(
             index=_index,
             innerBBox=innerBBox,
             outerBBox=outerBBox,
             sequentialIndex=self.getSequentialCellIndexFromPair(_index),
             tractWcs=self._wcs
         )
  

◆ getCellInnerDimensions()

def lsst.skymap.patchInfo.PatchInfo.getCellInnerDimensions ( self )

Get dimensions of inner region of the cells (all are the same)

Definition at line 260 of file patchInfo.py.

     def getCellInnerDimensions(self):
         """Get dimensions of inner region of the cells (all are the same)
         """
         return self._cellInnerDimensions
  

◆ getIndex()

def lsst.skymap.patchInfo.PatchInfo.getIndex ( self )

Return patch index: a tuple of (x, y)

Returns
-------
result : `lsst.skymap.Index2D`
    Patch index (x, y).

Definition at line 88 of file patchInfo.py.

     def getIndex(self):
         """Return patch index: a tuple of (x, y)
  
         Returns
         -------
         result : `lsst.skymap.Index2D`
             Patch index (x, y).
         """
         return self._index
  

◆ getInnerBBox()

def lsst.skymap.patchInfo.PatchInfo.getInnerBBox ( self )

Get inner bounding box.

Returns
-------
bbox : `lsst.geom.Box2I`
    The inner bounding Box.

Definition at line 124 of file patchInfo.py.

     def getInnerBBox(self):
         """Get inner bounding box.
  
         Returns
         -------
         bbox : `lsst.geom.Box2I`
             The inner bounding Box.
         """
         return self._innerBBox
  

◆ getInnerSkyPolygon()

def lsst.skymap.patchInfo.PatchInfo.getInnerSkyPolygon	(	self,
		tractWcs = `None`
	)

Get the inner on-sky region.

Parameters
----------
tractWcs : `lsst.afw.image.SkyWcs`, optional
    WCS for the associated tract.

Returns
-------
result : `lsst.sphgeom.ConvexPolygon`
    The inner sky region.

Definition at line 148 of file patchInfo.py.

     def getInnerSkyPolygon(self, tractWcs=None):
         """Get the inner on-sky region.
  
         Parameters
         ----------
         tractWcs : `lsst.afw.image.SkyWcs`, optional
             WCS for the associated tract.
  
         Returns
         -------
         result : `lsst.sphgeom.ConvexPolygon`
             The inner sky region.
         """
         _tractWcs = tractWcs if tractWcs is not None else self._wcs
         return makeSkyPolygonFromBBox(bbox=self.getInnerBBox(), wcs=_tractWcs)
  

◆ getNumCells()

def lsst.skymap.patchInfo.PatchInfo.getNumCells ( self )

Get the number of cells in x, y.

May return (0, 0) if no cells are defined.

Returns
-------
result : `lsst.skymap.Index2D`
    The number of cells in x, y.

Definition at line 188 of file patchInfo.py.

     def getNumCells(self):
         """Get the number of cells in x, y.
  
         May return (0, 0) if no cells are defined.
  
         Returns
         -------
         result : `lsst.skymap.Index2D`
             The number of cells in x, y.
         """
         return self._numCells
  

◆ getOuterBBox()

def lsst.skymap.patchInfo.PatchInfo.getOuterBBox ( self )

Get outer bounding box.

Returns
-------
bbox : `lsst.geom.Box2I`
    The outer bounding Box.

Definition at line 136 of file patchInfo.py.

     def getOuterBBox(self):
         """Get outer bounding box.
  
         Returns
         -------
         bbox : `lsst.geom.Box2I`
             The outer bounding Box.
         """
         return self._outerBBox
  

◆ getOuterSkyPolygon()

def lsst.skymap.patchInfo.PatchInfo.getOuterSkyPolygon	(	self,
		tractWcs = `None`
	)

Get the outer on-sky region.

Parameters
----------
tractWcs : `lsst.afw.image.SkyWcs`, optional
    WCS for the associated tract.

Returns
-------
result : `lsst.sphgeom.ConvexPolygon`
    The outer sky region.

Definition at line 168 of file patchInfo.py.

     def getOuterSkyPolygon(self, tractWcs=None):
         """Get the outer on-sky region.
  
         Parameters
         ----------
         tractWcs : `lsst.afw.image.SkyWcs`, optional
             WCS for the associated tract.
  
         Returns
         -------
         result : `lsst.sphgeom.ConvexPolygon`
             The outer sky region.
         """
         _tractWcs = tractWcs if tractWcs is not None else self._wcs
         return makeSkyPolygonFromBBox(bbox=self.getOuterBBox(), wcs=_tractWcs)
  

◆ getSequentialCellIndex()

def lsst.skymap.patchInfo.PatchInfo.getSequentialCellIndex	(	self,
		cellInfo
	)

Return a single integer that uniquely identifies
the given cell within this patch.

Parameters
----------
cellInfo : `lsst.skymap.CellInfo`

Returns
-------
sequentialIndex : `int`

Raises
------
IndexError
    If index is out of range.

Definition at line 267 of file patchInfo.py.

     def getSequentialCellIndex(self, cellInfo):
         """Return a single integer that uniquely identifies
         the given cell within this patch.
  
         Parameters
         ----------
         cellInfo : `lsst.skymap.CellInfo`
  
         Returns
         -------
         sequentialIndex : `int`
  
         Raises
         ------
         IndexError
             If index is out of range.
         """
         index = cellInfo.getIndex()
         return self.getSequentialCellIndexFromPair(index)
  

◆ getSequentialCellIndexFromPair()

def lsst.skymap.patchInfo.PatchInfo.getSequentialCellIndexFromPair	(	self,
		index
	)

Return a single integer that uniquely identifies
the given cell within this patch.

Parameters
----------
index : `lsst.skymap.Index2D`

Returns
-------
sequentialIndex : `int`

Raises
------
IndexError
    If index is out of range.

Definition at line 287 of file patchInfo.py.

     def getSequentialCellIndexFromPair(self, index):
         """Return a single integer that uniquely identifies
         the given cell within this patch.
  
         Parameters
         ----------
         index : `lsst.skymap.Index2D`
  
         Returns
         -------
         sequentialIndex : `int`
  
         Raises
         ------
         IndexError
             If index is out of range.
         """
         if isinstance(index, Index2D):
             _index = index
         else:
             _index = Index2D(*index)
         nx, ny = self.getNumCells()
         return nx*_index.y + _index.x
  

◆ getSequentialIndex()

def lsst.skymap.patchInfo.PatchInfo.getSequentialIndex ( self )

Return patch sequential index.

Returns
-------
result : `int`
    Sequential patch index.

Definition at line 100 of file patchInfo.py.

     def getSequentialIndex(self):
         """Return patch sequential index.
  
         Returns
         -------
         result : `int`
             Sequential patch index.
         """
         return self._sequentialIndex
  

◆ getWcs()

def lsst.skymap.patchInfo.PatchInfo.getWcs ( self )

Return the associated tract wcs

Returns
-------
wcs : `lsst.afw.geom.SkyWcs`
    Tract WCS.

Definition at line 112 of file patchInfo.py.

     def getWcs(self):
         """Return the associated tract wcs
  
         Returns
         -------
         wcs : `lsst.afw.geom.SkyWcs`
             Tract WCS.
         """
         return self._wcs
  

◆ inner_sky_polygon()

def lsst.skymap.patchInfo.PatchInfo.inner_sky_polygon ( self )

Definition at line 165 of file patchInfo.py.

     def inner_sky_polygon(self):
         return self.getInnerSkyPolygon()
  

◆ outer_sky_polygon()

def lsst.skymap.patchInfo.PatchInfo.outer_sky_polygon ( self )

Definition at line 185 of file patchInfo.py.

     def outer_sky_polygon(self):
         return self.getOuterSkyPolygon()
  

Property Documentation

◆ cell_border

lsst.skymap.patchInfo.PatchInfo.cell_border = property(getCellBorder)

static

Definition at line 205 of file patchInfo.py.

◆ cell_inner_dimensions

lsst.skymap.patchInfo.PatchInfo.cell_inner_dimensions = property(getCellInnerDimensions)

static

Definition at line 265 of file patchInfo.py.

◆ index

lsst.skymap.patchInfo.PatchInfo.index = property(getIndex)

static

Definition at line 98 of file patchInfo.py.

◆ inner_bbox

lsst.skymap.patchInfo.PatchInfo.inner_bbox = property(getInnerBBox)

static

Definition at line 134 of file patchInfo.py.

◆ num_cells

lsst.skymap.patchInfo.PatchInfo.num_cells = property(getNumCells)

static

Definition at line 200 of file patchInfo.py.

◆ outer_bbox

lsst.skymap.patchInfo.PatchInfo.outer_bbox = property(getOuterBBox)

static

Definition at line 146 of file patchInfo.py.

◆ sequential_index

lsst.skymap.patchInfo.PatchInfo.sequential_index = property(getSequentialIndex)

static

Definition at line 110 of file patchInfo.py.

◆ wcs

lsst.skymap.patchInfo.PatchInfo.wcs = property(getWcs)

static

Definition at line 122 of file patchInfo.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/skymap/22.0.1-6-g50866e6+84ff5a128b/python/lsst/skymap/patchInfo.py

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __getitem__()

◆ __iter__()

◆ __len__()

◆ __ne__()

◆ __repr__()

◆ __str__()

◆ getCellBorder()

◆ getCellIndexPair()

◆ getCellInfo()

◆ getCellInnerDimensions()

◆ getIndex()

◆ getInnerBBox()

◆ getInnerSkyPolygon()

◆ getNumCells()

◆ getOuterBBox()

◆ getOuterSkyPolygon()

◆ getSequentialCellIndex()

◆ getSequentialCellIndexFromPair()

◆ getSequentialIndex()

◆ getWcs()

◆ inner_sky_polygon()

◆ outer_sky_polygon()

Property Documentation

◆ cell_border

◆ cell_inner_dimensions

◆ index

◆ inner_bbox

◆ num_cells

◆ outer_bbox

◆ sequential_index

◆ wcs

◆ init()

◆ eq()

◆ getitem()

◆ iter()

◆ len()

◆ ne()

◆ repr()

◆ str()