tidy3d.PointCloudFieldData

tidy3d.PointCloudFieldData#

class PointCloudFieldData[source]#

Bases: MonitorData, PointCloudFieldDataset

Data associated with a PointCloudFieldMonitor: scalar components of E, H, and D / epsilon_0 at point-cloud coordinates, where epsilon_0 is the vacuum permittivity.

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.

  • monitor (PointCloudFieldMonitor) – Frequency-domain point-cloud field monitor.

Example

>>> from tidy3d import IndexedFreqDataArray, PointCloudFieldMonitor, PointDataArray
>>> points = PointDataArray(
...     [[0.0, 0.0, 0.0], [0.1, 0.2, 0.3]],
...     coords={"index": [0, 1], "axis": [0, 1, 2]},
... )
>>> field = IndexedFreqDataArray(
...     np.ones((2, 1)) + 0j,
...     coords={"index": [0, 1], "f": [200e12]},
... )
>>> monitor = PointCloudFieldMonitor(points=points, freqs=[200e12], fields=["Ex"], name="pc")
>>> data = PointCloudFieldData(monitor=monitor, points=points, Ex=field)

Attributes

monitor

points

Ex

Ey

Ez

Hx

Hy

Hz

Dx

Dy

Dz

Methods

normalize(source_spectrum_fn)

Return copy of self after normalization is applied using source spectrum function.
monitor#
normalize(source_spectrum_fn)[source]#

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