{
  "title": "AxisAlignedVoltageIntegralSpec",
  "public_path": "flex_rf.tidy3d.AxisAlignedVoltageIntegralSpec",
  "lookup_path": "tidy3d.rf.AxisAlignedVoltageIntegralSpec",
  "slug": "flex_rf/tidy3d/AxisAlignedVoltageIntegralSpec",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/axisalignedvoltageintegralspec/",
  "object_kind": "class",
  "introduction": "Class for specifying the voltage calculation between two points defined by an axis-aligned line.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class AxisAlignedVoltageIntegralSpec(AxisAlignedPathIntegralSpec)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/microwave/path_integrals/specs/voltage.py",
    "url": "",
    "lineno": 31,
    "endlineno": 155
  },
  "bases": [
    "AxisAlignedPathIntegralSpec"
  ],
  "parameter_rows": [
    {
      "name": "sign",
      "annotation": "Direction",
      "default": "",
      "description": "Positive indicates V=Vb-Va where position b has a larger coordinate along the axis of integration.",
      "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": "center",
      "annotation": "TracedCoordinate",
      "default": "(0.0, 0.0, 0.0)",
      "description": "Center of object in x, y, and z.",
      "origin": "inherited"
    },
    {
      "name": "size",
      "annotation": "TracedSize",
      "default": "",
      "description": "Size in x, y, and z directions.",
      "origin": "inherited"
    },
    {
      "name": "extrapolate_to_endpoints",
      "annotation": "bool",
      "default": "False",
      "description": "If the endpoints of the path integral terminate at or near a material interface, the field is likely discontinuous. When this field is `True`, fields that are outside and on the bounds of the integral are ignored. Should be enabled when computing voltage between two conductors.",
      "origin": "inherited"
    },
    {
      "name": "snap_path_to_grid",
      "annotation": "bool",
      "default": "False",
      "description": "It might be desirable to integrate exactly along the Yee grid associated with a field. When this field is `True`, the integration path will be snapped to the grid.",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "from_terminal_positions",
      "kind": "function",
      "signature": "from_terminal_positions(plus_terminal: float, minus_terminal: float, x: float | None = None, y: float | None = None, z: float | None = None, extrapolate_to_endpoints: bool = True, snap_path_to_grid: bool = True)",
      "description": "Helper to create a `AxisAlignedVoltageIntegralSpec` from two coordinates that define a line and two positions indicating the endpoints of the path integral."
    },
    {
      "name": "plot",
      "kind": "function",
      "signature": "plot(x: float | None = None, y: float | None = None, z: float | None = None, ax: Ax = None, plot_markers: bool = True, **path_kwargs: Any)",
      "description": "Plot path integral at single (x,y,z) coordinate."
    }
  ],
  "group": "flex_rf.tidy3d"
}