tidy3d.components.data.monitor_data.AbstractFieldProjectionData

class AbstractFieldProjectionData

Bases: MonitorData

Collection of projected fields in spherical coordinates in the frequency domain.

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 (Union[FieldProjectionAngleMonitor, FieldProjectionCartesianMonitor, FieldProjectionKSpaceMonitor, DiffractionMonitor]) – Field projection monitor.

• Er (Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]) – Spatial distribution of r-component of the electric field.

• Etheta (Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]) – Spatial distribution of the theta-component of the electric field.

• Ephi (Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]) – Spatial distribution of phi-component of the electric field.

• Hr (Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]) – Spatial distribution of r-component of the magnetic field.

• Htheta (Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]) – Spatial distribution of theta-component of the magnetic field.

• Hphi (Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]) – 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.

Attributes

coords	Coordinates of the fields contained.
coords_spherical	Coordinates grid for the fields in the spherical system.
dims	Dimensions of the radiation vectors contained.
eta	Returns the complex wave impedance associated with the background medium.
f	Frequencies.
field_components	Maps the field components to their associated data.
fields_cartesian	Get all field components in Cartesian coordinates relative to the monitor's local origin for all projection grid points and frequencies specified in the AbstractFieldProjectionMonitor.
fields_spherical	Get all field components in spherical coordinates relative to the monitor's local origin for all projection grid points and frequencies specified in the AbstractFieldProjectionMonitor.
k	Returns the complex wave number associated with the background medium.
nk	Returns the real and imaginary parts of the background medium's refractive index.
power	Get power measured on the projection grid relative to the monitor's local origin.
radar_cross_section	Radar cross section in units of incident power.
attrs

Methods

make_data_array(data)	Make an DataArray with data and same coords and dims as fields of self.
make_dataset(keys, vals)	Make an xr.Dataset with keys and data with same coords and dims as fields.
make_renormalized_data(phase, proj_distance)	Helper to apply the re-projection phase to a copied dataset.
normalize(source_spectrum_fn)	Return copy of self after normalization is applied using source spectrum function.
propagation_factor(dist, k, is_2d_simulation)	A normalization factor that includes both phase and amplitude decay associated with propagation over a distance with a given wavenumber.
wavenumber(medium, frequency)	Complex valued wavenumber associated with a frequency.

Inherited Common Usage

monitor

Er

Etheta

Ephi

Hr

Htheta

Hphi

medium

is_2d_simulation

property field_components

Maps the field components to their associated data.

property f

Frequencies.

property coords

Coordinates of the fields contained.

property coords_spherical

Coordinates grid for the fields in the spherical system.

property dims

Dimensions of the radiation vectors contained.

make_data_array(data)

Make an DataArray with data and same coords and dims as fields of self.

make_dataset(keys, vals)

Make an xr.Dataset with keys and data with same coords and dims as fields.

make_renormalized_data(phase, proj_distance)

Helper to apply the re-projection phase to a copied dataset.

normalize(source_spectrum_fn)

Return copy of self after normalization is applied using source spectrum function.

static wavenumber(medium, frequency)

Complex valued wavenumber associated with a frequency.

property nk

Returns the real and imaginary parts of the background medium’s refractive index.

property k

Returns the complex wave number associated with the background medium.

property eta

Returns the complex wave impedance associated with the background medium.

static propagation_factor(dist, k, is_2d_simulation)

A normalization factor that includes both phase and amplitude decay associated with propagation over a distance with a given wavenumber.

property fields_spherical

Get all field components in spherical coordinates relative to the monitor’s local origin for all projection grid points and frequencies specified in the AbstractFieldProjectionMonitor.

Returns:

xarray dataset containing (Er, Etheta, Ephi, Hr, Htheta, Hphi) in spherical coordinates.

Return type:

xarray.Dataset

property fields_cartesian

Get all field components in Cartesian coordinates relative to the monitor’s local origin for all projection grid points and frequencies specified in the AbstractFieldProjectionMonitor.

Returns:

xarray dataset containing (Ex, Ey, Ez, Hx, Hy, Hz) in Cartesian coordinates.

Return type:

xarray.Dataset

property power

Get power measured on the projection grid relative to the monitor’s local origin.

Returns:

Power at points relative to the local origin.

Return type:

xarray.DataArray

property radar_cross_section

Radar cross section in units of incident power.

__hash__()

Hash method.