tidy3d.Geometry.from_gds#
- class from_gds#
Bases:
Import a
gdstk.Cell
and extrude it into a GeometryGroup.- Parameters:
gds_cell (gdstk.Cell) β
gdstk.Cell
containing 2D geometric data.axis (int) β Integer index defining the extrusion axis: 0 (x), 1 (y), or 2 (z).
slab_bounds (Tuple[float, float]) β Minimal and maximal positions of the extruded slab along
axis
.gds_layer (int) β Layer index in the
gds_cell
.gds_dtype (int = None) β Data-type index in the
gds_cell
. IfNone
, imports all data for this layer into the returned list.gds_scale (float = 1.0) β Length scale used in GDS file in units of micrometer. For example, if gds file uses nanometers, set
gds_scale=1e-3
. Must be positive.dilation (float = 0.0) β Dilation (positive) or erosion (negative) amount to be applied to the original polygons.
sidewall_angle (float = 0) β Angle of the extrusion sidewalls, away from the vertical direction, in radians. Positive (negative) values result in slabs larger (smaller) at the base than at the top.
reference_plane (PlanePosition = "middle") β Reference position of the (dilated/eroded) polygons along the slab axis. One of
"middle"
(polygons correspond to the center of the slab bounds),"bottom"
(minimal slab bound position), or"top"
(maximal slab bound position). This value has no effect ifsidewall_angle == 0
.
- Returns:
Geometries created from the 2D data.
- Return type:
Geometry
Inherited Common Usage