LoopStructural.datatypes.BoundingBox

class LoopStructural.datatypes.BoundingBox(origin: ndarray | None = None, maximum: ndarray | None = None, nsteps: ndarray | None = None, step_vector: ndarray | None = None, dimensions: int = 3)

Bases: object

A bounding box for a model, defined by the origin, maximum and number of steps in each direction

Parameters:

• dimensions (int, optional) – _description_, by default 3

• origin (Optional[np.ndarray], optional) – _description_, by default None

• maximum (Optional[np.ndarray], optional) – _description_, by default None

• nsteps (Optional[np.ndarray], optional) – _description_, by default None

__init__(origin: ndarray | None = None, maximum: ndarray | None = None, nsteps: ndarray | None = None, step_vector: ndarray | None = None, dimensions: int = 3)

A bounding box for a model, defined by the origin, maximum and number of steps in each direction

Parameters:

• dimensions (int, optional) – _description_, by default 3

• origin (Optional[np.ndarray], optional) – _description_, by default None

• maximum (Optional[np.ndarray], optional) – _description_, by default None

• nsteps (Optional[np.ndarray], optional) – _description_, by default None

Methods

__init__([origin, maximum, nsteps, ...])	A bounding box for a model, defined by the origin, maximum and number of steps in each direction
fit(locations)
get_value(name)
is_inside(xyz)
regular_grid([nsteps, shuffle, order])
with_buffer([buffer])

Attributes

bb
corners	Returns the corners of the bounding box
length
maximum
nelements
origin
step_vector
valid
volume

property corners

Returns the corners of the bounding box

Returns:

_type_ – _description_