locan.data.hulls.hull.OrientedBoundingBox

class locan.data.hulls.hull.OrientedBoundingBox(points, method=None)[source]

Bases: object

Class with minimal oriented bounding box of localization data.

Parameters:

  • points (Union[_Buffer, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[bool | int | float | complex | str | bytes]]) – Coordinates of input points with shape (npoints, ndim).

  • method (Optional[Literal['shapely', 'open3d']]) – Specific class to compute the convex hull and attributes.

Variables:

  • method (Literal['shapely', 'open3d'] | None) – Specific class to compute the convex hull and attributes.

  • hull (Polygon) – Object from the minimum_rotated_rectangle method

  • dimension (int) – Spatial dimension of hull

  • vertices (npt.NDArray[np.float64]) – Coordinates of points that make up the hull. Array of shape (ndim, 2).

  • width (npt.NDArray[np.float64]) – Array with lengths of box edges.

  • region_measure (float) – hull measure, i.e. area or volume

  • subregion_measure (float) – measure of the sub-dimensional region, i.e. circumference or surface

  • region (Region) – Convert the hull to a Region object.

Methods

__init__(points[, method])