{
  "title": "FrequencyUtils",
  "public_path": "flex_rf.tidy3d.FrequencyUtils",
  "lookup_path": "tidy3d.FrequencyUtils",
  "slug": "flex_rf/tidy3d/FrequencyUtils",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/frequencyutils/",
  "object_kind": "class",
  "introduction": "Utilities for classifying frequencies/wavelengths and generating samples for standard optical bands.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class FrequencyUtils(Tidy3dBaseModel)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/frequencies.py",
    "url": "",
    "lineno": 27,
    "endlineno": 237
  },
  "bases": [
    "Tidy3dBaseModel"
  ],
  "parameter_rows": [
    {
      "name": "use_wavelength",
      "annotation": "bool",
      "default": "False",
      "description": "Indicate whether to use wavelengths instead of frequencies for the return values of functions and parameters.",
      "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": [
    {
      "name": "c_band",
      "kind": "function",
      "signature": "c_band(n: int = 8)",
      "description": "Optical C band frequencies/wavelengths sorted by wavelength."
    },
    {
      "name": "classification",
      "kind": "function",
      "signature": "classification(value: float)",
      "description": "Band classification for a given frequency/wavelength."
    },
    {
      "name": "e_band",
      "kind": "function",
      "signature": "e_band(n: int = 11)",
      "description": "Optical E band frequencies/wavelengths sorted by wavelength."
    },
    {
      "name": "l_band",
      "kind": "function",
      "signature": "l_band(n: int = 13)",
      "description": "Optical L band frequencies/wavelengths sorted by wavelength."
    },
    {
      "name": "o_band",
      "kind": "function",
      "signature": "o_band(n: int = 11)",
      "description": "Optical O band frequencies/wavelengths sorted by wavelength."
    },
    {
      "name": "s_band",
      "kind": "function",
      "signature": "s_band(n: int = 15)",
      "description": "Optical S band frequencies/wavelengths sorted by wavelength."
    },
    {
      "name": "u_band",
      "kind": "function",
      "signature": "u_band(n: int = 11)",
      "description": "Optical U band frequencies/wavelengths sorted by wavelength."
    }
  ],
  "group": "flex_rf.tidy3d"
}