tidy3d.PointCloudFieldData

tidy3d.PointCloudFieldData#

class PointCloudFieldData[source]#

Bases: MonitorData, PointCloudFieldDataset

Data associated with a PointCloudFieldMonitor: scalar components of E and H fields at point-cloud coordinates.

Parameters:

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

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

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

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

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

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

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

  • 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

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.