tidy3d.FieldProjectionKSpaceData#

class FieldProjectionKSpaceData[source]#

Bases: AbstractFieldProjectionData

Data associated with a FieldProjectionKSpaceMonitor: components of projected fields.

Parameters:

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.

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.

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)[source]#

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.