{
  "title": "SurfaceImpedanceFitterParam",
  "public_path": "flex_rf.tidy3d.SurfaceImpedanceFitterParam",
  "lookup_path": "tidy3d.rf.SurfaceImpedanceFitterParam",
  "slug": "flex_rf/tidy3d/SurfaceImpedanceFitterParam",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/surfaceimpedancefitterparam/",
  "object_kind": "class",
  "introduction": "Advanced parameters for fitting surface impedance of a `LossyMetalMedium`.\nInternally, the quantity to be fitted is surface impedance divided by `-1j * \\omega`.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class SurfaceImpedanceFitterParam(Tidy3dBaseModel)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/medium.py",
    "url": "",
    "lineno": 5591,
    "endlineno": 5620
  },
  "bases": [
    "Tidy3dBaseModel"
  ],
  "parameter_rows": [
    {
      "name": "max_num_poles",
      "annotation": "PositiveInt",
      "default": "LOSSY_METAL_DEFAULT_MAX_POLES",
      "description": "Maximal number of poles in complex-conjugate pole residue model for fitting surface impedance.",
      "origin": "declared"
    },
    {
      "name": "tolerance_rms",
      "annotation": "NonNegativeFloat",
      "default": "LOSSY_METAL_DEFAULT_TOLERANCE_RMS",
      "description": "Tolerance in fitting.",
      "origin": "declared"
    },
    {
      "name": "frequency_sampling_points",
      "annotation": "PositiveInt",
      "default": "LOSSY_METAL_DEFAULT_SAMPLING_FREQUENCY",
      "description": "Number of sampling frequencies used in fitting.",
      "origin": "declared"
    },
    {
      "name": "log_sampling",
      "annotation": "bool",
      "default": "True",
      "description": "Whether to sample frequencies logarithmically (`True`), or linearly (`False`).",
      "origin": "declared"
    },
    {
      "name": "attrs",
      "annotation": "dict",
      "default": "factory: dict",
      "description": "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.model_dump_json()`.",
      "origin": "inherited"
    }
  ],
  "members": [],
  "group": "flex_rf.tidy3d"
}