flex_rf.tidy3d.ApodizationSpec
Type: class │ Base(s): Tidy3dBaseModel
Description
Section titled “Description”Stores specifications for the apodizaton of frequency-domain monitors.
Example(s)
Section titled “Example(s)”apod_spec = ApodizationSpec(start=1, end=2, width=0.2)Parameters
Section titled “Parameters”start [NonNegativeFloat | None] = None |
|
Defines the time at which the start apodization ends. |
end [NonNegativeFloat | None] = None |
|
Defines the time at which the end apodization begins. |
width [PositiveFloat | None] = None |
|
Characteristic decay length of the apodization function, i.e., the width of the ramping up of the scaling function from 0 to 1. |
Methods
Section titled “Methods”end_greater_than_start() |
|
Ensure end is greater than or equal to start. |
plot(times: ArrayFloat1D, ax: Ax = None) |
|
Plot the apodization function. |
width_provided() |
|
Check that width is provided if either start or end apodization is requested. |