tidy3d.FieldProjectionKSpaceData

class FieldProjectionKSpaceData

Bases: AbstractFieldProjectionData

Data associated with a FieldProjectionKSpaceMonitor: components of projected fields.

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 (FieldProjectionKSpaceMonitor) – Field projection monitor with a projection grid defined in k-space.

• Er (FieldProjectionKSpaceDataArray) – Spatial distribution of r-component of the electric field.

• Etheta (FieldProjectionKSpaceDataArray) – Spatial distribution of the theta-component of the electric field.

• Ephi (FieldProjectionKSpaceDataArray) – Spatial distribution of phi-component of the electric field.

• Hr (FieldProjectionKSpaceDataArray) – Spatial distribution of r-component of the magnetic field.

• Htheta (FieldProjectionKSpaceDataArray) – Spatial distribution of theta-component of the magnetic field.

• Hphi (FieldProjectionKSpaceDataArray) – Spatial distribution of phi-component of the magnetic field.

• medium (Union[Medium, AnisotropicMedium, PECMedium, PoleResidue, Sellmeier, Lorentz, Debye, Drude, FullyAnisotropicMedium, CustomMedium, CustomPoleResidue, CustomSellmeier, CustomLorentz, CustomDebye, CustomDrude, CustomAnisotropicMedium, PerturbationMedium, PerturbationPoleResidue, Medium2D, AnisotropicMediumFromMedium2D] = Medium(attrs={}, name=None, frequency_range=None, allow_gain=False, nonlinear_spec=None, modulation_spec=None, heat_spec=None, type='Medium', permittivity=1.0, conductivity=0.0)) – Background medium through which to project fields.

• is_2d_simulation (bool = False) – Indicates whether the monitor data is for a 2D simulation.

• projection_surfaces (Tuple[FieldProjectionSurface, ...]) – Surfaces of the monitor where near fields were recorded for projection

Example

>>> from tidy3d import FieldProjectionKSpaceDataArray
>>> f = np.linspace(1e14, 2e14, 10)
>>> ux = np.linspace(0, 0.4, 10)
>>> uy = np.linspace(0, 0.6, 20)
>>> r = np.atleast_1d(5)
>>> coords = dict(ux=ux, uy=uy, r=r, f=f)
>>> values = (1+1j) * np.random.random((len(ux), len(uy), len(r), len(f)))
>>> scalar_field = FieldProjectionKSpaceDataArray(values, coords=coords)
>>> monitor = FieldProjectionKSpaceMonitor(
...     center=(1,2,3), size=(2,2,2), freqs=f, name='n2f_monitor', ux=ux, uy=uy, proj_axis=2
...     )
>>> data = FieldProjectionKSpaceData(
...     monitor=monitor, Er=scalar_field, Etheta=scalar_field, Ephi=scalar_field,
...     Hr=scalar_field, Htheta=scalar_field, Hphi=scalar_field,
...     projection_surfaces=monitor.projection_surfaces,
...     )

Attributes

r	Radial distance.
ux	Reciprocal X positions.
uy	Reciprocal Y positions.
attrs

Methods

renormalize_fields(proj_distance)

Return a FieldProjectionKSpaceData with fields re-normalized to a new projection distance, by applying a phase factor based on proj_distance.

Inherited Common Usage

monitor

projection_surfaces

Er

Etheta

Ephi

Hr

Htheta

Hphi

property ux

Reciprocal X positions.

property uy

Reciprocal Y positions.

property r

Radial distance.

renormalize_fields(proj_distance)

Return a FieldProjectionKSpaceData with fields re-normalized to a new projection distance, by applying a phase factor based on proj_distance.

Parameters:

proj_distance (float = None) – (micron) new radial distance relative to the monitor’s local origin.

Returns:

Copy of this FieldProjectionKSpaceData with fields re-projected to proj_distance.

Return type:

FieldProjectionKSpaceData

__hash__()

Hash method.