lsst.afw g9b27d6183c+45093347da
Public Member Functions | Public Attributes | List of all members
lsst.afw.geom.testUtils.BoxGrid Class Reference

Public Member Functions

def __init__ (self, box, numColRow)
 
def numColRow (self)
 
def __getitem__ (self, indXY)
 
def __len__ (self)
 
def __iter__ (self)
 

Public Attributes

 boxClass
 
 stopDelta
 
 pointClass
 

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__()

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

Definition at line 57 of file testUtils.py.

Member Function Documentation

◆ __getitem__()

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

◆ __iter__()

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

◆ __len__()

def lsst.afw.geom.testUtils.BoxGrid.__len__ (   self)

Definition at line 102 of file testUtils.py.

◆ numColRow()

def lsst.afw.geom.testUtils.BoxGrid.numColRow (   self)

Definition at line 82 of file testUtils.py.

Member Data Documentation

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