ArcCarrier
- class ArcCarrier(center: ndarray[3], radius: float, attributes_set: Set[ElementAttributes] | None = None, filled: bool = False)
An
ArcCarrier
represents the equation of a circle.- Parameters:
center – The center of the circle.
radius – The radius of the circle.
attributes_set – The set of
ElementAttributes
present in elements on this carrier.filled – Whether or not this is the carrier of a
Circle
.
Methods
Return
True
ifpoint
is coincident to this carrier.Return
True
if this carrier is equivalent to another.Find all intersection points between this carrier and another.
Create an
ArcCarrier
from the points used to define anArc
.Get the point at a specific angle from 0 on this carrier.
Group elements by
ElementAttributes
.Group elements by coequality.
Maximize a group of elements.
- contains_point(point: ArrayLike) bool
Return
True
ifpoint
is coincident to this carrier. Fuzzy with tolerance.
- equivalent_to(other: ArcCarrier) bool
Return
True
if this carrier is equivalent to another. Fuzzy with tolerance.
- find_intersections(other: Carrier) ndarray
Find all intersection points between this carrier and another. The output should be a numpy array of shape
(n, 3)
where each row is an intersection point. If there are no intersections, returnnp.zeros((0, 3))
.
- classmethod from_points(center: ndarray, start: ndarray[3], midpoint: ndarray[3], end: ndarray[3]) ArcCarrier
Create an
ArcCarrier
from the points used to define anArc
.
- get_point_at_angle(angle: float) ndarray[3]
Get the point at a specific angle from 0 on this carrier.
- classmethod group_elements_by_attribute(elements: Iterable[E_co]) Dict[ElementAttributes, List[E_co]]
Group elements by
ElementAttributes
.- Parameters:
elements – Elements to group.
- Returns:
A mapping of
ElementAttributes
to lists ofShapeElement
instances that have the attributes used as the key in the map.
- classmethod group_elements_by_coequality(elements: Iterable[E_co]) List[List[E_co]]
Group elements by coequality. Two
ShapeElement
instances are considered coequal if they have spatially equivalent carriers ( checked withequivalent_to()
withmatch_attributes=False
).- Parameters:
elements – Elements to group.
- Returns:
A list of elements grouped by coequality. Each entry in this list is a list of coequal elements.
- classmethod maximize(elements: Sequence[E_co]) List[E_co]
Maximize a group of elements. Elements are considered maximal if there are no two elements such that
coincident_with()
returnsTrue
.Specifically, if two elements visually appear to be one, replace the two with the one element they appear to be.
Maximization also performs calibration, which involves finding the “average” carrier of each set of coequal elements and projecting the resulting maximal elements onto this average carrier. This helps account for floating point error in the long run.