tidy3d.components.data.monitor_data.AbstractFieldProjectionData#

class AbstractFieldProjectionData[source]#

Bases: MonitorData

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

Parameters:
  • monitor (Attribute: monitor) –

    Type

    Union[FieldProjectionAngleMonitor, FieldProjectionCartesianMonitor, FieldProjectionKSpaceMonitor, DiffractionMonitor]

    Default

    Description

    Field projection monitor.

  • Er (Attribute: Er) –

    Type

    Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]

    Default

    Description

    Spatial distribution of r-component of the electric field.

  • Etheta (Attribute: Etheta) –

    Type

    Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]

    Default

    Description

    Spatial distribution of the theta-component of the electric field.

  • Ephi (Attribute: Ephi) –

    Type

    Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]

    Default

    Description

    Spatial distribution of phi-component of the electric field.

  • Hr (Attribute: Hr) –

    Type

    Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]

    Default

    Description

    Spatial distribution of r-component of the magnetic field.

  • Htheta (Attribute: Htheta) –

    Type

    Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]

    Default

    Description

    Spatial distribution of theta-component of the magnetic field.

  • Hphi (Attribute: Hphi) –

    Type

    Union[FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray, FieldProjectionKSpaceDataArray, DiffractionDataArray]

    Default

    Description

    Spatial distribution of phi-component of the magnetic field.

  • medium (Attribute: medium) –

    Type

    Union[Medium, AnisotropicMedium, PECMedium, PoleResidue, Sellmeier, Lorentz, Debye, Drude, FullyAnisotropicMedium, CustomMedium, CustomPoleResidue, CustomSellmeier, CustomLorentz, CustomDebye, CustomDrude, CustomAnisotropicMedium, PerturbationMedium, PerturbationPoleResidue, Medium2D]

    Default

    = Medium(nameNone, frequency_rangeNone, allow_gainFalse, nonlinear_specNone, modulation_specNone, heat_specNone, type’Medium’, permittivity1.0, conductivity0.0)

    Description

    Background medium through which to project fields.

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.

Methods

make_data_array(data)

Make an xr.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_phase(dist, k)

Phase associated with propagation of a distance with a given wavenumber.

wavenumber(medium, frequency)

Complex valued wavenumber associated with a frequency.

monitor#
Er#
Etheta#
Ephi#
Hr#
Htheta#
Hphi#
medium#
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)[source]#

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

make_dataset(keys, vals)[source]#

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

make_renormalized_data(phase, proj_distance)[source]#

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

normalize(source_spectrum_fn)[source]#

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

static wavenumber(medium, frequency)[source]#

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_phase(dist, k)[source]#

Phase associated with propagation of 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.