locan.data.regions.region.RegionND

class locan.data.regions.region.RegionND[source]

Bases: Region

Abstract Region class to define the interface for n-dimensional Region classes.

Methods

__init__()

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.

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.

max_distance

The maximum distance between any two points within the region.

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.

intersection(other)[source]

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

Parameters:

other (Region) – Other region

Return type:

Region

symmetric_difference(other)[source]

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)[source]

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

Parameters:

other (Region) – Other region

Return type:

Region