locan.data.regions.region.EmptyRegion

class locan.data.regions.region.EmptyRegion

Bases: Region

Region class to define an empty region that has no dimension.

Methods

__init__()
as_artist(**kwargs)
buffer(distance, **kwargs)	Extend the region perpendicular by a distance.
contains(points)	Return list of indices for all points that are inside the region of interest.
from_intervals(intervals)	Constructor for instantiating a line or axis-oriented, box-like Region from list of (min, max) bounds.
from_shapely(shapely_object)
intersection(other)	Returns a region representing the intersection of this region with other.
symmetric_difference(other)	Returns the union of the two regions minus any areas contained in the intersection of the two regions.
union(other)	Returns a region representing the union of this region with other.

Attributes

bounding_box	A region describing the minimum axis-aligned bounding box that encloses the original region.
bounds	Region bounds min_x, min_y, ..., max_x, max_y, .
centroid	Point coordinates for region centroid.
dimension	The region dimension.
elongation	A measure between 0 and 1 for how elongated the object is.
extent	The extent (max_x - min_x), (max_y - min_y), .
intervals	Provide bounds in a tuple (min, max) arrangement.
isoperimetric_quotient	Ratio of the area of a region to the area of a circle with the same perimeter; i.e. ratio of 4 * pi * area to the squared perimeter.
max_distance	The maximum distance between any two points within the region.
points
radial_distance	Average of all absolute distances between vertices and centroid.
region_measure	Region measure, i.e. area (for 2d) or volume (for 3d).
subregion_measure	Measure of the sub-dimensional region, i.e. perimeter length (for 2d) or surface area (for 3d).
vertices	0 - dimensional elements that define the region; also called points.

as_artist(**kwargs)

Return type:

None

property bounding_box: EmptyRegion

A region describing the minimum axis-aligned bounding box that encloses the original region.

Return type:

Region

property bounds: None

Region bounds min_x, min_y, …, max_x, max_y, … for each dimension.

Returns:

of shape (2 * dimension,)

Return type:

npt.NDArray[np.float64] | None

buffer(distance, **kwargs)

Extend the region perpendicular by a distance.

Parameters:

distance (float) – Distance by which the region is extended.

Returns:

The extended region.

Return type:

Region

property centroid: None

Point coordinates for region centroid.

Returns:

of shape (dimension,)

Return type:

npt.NDArray[np.float64] | None

contains(points)

Return list of indices for all points that are inside the region of interest.

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 points that are tested for being inside the specified region.

Returns:

Array with indices for all points in original point array that are within the region.

Return type:

npt.NDArray[np.int64]

property dimension: None

The region dimension.

Return type:

int | None

property elongation: float

A measure between 0 and 1 for how elongated the object is. It is computed as: 1 - the ratio of length of minor axis to length of major axis.

Return type:

float

property extent: None

The extent (max_x - min_x), (max_y - min_y), … for each dimension.

Returns:

of shape (dimension,)

Return type:

npt.NDArray[np.float64] | None

classmethod from_shapely(shapely_object)

Return type:

EmptyRegion

intersection(other)

Returns a region representing the intersection of this region with other.

Parameters:

other (Region) – Other region

Return type:

Region

property intervals: None

Provide bounds in a tuple (min, max) arrangement.

Returns:

((min_x, max_x), …) of shape(dimension, 2)

Return type:

npt.NDArray[np.float64]

property isoperimetric_quotient: float

Ratio of the area of a region to the area of a circle with the same perimeter; i.e. ratio of 4 * pi * area to the squared perimeter.

Sometimes called circularity in 2d and sphericity in 3d.

Return type:

float

property max_distance: float

The maximum distance between any two points within the region.

Return type:

float

property points: ndarray[tuple[int, ...], dtype[float64]]

property radial_distance: float

Average of all absolute distances between vertices and centroid.

Return type:

float

property region_measure: int

Region measure, i.e. area (for 2d) or volume (for 3d).

Return type:

float

property subregion_measure: int

Measure of the sub-dimensional region, i.e. perimeter length (for 2d) or surface area (for 3d).

Return type:

float

symmetric_difference(other)

Returns the union of the two regions minus any areas contained in the intersection of the two regions.

Parameters:

other (Region) – Other region

Return type:

Region

union(other)

Returns a region representing the union of this region with other.

Parameters:

other (Region) – Other region

Return type:

Region

property vertices: ndarray[tuple[int, ...], dtype[float64]]

0 - dimensional elements that define the region; also called points.

Returns:

of shape (n_vertices, dimension)

Return type:

npt.NDArray[np.float64] | list[npt.NDArray[np.float64]]