#### Previous topic

sknano.core.geometric_regions.Parallelogram.translate

#### Next topic

sknano.core.geometric_regions.Rectangle.a

# sknano.core.geometric_regions.Rectangle¶

class sknano.core.geometric_regions.Rectangle(pmin=None, pmax=None, xmin=0, ymin=0, xmax=1, ymax=1)[source][source]

Geometric2DRegion for a rectangle.

New in version 0.3.0.

Represents an axis-aligned bounded region from $$p_{\mathrm{min}}=(x_{\mathrm{min}},y_{\mathrm{min}})$$ to $$p_{\mathrm{max}}=(x_{\mathrm{max}},y_{\mathrm{max}})$$.

Parameters: pmin, pmax : array_like, optional The minimum and maximum 2D point coordinates of the axis-aligned rectangle from pmin=[xmin, ymin] to pmax=[xmax, ymax]. xmin, ymin : float, optional The minimum $$(x, y)$$ point of the axis-aligned rectangle. xmax, ymax : float, optional The maximum $$(x, y)$$ point of the axis-aligned rectangle.

Notes

Rectangle represents the region $$\left\{\{x, y\}|x_{\mathrm{min}}\le x\le x_{\mathrm{max}} \land y_{\mathrm{min}}\le y\le y_{\mathrm{max}}\right\}$$

Calling Rectangle with no parameters is equivalent to Rectangle(pmin=[0, 0], pmax=[1, 1]).

Attributes

 a Distance between $$x_{\mathrm{max}}-x_{\mathrm{min}}$$. area Rectangle area, $$A=ab$$ b Distance between $$y_{\mathrm{max}}-y_{\mathrm{min}}$$. center Alias for centroid. centroid Rectangle centroid, $$(c_x, c_y)$$. fmtstr Format string. measure Alias for area, which is the measure of a 2D geometric region. pmax 2D Point at (xmax, ymax). pmin 2D Point at (xmin, ymin). xmax $$x_{\mathrm{max}}$$ coordinate. xmin $$x_{\mathrm{min}}$$ coordinate. ymax $$y_{\mathrm{max}}$$ coordinate. ymin $$y_{\mathrm{min}}$$ coordinate.

Methods

 center_centroid() Center centroid on origin. contains(point) Test region membership of point in Rectangle. rotate([angle, axis, anchor_point, ...]) Rotate GeometricRegion points and vectors. todict() Returns a dict of the Rectangle constructor parameters. translate(t[, fix_anchor_points]) Translate GeometricRegion points and vectors by Vector t.