Box2I

class lsst.geom.Box2I

Bases: pybind11_builtins.pybind11_object

Attributes Summary

EXPAND
SHRINK
area
beginX
beginY
centerX
centerY
endX
endY
height
maxX
maxY
minX
minY
slices
width
x
y

Methods Summary

clip(self, arg0)
clippedTo(self, arg0)
contains(*args, **kwargs) Overloaded function.
dilatedBy(*args, **kwargs) Overloaded function.
erodedBy(*args, **kwargs) Overloaded function.
expandedTo(*args, **kwargs) Overloaded function.
flipLR(self, arg0)
flipTB(self, arg0)
getArea(self)
getBegin(self)
getBeginX(self)
getBeginY(self)
getCenter(self)
getCenterX(self)
getCenterY(self)
getCorners(self)
getDimensions(self)
getEnd(self)
getEndX(self)
getEndY(self)
getHeight(self)
getMax(self)
getMaxX(self)
getMaxY(self)
getMin(self)
getMinX(self)
getMinY(self)
getSlices(self)
getWidth(self)
getX(self)
getY(self)
grid([dtype]) Return pair of arrays with the centers of all pixels in the box.
grow(*args, **kwargs) Overloaded function.
include(*args, **kwargs) Overloaded function.
intersects(self, arg0)
isDisjointFrom(self, arg0)
isEmpty(self)
makeCenteredBox(center, size)
overlaps(self, arg0)
reflectedAboutX(self, arg0)
reflectedAboutY(self, arg0)
shift(self, arg0)
shiftedBy(self, arg0)
swap(self, arg0)
toString(self)

Attributes Documentation

EXPAND = EdgeHandlingEnum.EXPAND
SHRINK = EdgeHandlingEnum.SHRINK
area
beginX
beginY
centerX
centerY
endX
endY
height
maxX
maxY
minX
minY
slices
width
x
y

Methods Documentation

clip(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) → None
clippedTo(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) → lsst.geom.Box2I
contains(*args, **kwargs)

Overloaded function.

  1. contains(self: lsst.geom.Box2I, arg0: lsst.geom.Point2I) -> bool
  2. contains(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) -> bool
  3. contains(self: lsst.geom.Box2I, x: numpy.ndarray[int32], y: numpy.ndarray[int32]) -> object
dilatedBy(*args, **kwargs)

Overloaded function.

  1. dilatedBy(self: lsst.geom.Box2I, arg0: int) -> lsst.geom.Box2I
  2. dilatedBy(self: lsst.geom.Box2I, arg0: lsst.geom.Extent2I) -> lsst.geom.Box2I
erodedBy(*args, **kwargs)

Overloaded function.

  1. erodedBy(self: lsst.geom.Box2I, arg0: int) -> lsst.geom.Box2I
  2. erodedBy(self: lsst.geom.Box2I, arg0: lsst.geom.Extent2I) -> lsst.geom.Box2I
expandedTo(*args, **kwargs)

Overloaded function.

  1. expandedTo(self: lsst.geom.Box2I, arg0: lsst.geom.Point2I) -> lsst.geom.Box2I
  2. expandedTo(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) -> lsst.geom.Box2I
flipLR(self: lsst.geom.Box2I, arg0: int) → None
flipTB(self: lsst.geom.Box2I, arg0: int) → None
getArea(self: lsst.geom.Box2I) → int
getBegin(self: lsst.geom.Box2I) → lsst.geom.Point2I
getBeginX(self: lsst.geom.Box2I) → int
getBeginY(self: lsst.geom.Box2I) → int
getCenter(self: lsst.geom.Box2I) → lsst.geom.Point2D
getCenterX(self: lsst.geom.Box2I) → float
getCenterY(self: lsst.geom.Box2I) → float
getCorners(self: lsst.geom.Box2I) → List[lsst.geom.Point2I]
getDimensions(self: lsst.geom.Box2I) → lsst.geom.Extent2I
getEnd(self: lsst.geom.Box2I) → lsst.geom.Point2I
getEndX(self: lsst.geom.Box2I) → int
getEndY(self: lsst.geom.Box2I) → int
getHeight(self: lsst.geom.Box2I) → int
getMax(self: lsst.geom.Box2I) → lsst.geom.Point2I
getMaxX(self: lsst.geom.Box2I) → int
getMaxY(self: lsst.geom.Box2I) → int
getMin(self: lsst.geom.Box2I) → lsst.geom.Point2I
getMinX(self: lsst.geom.Box2I) → int
getMinY(self: lsst.geom.Box2I) → int
getSlices(self: lsst.geom.Box2I) → tuple
getWidth(self: lsst.geom.Box2I) → int
getX(self: lsst.geom.Box2I) → lsst.geom.IntervalI
getY(self: lsst.geom.Box2I) → lsst.geom.IntervalI
grid(dtype=<class 'numpy.int32'>)

Return pair of arrays with the centers of all pixels in the box.

Parameters:
dtype : convertible to numpy.dtype

The data type of the returned arrays.

Returns:
x : numpy.ndarray

Array with shape (self.height, self.width) containing x coordinate values.

y : numpy.ndarray

Array with shape (self.height, self.width) containing x coordinate values.

grow(*args, **kwargs)

Overloaded function.

  1. grow(self: lsst.geom.Box2I, arg0: int) -> None
  2. grow(self: lsst.geom.Box2I, arg0: lsst.geom.Extent2I) -> None
include(*args, **kwargs)

Overloaded function.

  1. include(self: lsst.geom.Box2I, arg0: lsst.geom.Point2I) -> None
  2. include(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) -> None
intersects(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) → bool
isDisjointFrom(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) → bool
isEmpty(self: lsst.geom.Box2I) → bool
static makeCenteredBox(center: lsst.geom.Point2D, size: lsst.geom.Extent2I) → lsst.geom.Box2I
overlaps(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) → bool
reflectedAboutX(self: lsst.geom.Box2I, arg0: int) → lsst.geom.Box2I
reflectedAboutY(self: lsst.geom.Box2I, arg0: int) → lsst.geom.Box2I
shift(self: lsst.geom.Box2I, arg0: lsst.geom.Extent2I) → None
shiftedBy(self: lsst.geom.Box2I, arg0: lsst.geom.Extent2I) → lsst.geom.Box2I
swap(self: lsst.geom.Box2I, arg0: lsst.geom.Box2I) → None
toString(self: lsst.geom.Box2I) → str