Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.Sphere

Type: class │ Base(s): Centered, Circular

Description

Section titled “Description”

Spherical geometry.

Example(s)

Section titled “Example(s)”
b = Sphere(center=(1,2,3), radius=2)

Parameters

Section titled “Parameters”
radius [TracedSize1D]

Radius of geometry.
center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.

Methods

Section titled “Methods”
bounds()

Returns bounding box min and max coordinates.
inside(x: np.ndarray[float], y: np.ndarray[float], z: np.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.
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 shapely geometry 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_triangle_mesh(*, max_edge_length: float | None = None, subdivisions: int | None = None)

Approximate the sphere surface with a TriangleMesh.
unit_sphere_triangles(*, target_edge_length: float | None = None, subdivisions: int | None = None)

Return unit sphere triangles discretized via an icosphere.

Machine-Readable Export

Section titled “Machine-Readable Export”