tidy3d.components.source.base.Source

class Source

Bases: Box, AbstractSource, ABC

Abstract base class for all sources.

Parameters:

• name (Optional[str] = None) – Optional name for the source.

• center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [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.

• source_time (Union[GaussianPulse, ContinuousWave, CustomSourceTime, BroadbandPulse, BasebandStep, BasebandGaussianPulse, BasebandRectangularPulse, BasebandCustomSourceTime]) – Specification of the source time-dependence.

Attributes

geometry	Box representation of source.
plot_params	Default parameters for plotting a Source object.
source_time
size
center
name

Methods

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

Plot this source.

Inherited Common Usage

source_time

property plot_params

Default parameters for plotting a Source object.

property geometry

Box representation of source.

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

Plot this source.