tidy3d.BroadbandModeABCFitterParam

tidy3d.BroadbandModeABCFitterParam#

class BroadbandModeABCFitterParam[source]#

Bases: Tidy3dBaseModel

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

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().

  • max_num_poles (ConstrainedIntValue = 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 (ConstrainedIntValue = 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

attrs

Methods

Inherited Common Usage

max_num_poles#
tolerance_rms#
frequency_sampling_points#
__hash__()#

Hash method.