tidy3d.BroadbandPulse

tidy3d.BroadbandPulse#

class BroadbandPulse[source]#

Bases: SourceTime

A source time injecting significant energy in the entire custom frequency range.

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.

  • freq_range (Tuple[float, float]) – [units = Hz]. Frequency range where the pulse should have significant energy.

  • minimum_amplitude (ConstrainedFloatValue = 0.3) – Minimum amplitude of the pulse relative to the peak amplitude in the frequency range.

  • offset (float = 0.0) – An automatic time delay of the peak value of the pulse has been applied under the hood to ensure smooth ramping up of the pulse at time = 0. This offfset is added on top of the automatic time delay in units of 1 / [2pi * (freq_range[1] - freq_range[0])].

Attributes

attrs

Methods

amp_freq(freq)

Complex-valued source amplitude as a function of frequency.

amp_time(time)

Complex-valued source amplitude as a function of time.

end_time()

Time after which the source is effectively turned off / close to zero amplitude.

frequency_range([num_fwidth])

Delegated to frequency_range_sigma(sigma=num_fwidth) for computing the frequency range where the source amplitude is within exp(-num_fwidth**2/2) of the peak amplitude.

frequency_range_sigma([sigma])

Frequency range where the source amplitude is within exp(-sigma**2/2) of the peak amplitude.

Inherited Common Usage

freq_range#
minimum_amplitude#
offset#
end_time()[source]#

Time after which the source is effectively turned off / close to zero amplitude.

amp_time(time)[source]#

Complex-valued source amplitude as a function of time.

amp_freq(freq)[source]#

Complex-valued source amplitude as a function of frequency.

frequency_range_sigma(sigma=4.0)[source]#

Frequency range where the source amplitude is within exp(-sigma**2/2) of the peak amplitude.

frequency_range(num_fwidth=4.0)[source]#

Delegated to frequency_range_sigma(sigma=num_fwidth) for computing the frequency range where the source amplitude is within exp(-num_fwidth**2/2) of the peak amplitude.

__hash__()#

Hash method.