locan.data.region.Ellipse

class locan.data.region.Ellipse(center=(0, 0), width=1, height=1, angle=0)

Bases: Region2D

Region class to define an ellipse.

Parameters:

• center (npt.ArrayLike) – A point that defines the center of the ellipse with shape (2,).

• width (float) – The length of a vector describing the principal axis in x-direction (before rotation).

• height (float) – The length of a vector describing the principal axis in y-direction (before rotation).

• angle (float) – The angle (in degrees) by which the ellipse is rotated counterclockwise around the center point.

Methods

__init__([center, width, height, angle])
as_artist([origin])	Matplotlib 2D patch object for this region (e.g. matplotlib.patches.Ellipse).
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 axis-oriented, box-like Region from list of (min, max) bounds.
from_shapely(shapely_object)	Constructor for instantiating Region from shapely object.
intersection(other)	Returns a region representing the intersection of this region with other.
plot([ax])	Provide plot of region as matplotlib.axes.Axes object.
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

angle	The angle (in degrees) by which the ellipse is rotated counterclockwise around the center point.
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, .
center	A point that defines the center of the ellipse.
centroid	Point coordinates for region centroid.
dimension	The region dimension.
extent	The extent (max_x - min_x), (max_y - min_y), .
height	The length of a vector describing the principal axis in y-direction (before rotation).
max_distance	The maximum distance between any two points within the region.
points	Point coordinates.
region_measure	Region measure, i.e. area (for 2d) or volume (for 3d).
region_specs	Legacy interface to serve legacy RoiRegion.
shapely_object	Geometric object as defined in shapely.
subregion_measure	Measure of the sub-dimensional region, i.e. circumference (for 2d) or surface (for 3d).
width	The length of a vector describing the principal axis in x-direction (before rotation).

property angle: float

The angle (in degrees) by which the ellipse is rotated counterclockwise around the center point.

Return type:

float

as_artist(origin=(0, 0), **kwargs)

Matplotlib 2D patch object for this region (e.g. matplotlib.patches.Ellipse).

Parameters:

• origin (Union[_SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[Union[bool, int, float, complex, str, bytes]]]) – The (x, y) pixel position of the origin of the displayed image. Default is (0, 0).

• kwargs (Any) – Other parameters passed to the matplotlib.patches object.

Returns:

Matplotlib patch for the specified region.

Return type:

matplotlib.patches.Patch

property center: ndarray[Any, dtype[float64]]

A point that defines the center of the ellipse.

Returns:

with shape (2,)

Return type:

npt.NDArray[np.float64]

property centroid: ndarray[Any, dtype[float64]]

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[_SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[Union[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 height: float

The length of a vector describing the principal axis in y-direction (before rotation).

Return type:

float

property max_distance: float

The maximum distance between any two points within the region.

Return type:

float

property points: ndarray[Any, dtype[float64]]

Point coordinates.

Returns:

of shape (n_points, dimension)

Return type:

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

property region_measure: float

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

Return type:

float

property region_specs

Legacy interface to serve legacy RoiRegion.

Warning

Do not use - will be deprecated.

Return type:

dict

property shapely_object: Polygon

Geometric object as defined in shapely.

Return type:

Shapely object

property subregion_measure: float

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

Return type:

float

property width: float

The length of a vector describing the principal axis in x-direction (before rotation).

Return type:

float