Ellipse

class nrv.utils.geom.Ellipse(center: tuple[float, float] = (0, 0), radius: tuple[float, float] = (10, 10), rot: float = None, degree: bool = False)

Ellipse class that inherits from Cshape. Represents an ellipse with a center, semi-major axis, and semi-minor axis.

Attributes

Ellipse.area	Area of the ellipse.
Ellipse.bbox	Coordinates of the axis-aligned bounding box.
Ellipse.bbox_size	Size of the axis-aligned bounding box.
Ellipse.c	Center of the ellipse as an array.
Ellipse.is_rot	Indicate whether the ellipse is rotated.
Ellipse.perimeter	Perimeter of the shape in $mu m^2$
Ellipse.r	Semi-axis lengths of the ellipse.
Ellipse.rot_mat	rotation matrix
Ellipse.rot_mat_inverse	Inverse rotation matrix
Ellipse.x	X-coordinate placeholder for 2D shapes.
Ellipse.y	Y-coordinate of the shape center.
Ellipse.z	Z-coordinate of the shape center.

Methods

Ellipse.__init__([center, radius, rot, degree])	Initializes the Ellipse
Ellipse.get_parameters()	Generic method returning all the atributes of an NRV_class instance
Ellipse.get_point_inside([n_pts, delta])	Draw random points inside the ellipse.
Ellipse.get_trace([n_theta])	Sample the ellipse boundary.
Ellipse.is_inside(point[, delta, for_all])	Check whether one or several points lie inside the ellipse.
Ellipse.load(data[, blacklist])	Generic loading method for NRV_class instance
Ellipse.plot(axes[, n_tetha, add_center])	plot the border of the shape
Ellipse.plot_bbox(axes, *args, **kwgs)	plot the border of the shape
Ellipse.rotate(angle[, degree])	Rotate the ellipse around its center.
Ellipse.save([save, fname, blacklist])	Generic saving method for NRV_class instance.
Ellipse.set_parameters(**kawrgs)	Generic method to set any attribute of NRV_class instance
Ellipse.translate([y, z])	Translate the shape.