tidy3d.FieldProjectionSurface

class FieldProjectionSurface

Bases: Tidy3dBaseModel

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

Parameters:

• 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().

• 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)

See also

Notebooks:

• Performing near field to far field projections

Attributes

axis	Returns the Axis normal to this surface.
attrs

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)

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

__hash__()

Hash method.