{
  "title": "ApodizationSpec",
  "public_path": "flex_rf.tidy3d.ApodizationSpec",
  "lookup_path": "tidy3d.ApodizationSpec",
  "slug": "flex_rf/tidy3d/ApodizationSpec",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/apodizationspec/",
  "object_kind": "class",
  "introduction": "Stores specifications for the apodizaton of frequency-domain monitors.",
  "notes": "",
  "examples": "```python\napod_spec = ApodizationSpec(start=1, end=2, width=0.2)\n```",
  "references": "",
  "signature": "class ApodizationSpec(Tidy3dBaseModel)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/apodization.py",
    "url": "",
    "lineno": 21,
    "endlineno": 107
  },
  "bases": [
    "Tidy3dBaseModel"
  ],
  "parameter_rows": [
    {
      "name": "start",
      "annotation": "NonNegativeFloat | None",
      "default": "None",
      "description": "Defines the time at which the start apodization ends.",
      "origin": "declared"
    },
    {
      "name": "end",
      "annotation": "NonNegativeFloat | None",
      "default": "None",
      "description": "Defines the time at which the end apodization begins.",
      "origin": "declared"
    },
    {
      "name": "width",
      "annotation": "PositiveFloat | None",
      "default": "None",
      "description": "Characteristic decay length of the apodization function, i.e., the width of the ramping up of the scaling function from 0 to 1.",
      "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": "end_greater_than_start",
      "kind": "function",
      "signature": "end_greater_than_start()",
      "description": "Ensure end is greater than or equal to start."
    },
    {
      "name": "plot",
      "kind": "function",
      "signature": "plot(times: ArrayFloat1D, ax: Ax = None)",
      "description": "Plot the apodization function."
    },
    {
      "name": "width_provided",
      "kind": "function",
      "signature": "width_provided()",
      "description": "Check that width is provided if either start or end apodization is requested."
    }
  ],
  "group": "flex_rf.tidy3d"
}