Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.ClipOperation

Type: class │ Base(s): Geometry

Description

Section titled “Description”

Class representing the result of a set operation between geometries.

Parameters

Section titled “Parameters”
operation [ClipOperationType]

Operation to be performed between geometries.
geometry_a [discriminated_union(GeometryType)]

First operand for the set operation. It can be any geometry type, including GeometryGroup.
geometry_b [discriminated_union(GeometryType)]

Second operand for the set operation. It can also be any geometry type.

Methods

Section titled “Methods”
bounds()

Returns bounding box min and max coordinates.
inside(x: NDArray[float], y: NDArray[float], z: NDArray[float])

For input arrays x, y, z of arbitrary but identical shape, return an array with the same shape which is True for every point in zip(x, y, z) that is inside the volume of the Geometry, and False otherwise.
inside_meshgrid(x: NDArray[float], y: NDArray[float], z: NDArray[float])

Faster way to check self.inside on a meshgrid. The input arrays are assumed sorted.
intersections_plane(x: float | None = None, y: float | None = None, z: float | None = None, cleanup: bool = True, quad_segs: int | None = None, section_tolerance_2d: bool = False)

Returns list of shapely geometries at plane specified by one non-None value of x,y,z.
intersections_tilted_plane(normal: Coordinate, origin: Coordinate, to_2D: MatrixReal4x4, cleanup: bool = True, quad_segs: int | None = None, section_tolerance_2d: bool = False)

Return a list of shapely geometries at the plane specified by normal and origin.
to_polygon_list(base_geometry: Shapely, cleanup: bool = False)

Return a list of valid polygons from a shapely geometry, discarding points, lines, and empty polygons, and empty triangles within polygons.

Machine-Readable Export

Section titled “Machine-Readable Export”