tidy3d.plugins.dipole_emission.EmissionAnalysisRegion

tidy3d.plugins.dipole_emission.EmissionAnalysisRegion#

class EmissionAnalysisRegion[source]#

Bases: Box

Region over which dipole emission is evaluated.

Parameters:

  • center (tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.

  • normal_axis (Literal[0, 1, 2]) – Coordinate axis normal to the selected collection side.

  • direction (Literal['+', '-']) – Side of the structure, along normal_axis, where emission is collected.

  • dl (Union[PositiveFloat, tuple[PositiveFloat, PositiveFloat]]) – [units = um]. Spatial resolution along axes transverse to normal_axis. A scalar applies to both transverse axes; a pair sets the two transverse resolutions independently.

  • optical (The region should contain the sampled emitters and the part of the)

  • radiation. (structure whose scattering response contributes to the collected)

  • half-space (The normal_axis and direction fields select the collection)

  • example (used to interpret far-field angles. For)

  • and (normal_axis=2)

  • Generated (direction="+" describes radiation collected toward +z.)

  • single (simulations require that collection side to be represented by a)

  • real (background medium with)

  • the (nondispersive refractive index over)

  • in (requested frequencies. The dl field controls the spatial resolution)

  • direction. (the plane transverse to the collection)

Attributes

geometry

Box representation of the analysis region.

tangential_axes

Axes transverse to normal_axis.

normal_axis

direction

dl

size

center

Methods

mesh_override(name)

Create the transverse-resolution override for this region.
normal_axis#
direction#
dl#
property tangential_axes#

Axes transverse to normal_axis.

property geometry#

Box representation of the analysis region.

mesh_override(name)[source]#

Create the transverse-resolution override for this region.