Carrier

class Carrier(attributes_set: Set[ElementAttributes] | None = None)

A Carrier represents the equation underlying a ShapeElement. It is not the equation itself, just a representation of it. For example, a Line element has a carrier that resembles an infinite line.

Carrier classes are parameterized by E_co, representing the type of elements represented by this type of carrier.

Parameters:: attributes_set – The set of ElementAttributes present in elements on this carrier.

Methods

`contains_point`	Return `True` if `point` is coincident to this carrier.
`equivalent_to`	Return `True` if this carrier is equivalent to another.
`find_intersections`	Find all intersection points between this carrier and another.
`group_elements_by_attribute`	Group elements by `ElementAttributes`.
`group_elements_by_coequality`	Group elements by coequality.
`maximize`	Maximize a group of elements.

abstract contains_point(point: ArrayLike) → bool: Return True if point is coincident to this carrier. Fuzzy with tolerance.

abstract equivalent_to(other: Carrier[E_co]) → bool: Return True if this carrier is equivalent to another. Fuzzy with tolerance.

abstract 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, return np.zeros((0, 3)).

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 of ShapeElement 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 with equivalent_to() with match_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() returns True.

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.