lsst.afw.geom.testUtils.BoxGrid Class Reference

Public Member Functions
	__init__ (self, box, numColRow)
	numColRow (self)
	__getitem__ (self, indXY)
	__len__ (self)
	__iter__ (self)

Public Attributes
	boxClass
	stopDelta
	pointClass

Protected Attributes
	_numColRow
	_divList

Detailed Description

Divide a box into nx by ny sub-boxes that tile the region

The sub-boxes will be of the same type as `box` and will exactly tile `box`;
they will also all be the same size, to the extent possible (some variation
is inevitable for integer boxes that cannot be evenly divided.

Parameters
----------
box : `lsst.geom.Box2I` or `lsst.geom.Box2D`
    the box to subdivide; the boxes in the grid will be of the same type
numColRow : pair of `int`
    number of columns and rows

Definition at line 42 of file testUtils.py.

Constructor & Destructor Documentation

__init__()

lsst.afw.geom.testUtils.BoxGrid.__init__	(		self,
			box,
			numColRow )

Definition at line 57 of file testUtils.py.

    def __init__(self, box, numColRow):
        if len(numColRow) != 2:
            raise RuntimeError(f"numColRow={numColRow!r}; must be a sequence of two integers")
        self._numColRow = tuple(int(val) for val in numColRow)
 
        if isinstance(box, lsst.geom.Box2I):
            stopDelta = 1
        elif isinstance(box, lsst.geom.Box2D):
            stopDelta = 0
        else:
            raise RuntimeError(f"Unknown class {type(box)} of box {box}")
        self.boxClass = type(box)
        self.stopDelta = stopDelta
 
        minPoint = box.getMin()
        self.pointClass = type(minPoint)
        dtype = np.array(minPoint).dtype
 
        self._divList = [np.linspace(start=box.getMin()[i],
                                     stop=box.getMax()[i] + self.stopDelta,
                                     num=self._numColRow[i] + 1,
                                     endpoint=True,
                                     dtype=dtype) for i in range(2)]
 

Member Function Documentation

__getitem__()

lsst.afw.geom.testUtils.BoxGrid.__getitem__	(		self,
			indXY )

Return the box at the specified x,y index

Parameters
----------
indXY : pair of `ints`
    the x,y index to return

Returns
-------
subBox : `lsst.geom.Box2I` or `lsst.geom.Box2D`

Definition at line 85 of file testUtils.py.

    def __getitem__(self, indXY):
        """Return the box at the specified x,y index
 
        Parameters
        ----------
        indXY : pair of `ints`
            the x,y index to return
 
        Returns
        -------
        subBox : `lsst.geom.Box2I` or `lsst.geom.Box2D`
        """
        beg = self.pointClass(*[self._divList[i][indXY[i]] for i in range(2)])
        end = self.pointClass(
            *[self._divList[i][indXY[i] + 1] - self.stopDelta for i in range(2)])
        return self.boxClass(beg, end)
 

__iter__()

lsst.afw.geom.testUtils.BoxGrid.__iter__

(

self

)

Return an iterator over all boxes, where column varies most quickly

Definition at line 105 of file testUtils.py.

    def __iter__(self):
        """Return an iterator over all boxes, where column varies most quickly
        """
        for row in range(self.numColRow[1]):
            for col in range(self.numColRow[0]):
                yield self[col, row]
 
 

__len__()

lsst.afw.geom.testUtils.BoxGrid.__len__

(

self

)

Definition at line 102 of file testUtils.py.

    def __len__(self):
        return self.shape[0]*self.shape[1]
 

numColRow()

lsst.afw.geom.testUtils.BoxGrid.numColRow

(

self

)

Definition at line 82 of file testUtils.py.

    def numColRow(self):
        return self._numColRow
 

Member Data Documentation

_divList

lsst.afw.geom.testUtils.BoxGrid._divList

protected

Definition at line 75 of file testUtils.py.

_numColRow

lsst.afw.geom.testUtils.BoxGrid._numColRow

protected

Definition at line 60 of file testUtils.py.

boxClass

lsst.afw.geom.testUtils.BoxGrid.boxClass

Definition at line 68 of file testUtils.py.

pointClass

lsst.afw.geom.testUtils.BoxGrid.pointClass

Definition at line 72 of file testUtils.py.

stopDelta

lsst.afw.geom.testUtils.BoxGrid.stopDelta

Definition at line 69 of file testUtils.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+be83d3ecdb/python/lsst/afw/geom/testUtils.py