class AxisAlignedPathIntegral[source]#

Bases: AbstractAxesRH, Box

Class for defining the simplest type of path integral, which is aligned with Cartesian axes.

  • attrs (dict = {}) – 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.json().

  • center (Union[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]], Box] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Union[tuple[Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box]], Box]) – [units = um]. Size in x, y, and z directions.

  • extrapolate_to_endpoints (bool = False) – 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.

  • snap_path_to_grid (bool = False) – It might be desireable 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.



Axis for performing integration.




Computes the defined integral given the input scalar_field.

Inherited Common Usage


Computes the defined integral given the input scalar_field.

property main_axis#

Axis for performing integration.


Hash method.