{
  "title": "GeometryGroup",
  "public_path": "flex_rf.tidy3d.GeometryGroup",
  "lookup_path": "tidy3d.GeometryGroup",
  "slug": "flex_rf/tidy3d/GeometryGroup",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/geometrygroup/",
  "object_kind": "class",
  "introduction": "A collection of Geometry objects that can be called as a single geometry object.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class GeometryGroup(Geometry)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/geometry/base.py",
    "url": "",
    "lineno": 3592,
    "endlineno": 3855
  },
  "bases": [
    "Geometry"
  ],
  "parameter_rows": [
    {
      "name": "geometries",
      "annotation": "tuple[discriminated_union(GeometryType), ...]",
      "default": "",
      "description": "Tuple of geometries in a single grouping. Can provide significant performance enhancement in `Structure` when all geometries are assigned the same medium.",
      "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"
    }
  ],
  "members": [
    {
      "name": "bounds",
      "kind": "function",
      "signature": "bounds()",
      "description": "Returns bounding box min and max coordinates."
    },
    {
      "name": "inside",
      "kind": "function",
      "signature": "inside(x: NDArray[float], y: NDArray[float], z: 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": "inside_meshgrid",
      "kind": "function",
      "signature": "inside_meshgrid(x: NDArray[float], y: NDArray[float], z: NDArray[float])",
      "description": "Faster way to check `self.inside` on a meshgrid. The input arrays are assumed sorted."
    },
    {
      "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 list of shapely geometries 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": "intersects_axis_position",
      "kind": "function",
      "signature": "intersects_axis_position(axis: float, position: float, section_tolerance_2d: bool = False)",
      "description": "Whether self intersects plane specified by a given position along a normal axis."
    }
  ],
  "group": "flex_rf.tidy3d"
}