tidy3d.components.structure.AbstractStructure

class AbstractStructure

Bases: Tidy3dBaseModel

A basic structure object.

Parameters:

• geometry (Attribute: geometry) –

  Type	Union[Box, Transformed, ClipOperation, GeometryGroup, Sphere, Cylinder, PolySlab, ComplexPolySlabBase, TriangleMesh]
  Default
  Description	Defines geometric properties of the structure.

• name (Attribute: name) –

  Type	Optional[str]
  Default	= None
  Description	Optional name for the structure.

Attributes

geometry

Methods

plot([x, y, z, ax])

Plot structure's geometric cross section at single (x,y,z) coordinate.

geometry

name

plot(x=None, y=None, z=None, ax=None, **patch_kwargs)

Plot structure’s geometric cross section at single (x,y,z) coordinate.

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.

• ax (matplotlib.axes._subplots.Axes = None) – Matplotlib axes to plot on, if not specified, one is created.

• **patch_kwargs – Optional keyword arguments passed to the matplotlib patch plotting of structure. For details on accepted values, refer to Matplotlib’s documentation.

Returns:

The supplied or created matplotlib axes.

Return type:

matplotlib.axes._subplots.Axes

__hash__()

Hash method.