flex_rf.tidy3d.GaussianPulse

Type: class │ Base(s): Pulse

Description

Source time dependence that describes a Gaussian pulse.

Example(s)

pulse = GaussianPulse(freq0=200e12, fwidth=20e12)

Parameters

freq0 [PositiveFloat]

Central frequency of the pulse.

fwidth [PositiveFloat]

Standard deviation of the frequency content of the pulse.

amplitude [NonNegativeFloat] = 1.0

Real-valued maximum amplitude of the time dependence.

phase [float] = 0.0

Phase shift of the time dependence.

offset [float] = 5.0

Time delay of the maximum value of the pulse in units of 1 / (2pi * fwidth).

remove_dc_component [bool] = True

Whether to remove the DC component in the Gaussian pulse spectrum. If True, the Gaussian pulse is modified at low frequencies to zero out the DC component, which is usually desirable so that the fields will decay. However, for broadband simulations, it may be better to have non-vanishing source power near zero frequency. Setting this to False results in an unmodified Gaussian pulse spectrum which can have a nonzero DC component.

Attributes

amp_complex [complex]

Grab the complex amplitude from a GaussianPulse.

offset_time [float]

Offset time in seconds. Note that in the case of DC removal, the maximal value of pulse can be shifted.

peak_frequency [float]

Frequency at which the source time dependence has its peak amplitude in the frequency domain.

peak_time [float]

Peak time in seconds, defined by offset.

Methods

amp_freq(freq: float)

Complex-valued source spectrum in frequency domain.

amp_time(time: float | ArrayFloat1D)

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_sigma(sigma: float = DEFAULT_SIGMA)

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

from_amp_complex(amp: complex, **kwargs: Any)

Set the complex amplitude of a GaussianPulse.

from_frequency_range(fmin: PositiveFloat, fmax: PositiveFloat, minimum_source_bandwidth: PositiveFloat | None = None, **kwargs: Any)

Create a GaussianPulse that maximizes its amplitude in the frequency range [fmin, fmax].