tidy3d.PointCloudFieldDataset

tidy3d.PointCloudFieldDataset#

class PointCloudFieldDataset[source]#

Bases: AbstractFieldDataset

Dataset storing electromagnetic field components at point-cloud coordinates.

Parameters:

  • points (PointDataArray) – Point coordinates associated with the indexed field data.

  • Ex (Optional[IndexedFreqDataArray] = None) – [units = V/um]. Point-cloud x-component of the electric field.

  • Ey (Optional[IndexedFreqDataArray] = None) – [units = V/um]. Point-cloud y-component of the electric field.

  • Ez (Optional[IndexedFreqDataArray] = None) – [units = V/um]. Point-cloud z-component of the electric field.

  • Hx (Optional[IndexedFreqDataArray] = None) – [units = A/um]. Point-cloud x-component of the magnetic field.

  • Hy (Optional[IndexedFreqDataArray] = None) – [units = A/um]. Point-cloud y-component of the magnetic field.

  • Hz (Optional[IndexedFreqDataArray] = None) – [units = A/um]. Point-cloud z-component of the magnetic field.

  • Dx (Optional[IndexedFreqDataArray] = None) – [units = V/um]. Point-cloud x-component of D / epsilon_0, computed from Ex and the local x-direction relative permittivity.

  • Dy (Optional[IndexedFreqDataArray] = None) – [units = V/um]. Point-cloud y-component of D / epsilon_0, computed from Ey and the local y-direction relative permittivity.

  • Dz (Optional[IndexedFreqDataArray] = None) – [units = V/um]. Point-cloud z-component of D / epsilon_0, computed from Ez and the local z-direction relative permittivity.

  • ``("index" (Field components are scalar data arrays indexed by) –

  • array ("f")``. The points)

  • coordinate. (maps each index to its Cartesian)

Attributes

field_components

Maps the field components to their associated data.

grid_locations

Point-cloud data is not sampled on named Yee-grid locations.

symmetry_eigenvalues

Maps field components to their (positive) symmetry eigenvalues.

points

Ex

Ey

Ez

Hx

Hy

Hz

Dx

Dy

Dz

Methods

colocate([x, y, z])

Point-cloud field data is already sampled at requested points and cannot be colocated.
points#
Ex#
Ey#
Ez#
Hx#
Hy#
Hz#
Dx#
Dy#
Dz#
property field_components#

Maps the field components to their associated data.

property grid_locations#

Point-cloud data is not sampled on named Yee-grid locations.

property symmetry_eigenvalues#

Maps field components to their (positive) symmetry eigenvalues.

colocate(x=None, y=None, z=None)[source]#

Point-cloud field data is already sampled at requested points and cannot be colocated.