Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.GeometryGroup

Type: class │ Base(s): Geometry

Description

Section titled “Description”

A collection of Geometry objects that can be called as a single geometry object.

Parameters

Section titled “Parameters”
geometries [tuple[discriminated_union(GeometryType), ...]]

Tuple of geometries in a single grouping. Can provide significant performance enhancement in Structure when all geometries are assigned the same medium.

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.
intersects_axis_position(axis: float, position: float, section_tolerance_2d: bool = False)

Whether self intersects plane specified by a given position along a normal axis.

Machine-Readable Export

Section titled “Machine-Readable Export”