tidy3d.FieldProjectionSurface#

class FieldProjectionSurface[source]#

Bases: Tidy3dBaseModel

Data structure to store surface monitors where near fields are recorded for field projections.

Parameters:
  • monitor (FieldMonitor) – FieldMonitor on which near fields will be sampled and integrated.

  • normal_dir (Literal['+', '-']) – Direction of the surface monitor’s normal vector w.r.t. the positive x, y or z unit vectors. Must be one of ‘+’ or ‘-‘.

  • derivation (.. TODO add example and) –

  • links. (and more relevant) –

Attributes

axis

Returns the Axis normal to this surface.

Methods

is_plane(val)

Ensures that the monitor is a plane, i.e., its size attribute has exactly 1 zero

Inherited Common Usage

monitor#
normal_dir#
property axis#

Returns the Axis normal to this surface.

classmethod is_plane(val)[source]#

Ensures that the monitor is a plane, i.e., its size attribute has exactly 1 zero

__hash__()#

Hash method.