tidy3d.BroadbandModeABCFitterParam#

class BroadbandModeABCFitterParam[source]#

Bases: Tidy3dBaseModel

Parameters for fitting the mode propagation index over the frequency range using pole-residue pair model.

Parameters:
  • max_num_poles (int = 5) – Maximal number of poles in complex-conjugate pole residue model for fitting the mode propagation index.

  • tolerance_rms (NonNegativeFloat = 1e-06) – Tolerance in fitting the mode propagation index.

  • frequency_sampling_points (int = 15) – Number of sampling frequencies used in fitting the mode propagation index.

Notes

The number of poles and frequency sampling points are constrained to be within the range [1, 10] and [1, 101] respectively.

Example

>>> fitter_param = BroadbandModeABCFitterParam(max_num_poles=5, tolerance_rms=1e-4, frequency_sampling_points=10)

Attributes

max_num_poles#
tolerance_rms#
frequency_sampling_points#