bluemira.geometry.bound_box

Bounding box object

Classes

BoundingBox

Bounding box class

Module Contents

class bluemira.geometry.bound_box.BoundingBox

Bounding box class

Parameters:

• x_min – Minimum x coordinate

• x_max – Maximum x coordinate

• y_min – Minimum y coordinate

• y_max – Maximum y coordinate

• z_min – Minimum z coordinate

• z_max – Maximum z coordinate

x_min: float

x_max: float

y_min: float

y_max: float

z_min: float

z_max: float

__post_init__()

Perform some silent sanity checks.

classmethod from_xyz(x: numpy.ndarray, y: numpy.ndarray, z: numpy.ndarray) → BoundingBox

Create a BoundingBox from a set of coordinates

Parameters:

• x (numpy.ndarray) – x coordinates from which to create the bounding box

• y (numpy.ndarray) – y coordinates from which to create the bounding box

• z (numpy.ndarray) – z coordinates from which to create the bounding box

Returns:

A BoundingBox from a set of coordinates.

Return type:

BoundingBox

get_box_arrays() → tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray]

Get the x, y, z arrays of the BoundingBox in space.

Returns:

• x_b – x coordinates of the BoundingBox in space

• y_b – y coordinates of the BoundingBox in space

• z_b – z coordinates of the BoundingBox in space

Return type:

tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray]