tidy3d.components.source.Pulse

tidy3d.components.source.Pulse#

class Pulse[source]#

Bases: SourceTime, ABC

A source time that ramps up with some fwidth and oscillates at freq0.

Parameters:

  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • amplitude (NonNegativeFloat = 1.0) – Real-valued maximum amplitude of the time dependence.

  • phase (float = 0.0) – [units = rad]. Phase shift of the time dependence.

  • freq0 (PositiveFloat) – [units = Hz]. Central frequency of the pulse.

  • fwidth (PositiveFloat) – [units = Hz]. Standard deviation of the frequency content of the pulse.

  • offset (ConstrainedFloatValue = 5.0) – Time delay of the maximum value of the pulse in units of 1 / (2pi * fwidth).

Attributes

twidth

Width of pulse in seconds.

attrs

Methods

frequency_range([num_fwidth])

Frequency range within 5 standard deviations of the central frequency.

Inherited Common Usage

freq0#
fwidth#
offset#
property twidth#

Width of pulse in seconds.

frequency_range(num_fwidth=4.0)[source]#

Frequency range within 5 standard deviations of the central frequency.

Parameters:

num_fwidth (float = 4.) – Frequency range defined as plus/minus num_fwidth * self.fwdith.

Returns:

Minimum and maximum frequencies of the GaussianPulse or ContinuousWave power.

Return type:

Tuple[float, float]

__hash__()#

Hash method.