{
  "title": "BasebandGaussianPulse",
  "public_path": "flex_rf.tidy3d.BasebandGaussianPulse",
  "lookup_path": "tidy3d.rf.BasebandGaussianPulse",
  "slug": "flex_rf/tidy3d/BasebandGaussianPulse",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/basebandgaussianpulse/",
  "object_kind": "class",
  "introduction": "Unmodulated Gaussian pulse source time profile.\n\nThe signal is a Gaussian envelope centered at `offset * twidth` with\ntemporal width `twidth`.",
  "notes": "",
  "examples": "```python\ngauss = BasebandGaussianPulse(twidth=1e-9)\n```",
  "references": "",
  "signature": "class BasebandGaussianPulse(BasebandSourceTime)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/microwave/time.py",
    "url": "",
    "lineno": 104,
    "endlineno": 148
  },
  "bases": [
    "BasebandSourceTime"
  ],
  "parameter_rows": [
    {
      "name": "twidth",
      "annotation": "PositiveFloat",
      "default": "",
      "description": "Temporal width (standard deviation) of the Gaussian pulse in seconds.",
      "origin": "declared"
    },
    {
      "name": "offset",
      "annotation": "float",
      "default": "5.0",
      "description": "Delay of the pulse peak in units of `twidth`.",
      "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"
    },
    {
      "name": "amplitude",
      "annotation": "NonNegativeFloat",
      "default": "1.0",
      "description": "Real-valued maximum amplitude of the time dependence.",
      "origin": "inherited"
    },
    {
      "name": "phase",
      "annotation": "Literal[0]",
      "default": "0",
      "description": "Phase is locked to 0 for baseband source times (no carrier frequency).",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "amp_time",
      "kind": "function",
      "signature": "amp_time(time: float | ArrayFloat1D)",
      "description": "Real-valued source amplitude as a function of time."
    },
    {
      "name": "end_time",
      "kind": "function",
      "signature": "end_time()",
      "description": "Time after which the source is effectively zero."
    },
    {
      "name": "frequency_range",
      "kind": "function",
      "signature": "frequency_range(num_fwidth: float = DEFAULT_SIGMA)",
      "description": "Frequency range based on equivalent bandwidth."
    },
    {
      "name": "fwidth",
      "kind": "function",
      "signature": "fwidth()",
      "description": "Standard deviation of the frequency content of the Gaussian pulse."
    },
    {
      "name": "t_center",
      "kind": "function",
      "signature": "t_center()",
      "description": "Time of the pulse peak in seconds."
    }
  ],
  "group": "flex_rf.tidy3d"
}