sknano.core.geometric_regions.Cuboid.contains

Cuboid.contains(point)

Test region membership of point in Cuboid.

Parameters:

point : array_like

Returns:

bool

True if point is within Cuboid, False, otherwise.

Notes

A point \((p_x, p_y, p_z)\) is within the bounded region of a cuboid with lower corner at \(p_{\mathrm{min}}= (x_{\mathrm{min}}, y_{\mathrm{min}}, z_{\mathrm{min}})\) and upper corner at \(p_{\mathrm{max}}= (x_{\mathrm{max}}, y_{\mathrm{max}}, z_{\mathrm{max}})\) if the following is true:

\[x_{\mathrm{min}}\le x\le x_{\mathrm{max}}\land\]\[y_{\mathrm{min}}\le y\le y_{\mathrm{max}}\land\]\[z_{\mathrm{min}}\le z\le z_{\mathrm{max}}\]