{
  "title": "BasebandStep",
  "public_path": "flex_rf.tidy3d.BasebandStep",
  "lookup_path": "tidy3d.rf.BasebandStep",
  "slug": "flex_rf/tidy3d/BasebandStep",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/basebandstep/",
  "object_kind": "class",
  "introduction": "Step function source time profile using an error function (erf).\n\nThe signal ramps from 0 to `amplitude` with `rise_time` specifying the\n10%-to-90% rise time.",
  "notes": "",
  "examples": "```python\nstep = BasebandStep(rise_time=1e-9)\n```",
  "references": "",
  "signature": "class BasebandStep(BasebandSourceTime)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/microwave/time.py",
    "url": "",
    "lineno": 44,
    "endlineno": 101
  },
  "bases": [
    "BasebandSourceTime"
  ],
  "parameter_rows": [
    {
      "name": "rise_time",
      "annotation": "PositiveFloat",
      "default": "",
      "description": "The 10%-to-90% rise time in seconds. Related to the Gaussian standard deviation (sigma) by `rise_time ≈ 2.563 * sigma`.",
      "origin": "declared"
    },
    {
      "name": "offset",
      "annotation": "float",
      "default": "5.0",
      "description": "Delay of the step center in units of `rise_time`.",
      "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": "Step never decays, so no end time."
    },
    {
      "name": "frequency_range",
      "kind": "function",
      "signature": "frequency_range(num_fwidth: float = DEFAULT_SIGMA)",
      "description": "Frequency range based on equivalent bandwidth."
    },
    {
      "name": "fwidth_equiv",
      "kind": "function",
      "signature": "fwidth_equiv()",
      "description": "Equivalent frequency-domain standard deviation (sigma_f) in Hz."
    },
    {
      "name": "t_center",
      "kind": "function",
      "signature": "t_center()",
      "description": "Time of the step center in seconds."
    }
  ],
  "group": "flex_rf.tidy3d"
}