tidy3d.ClipOperation

class ClipOperation

Bases: Geometry

Class representing the result of a set operation between geometries.

Parameters:

• operation (Literal['union', 'intersection', 'difference', 'symmetric_difference']) – Operation to be performed between geometries.

• geometry_a (Union[Box, Transformed, ClipOperation, GeometryGroup, GeometryArray, Sphere, Cylinder, PolySlab, ComplexPolySlabBase, TriangleMesh]) – First operand for the set operation. It can be any geometry type, including GeometryGroup.

• geometry_b (Union[Box, Transformed, ClipOperation, GeometryGroup, GeometryArray, Sphere, Cylinder, PolySlab, ComplexPolySlabBase, TriangleMesh]) – Second operand for the set operation. It can also be any geometry type.

Attributes

bounds	Returns bounding box min and max coordinates.
operation
geometry_a
geometry_b

Methods

inside(x, y, z)	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, y, z)	Faster way to check self.inside on a meshgrid.
intersections_plane([x, y, z, cleanup, ...])	Returns list of shapely geometries at plane specified by one non-None value of x,y,z.
intersections_tilted_plane(normal, origin, to_2D)	Return a list of shapely geometries at the plane specified by normal and origin.
to_polygon_list(base_geometry[, cleanup])	Return a list of valid polygons from a shapely geometry, discarding points, lines, and empty polygons, and empty triangles within polygons.

operation

geometry_a

geometry_b

static to_polygon_list(base_geometry, cleanup=False)

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

Parameters:

• base_geometry (shapely.geometry.base.BaseGeometry) – Base geometry for inspection.

• cleanup (bool = False) – If True, removes extremely small features from each polygon’s boundary. This is useful for removing artifacts from 2D plots displayed to the user.

Returns:

Valid polygons retrieved from base geometry.

Return type:

list[shapely.geometry.base.BaseGeometry]

intersections_tilted_plane(normal, origin, to_2D, cleanup=True, quad_segs=None)

Return a list of shapely geometries at the plane specified by normal and origin.

Parameters:

• normal (Coordinate) – Vector defining the normal direction to the plane.

• origin (Coordinate) – Vector defining the plane origin.

• to_2D (MatrixReal4x4) – Transformation matrix to apply to resulting shapes.

• cleanup (bool = True) – If True, removes extremely small features from each polygon’s boundary.

• quad_segs (Optional[int] = None) – Number of segments used to discretize circular shapes. If None, uses high-quality visualization settings.

Returns:

List of 2D shapes that intersect plane. For more details refer to Shapely’s Documentation.

Return type:

list[shapely.geometry.base.BaseGeometry]

intersections_plane(x=None, y=None, z=None, cleanup=True, quad_segs=None)

Returns list of shapely geometries at plane specified by one non-None value of x,y,z.

Parameters:

• x (float = None) – Position of plane in x direction, only one of x,y,z can be specified to define plane.

• y (float = None) – Position of plane in y direction, only one of x,y,z can be specified to define plane.

• z (float = None) – Position of plane in z direction, only one of x,y,z can be specified to define plane.

• cleanup (bool = True) – If True, removes extremely small features from each polygon’s boundary.

• quad_segs (Optional[int] = None) – Number of segments used to discretize circular shapes. If None, uses high-quality visualization settings.

Returns:

List of 2D shapes that intersect plane. For more details refer to Shapely’s Documentaton.

Return type:

list[shapely.geometry.base.BaseGeometry]

property bounds

Returns bounding box min and max coordinates.

Returns:

Min and max bounds packaged as (minx, miny, minz), (maxx, maxy, maxz).

Return type:

tuple[float, float, float], tuple[float, float float]

inside(x, y, z)

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.

Parameters:

• x (np.ndarray[float]) – Array of point positions in x direction.

• y (np.ndarray[float]) – Array of point positions in y direction.

• z (np.ndarray[float]) – Array of point positions in z direction.

Returns:

True for every point that is inside the geometry.

Return type:

np.ndarray[bool]

inside_meshgrid(x, y, z)

Faster way to check self.inside on a meshgrid. The input arrays are assumed sorted.

Parameters:

• x (np.ndarray[float]) – 1D array of point positions in x direction.

• y (np.ndarray[float]) – 1D array of point positions in y direction.

• z (np.ndarray[float]) – 1D array of point positions in z direction.

Returns:

Array with shape (x.size, y.size, z.size), which is True for every point that is inside the geometry.

Return type:

np.ndarray[bool]