Circle

class nrv.utils.geom.Circle(center: tuple[float, float] = (0, 0), radius: float = 10)[source]

Circle class that inherits from Cshape. Represents a circle with a center and radius.

Attributes

Circle.area

Area of the shape in $mu m^2$

Circle.bbox

Coordinate of the bounding box as a numpy.ndarray`in the following format :math:`y_{min}, z_{min}, y_{max}, z_{max}.

Circle.bbox_size

Size of the bounding bounding box of the shape.

Circle.c

Circle.is_rot

Circle.perimeter

Perimeter of the shape in $mu m^2$

Circle.r

Circle.rot_mat

rotation matrix

Circle.rot_mat_inverse

Inverse rotation matrix

Circle.x

Circle.y

Circle.z

Methods

Circle.__init__([center, radius])

Initializes the Circle

Circle.get_parameters()

Generic method returning all the atributes of an NRV_class instance

Circle.get_point_inside([n_pts, delta])

Returns n points coordinate randomly picked inside the shape

Circle.get_trace([n_theta])

Returns the trace of the geometry as a list of points.

Circle.is_inside(point[, delta, for_all])

Checks if a given point is inside the C-shape.

Circle.load(data[, blacklist])

Generic loading method for NRV_class instance

Circle.plot(axes[, n_tetha, add_center])

plot the border of the shape

Circle.plot_bbox(axes, *args, **kwgs)

plot the border of the shape

Circle.rotate(angle[, degree])

Rotate the shape.

Circle.save([save, fname, blacklist])

Generic saving method for NRV_class instance.

Circle.set_parameters(**kawrgs)

Generic method to set any attribute of NRV_class instance

Circle.translate([y, z])

Translate the shape.