{
  "title": "BasebandCustomSourceTime",
  "public_path": "flex_rf.tidy3d.BasebandCustomSourceTime",
  "lookup_path": "tidy3d.rf.BasebandCustomSourceTime",
  "slug": "flex_rf/tidy3d/BasebandCustomSourceTime",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/basebandcustomsourcetime/",
  "object_kind": "class",
  "introduction": "Custom baseband source time profile from a user-provided time-domain dataset.\n\nThe signal is defined by a `source_time_dataset` containing the time-domain\nenvelope.",
  "notes": "",
  "examples": "```python\ncst = BasebandCustomSourceTime.from_values(values=np.linspace(0, 1, 100), dt=1e-10)\n```",
  "references": "",
  "signature": "class BasebandCustomSourceTime(BasebandSourceTime)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/microwave/time.py",
    "url": "",
    "lineno": 222,
    "endlineno": 348
  },
  "bases": [
    "BasebandSourceTime"
  ],
  "parameter_rows": [
    {
      "name": "source_time_dataset",
      "annotation": "TimeDataset | None",
      "default": "None",
      "description": "Dataset for storing the baseband source time envelope. If `None`, the source produces no signal and must be populated before use.",
      "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": "data_times",
      "kind": "attribute",
      "signature": "data_times: ArrayFloat1D",
      "description": "Times of envelope definition."
    },
    {
      "name": "end_time",
      "kind": "function",
      "signature": "end_time()",
      "description": "Time of the last non-zero value in the dataset."
    },
    {
      "name": "frequency_range",
      "kind": "function",
      "signature": "frequency_range(num_fwidth: float = DEFAULT_SIGMA)",
      "description": "Frequency range computed from FFT of the source envelope."
    },
    {
      "name": "from_values",
      "kind": "function",
      "signature": "from_values(values: ArrayFloat1D, dt: float, **kwargs: Any)",
      "description": "Create a `BasebandCustomSourceTime` from a numpy array."
    }
  ],
  "group": "flex_rf.tidy3d"
}