tidy3d.components.source.Source#

class Source[source]#

Bases: Box, AbstractSource, ABC

Abstract base class for all sources.

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

  • center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.

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

Attributes

geometry

Box representation of source.

plot_params

Default parameters for plotting a Source object.

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)[source]#

Plot this source.

__hash__()#

Hash method.