tidy3d.components.source.Source

class Source

Bases: Box, AbstractSource, ABC

Abstract base class for all sources.

Parameters:

• name (Attribute: name) –

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

• center (Attribute: center) –

  Type	Tuple[float, float, float]
  Default	= (0.0, 0.0, 0.0)
  Units	um
  Description	Center of object in x, y, and z.

• size (Attribute: size) –

  Type	Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]
  Default
  Units	um
  Description	Size in x, y, and z directions.

• source_time (Attribute: source_time) –

  Type	Union[GaussianPulse, ContinuousWave, CustomSourceTime]
  Default
  Description	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.

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.

__hash__()

Hash method.