bluemira.geometry.bound_box
===========================

.. py:module:: bluemira.geometry.bound_box

.. autoapi-nested-parse::

   Bounding box object



Classes
-------

.. autoapisummary::

   bluemira.geometry.bound_box.BoundingBox


Module Contents
---------------

.. py:class:: BoundingBox

   Bounding box class

   :param x_min: Minimum x coordinate
   :param x_max: Maximum x coordinate
   :param y_min: Minimum y coordinate
   :param y_max: Maximum y coordinate
   :param z_min: Minimum z coordinate
   :param z_max: Maximum z coordinate


   .. py:attribute:: x_min
      :type:  float


   .. py:attribute:: x_max
      :type:  float


   .. py:attribute:: y_min
      :type:  float


   .. py:attribute:: y_max
      :type:  float


   .. py:attribute:: z_min
      :type:  float


   .. py:attribute:: z_max
      :type:  float


   .. py:method:: __post_init__()

      Perform some silent sanity checks.



   .. py:method:: from_xyz(x: numpy.ndarray, y: numpy.ndarray, z: numpy.ndarray) -> BoundingBox
      :classmethod:


      Create a BoundingBox from a set of coordinates

      :param x: x coordinates from which to create the bounding box
      :param y: y coordinates from which to create the bounding box
      :param z: z coordinates from which to create the bounding box

      :returns: A BoundingBox from a set of coordinates.



   .. py:method:: 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