{
  "title": "Sphere",
  "public_path": "flex_rf.tidy3d.Sphere",
  "lookup_path": "tidy3d.Sphere",
  "slug": "flex_rf/tidy3d/Sphere",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/sphere/",
  "object_kind": "class",
  "introduction": "Spherical geometry.",
  "notes": "",
  "examples": "```python\nb = Sphere(center=(1,2,3), radius=2)\n```",
  "references": "",
  "signature": "class Sphere(Centered, Circular)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/geometry/primitives.py",
    "url": "",
    "lineno": 127,
    "endlineno": 661
  },
  "bases": [
    "base.Centered",
    "base.Circular"
  ],
  "parameter_rows": [
    {
      "name": "radius",
      "annotation": "TracedSize1D",
      "default": "",
      "description": "Radius of geometry.",
      "origin": "declared"
    },
    {
      "name": "attrs",
      "annotation": "dict",
      "default": "factory: dict",
      "description": "Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, `attrs` are mutable. For example, the following is allowed for setting an `attr` `obj.attrs['foo'] = bar`. Also note that Tidy3D will raise a `TypeError` if `attrs` contain objects that can not be serialized. One can check if `attrs` are serializable by calling `obj.model_dump_json()`.",
      "origin": "inherited"
    },
    {
      "name": "center",
      "annotation": "TracedCoordinate",
      "default": "(0.0, 0.0, 0.0)",
      "description": "Center of object in x, y, and z.",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "bounds",
      "kind": "function",
      "signature": "bounds()",
      "description": "Returns bounding box min and max coordinates."
    },
    {
      "name": "inside",
      "kind": "function",
      "signature": "inside(x: np.ndarray[float], y: np.ndarray[float], z: np.ndarray[float])",
      "description": "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."
    },
    {
      "name": "intersections_plane",
      "kind": "function",
      "signature": "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)",
      "description": "Returns shapely geometry at plane specified by one non None value of x,y,z."
    },
    {
      "name": "intersections_tilted_plane",
      "kind": "function",
      "signature": "intersections_tilted_plane(normal: Coordinate, origin: Coordinate, to_2D: MatrixReal4x4, cleanup: bool = True, quad_segs: int | None = None, section_tolerance_2d: bool = False)",
      "description": "Return a list of shapely geometries at the plane specified by normal and origin."
    },
    {
      "name": "to_triangle_mesh",
      "kind": "function",
      "signature": "to_triangle_mesh(*, max_edge_length: float | None = None, subdivisions: int | None = None)",
      "description": "Approximate the sphere surface with a `TriangleMesh`."
    },
    {
      "name": "unit_sphere_triangles",
      "kind": "function",
      "signature": "unit_sphere_triangles(*, target_edge_length: float | None = None, subdivisions: int | None = None)",
      "description": "Return unit sphere triangles discretized via an icosphere."
    }
  ],
  "group": "flex_rf.tidy3d"
}