Utilities Module#

union_geometries(*objects) Polygon[source]

Compute the union of multiple geometric objects.

Parameters:

objects (shapely.geometry or object) – A variable number of shapely geometric objects or objects with a ‘_shapely_object’ attribute.

Returns:

A Polygon containing the union of all provided objects.

Return type:

ff.Polygon

The union_geometries function computes the union of multiple geometric objects. This is essential for merging fiber structures and visualizing combined geometries.

nearest_points_exterior(object0, object1) Point[source]

Find the nearest points between the exteriors of two geometric objects.

Parameters:
  • object0 (shapely.geometry or object) – The first geometric object or an object with a ‘_shapely_object’ attribute.

  • object1 (shapely.geometry or object) – The second geometric object or an object with a ‘_shapely_object’ attribute.

Returns:

A Point containing the coordinates of the nearest point on the first object to the second.

Return type:

ff.Point

The nearest_points_exterior function finds the closest points between two geometric objects, aiding in aligning and connecting fibers within the structure.

intersection_geometries(*objects) Polygon[source]

Compute the intersection of multiple geometric objects.

Parameters:

objects (shapely.geometry or object) – A variable number of shapely geometric objects or objects with a ‘_shapely_object’ attribute.

Returns:

A Polygon containing the intersection of all provided objects.

Return type:

ff.Polygon

The intersection_geometries function computes the intersection of multiple geometric objects, which is useful for identifying overlap regions and managing fiber fusion scenarios.