locan.data.hulls.hull.ConvexHull#

class locan.data.hulls.hull.ConvexHull(points, method='scipy')[source]#

Bases: object

Class with convex hull of localization data.

Parameters:

  • points (npt.ArrayLike) – Coordinates of input points. Array with shape (npoints, ndim).

  • method (Literal['scipy', 'shapely']) – Specific class to compute the convex hull and attributes. One of ‘scipy’, ‘shapely’.

Variables:

  • method (Literal['scipy', 'shapely']) – Specific class to compute the convex hull and attributes. One of ‘scipy’, ‘shapely’.

  • hull (Hull) – Polygon object from the .convex_hull 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).

  • vertex_indices (npt.NDArray[np.int64]) – indices identifying a polygon of all points that make up the hull

  • points_on_boundary (int) – The absolute number of points on the hull

  • points_on_boundary_rel (int) – The number of points on the hull relative to all input points

  • 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])