added classes DirectivityData and DirectivityDataArray

tidy3d/__init__.py

@@ -72,7 +72,7 @@
 from .components.data.data_array import ScalarFieldTimeDataArray, SpatialDataArray
 from .components.data.data_array import ModeAmpsDataArray, ModeIndexDataArray
 from .components.data.data_array import FluxDataArray, FluxTimeDataArray
-from .components.data.data_array import FieldProjectionAngleDataArray
+from .components.data.data_array import FieldProjectionAngleDataArray, DirectivityDataArray
 from .components.data.data_array import FieldProjectionCartesianDataArray
 from .components.data.data_array import FieldProjectionKSpaceDataArray
 from .components.data.data_array import DiffractionDataArray
@@ -83,7 +83,11 @@
 from .components.data.monitor_data import FluxData, FluxTimeData
 from .components.data.monitor_data import ModeData, ModeSolverData
 from .components.data.monitor_data import AbstractFieldProjectionData
-from .components.data.monitor_data import FieldProjectionAngleData, FieldProjectionCartesianData
+from .components.data.monitor_data import (
+    FieldProjectionAngleData,
+    DirectivityData,
+    FieldProjectionCartesianData,
+)
 from .components.data.monitor_data import FieldProjectionKSpaceData
 from .components.data.monitor_data import DiffractionData
 from .components.data.sim_data import SimulationData
@@ -261,6 +265,7 @@ def set_logging_level(level: str) -> None:
     "FluxDataArray",
     "FluxTimeDataArray",
     "FieldProjectionAngleDataArray",
+    "DirectivityDataArray",
     "FieldProjectionCartesianDataArray",
     "FieldProjectionKSpaceDataArray",
     "DiffractionDataArray",
@@ -279,6 +284,7 @@ def set_logging_level(level: str) -> None:
     "ModeSolverData",
     "AbstractFieldProjectionData",
     "FieldProjectionAngleData",
+    "DirectivityData",
     "FieldProjectionCartesianData",
     "FieldProjectionKSpaceData",
     "DiffractionData",

tidy3d/components/data/data_array.py

@@ -693,6 +693,24 @@ class FieldProjectionAngleDataArray(DataArray):
     _data_attrs = {"long_name": "radiation vectors"}
 
 
+class DirectivityDataArray(DataArray):
+    """Far fields in frequency domain as a function of angles theta and phi.
+    Example
+    -------
+    >>> f = np.linspace(1e14, 2e14, 10)
+    >>> r = np.atleast_1d(5)
+    >>> theta = np.linspace(0, np.pi, 10)
+    >>> phi = np.linspace(0, 2*np.pi, 20)
+    >>> coords = dict(r=r, theta=theta, phi=phi, f=f)
+    >>> values = (1+1j) * np.random.random((len(r), len(theta), len(phi), len(f)))
+    >>> data = DirectivityDataArray(values, coords=coords)
+    """
+
+    __slots__ = ()
+    _dims = ("r", "theta", "phi", "f")
+    _data_attrs = {"long_name": "radiation intensity"}
+
+
 class FieldProjectionCartesianDataArray(DataArray):
     """Far fields in frequency domain as a function of local x and y coordinates.
 
@@ -980,6 +998,7 @@ class IndexedDataArray(DataArray):
     GroupIndexDataArray,
     ModeDispersionDataArray,
     FieldProjectionAngleDataArray,
+    DirectivityDataArray,
     FieldProjectionCartesianDataArray,
     FieldProjectionKSpaceDataArray,
     DiffractionDataArray,

tidy3d/components/data/monitor_data.py

@@ -13,7 +13,11 @@
 from .data_array import FluxTimeDataArray, FluxDataArray
 from .data_array import MixedModeDataArray, ModeAmpsDataArray
 from .data_array import GroupIndexDataArray, ModeDispersionDataArray
-from .data_array import FieldProjectionAngleDataArray, FieldProjectionCartesianDataArray
+from .data_array import (
+    FieldProjectionAngleDataArray,
+    DirectivityDataArray,
+    FieldProjectionCartesianDataArray,
+)
 from .data_array import FieldProjectionKSpaceDataArray
 from .data_array import DataArray, DiffractionDataArray
 from .data_array import ScalarFieldDataArray, ScalarFieldTimeDataArray
@@ -29,7 +33,11 @@
 from ..source import GaussianPulse, ModeSource, Source, PlaneWave
 from ..monitor import MonitorType, FieldMonitor, FieldTimeMonitor, ModeSolverMonitor
 from ..monitor import ModeMonitor, FluxMonitor, FluxTimeMonitor, PermittivityMonitor
-from ..monitor import FieldProjectionAngleMonitor, FieldProjectionCartesianMonitor
+from ..monitor import (
+    FieldProjectionAngleMonitor,
+    DirectivityMonitor,
+    FieldProjectionCartesianMonitor,
+)
 from ..monitor import FieldProjectionKSpaceMonitor, FieldProjectionSurface
 from ..monitor import DiffractionMonitor
 from ..source import SourceTimeType, CustomFieldSource
@@ -2203,6 +2211,32 @@ def renormalize_fields(self, proj_distance: float) -> FieldProjectionAngleData:
         return self.make_renormalized_data(phase, proj_distance)
 
 
+class DirectivityData(MonitorData):
+    """Data associated with a :class:`.DirectivityMonitor`.
+    Example
+    -------
+    >>> from tidy3d import DirectivityDataArray
+    >>> f = np.linspace(1e14, 2e14, 10)
+    >>> r = np.atleast_1d(5)
+    >>> theta = np.linspace(0, np.pi, 10)
+    >>> phi = np.linspace(0, 2*np.pi, 20)
+    >>> coords = dict(r=r, theta=theta, phi=phi, f=f)
+    >>> scalar_field = DirectivityDataArray(farfield_values, coords=coords)
+    >>> monitor = DirectivityMonitor(center=(1,2,3), size=(2,2,2), freqs=f, name='n2f_monitor', phi=phi, theta=theta)
+    >>> data = DirectivityData(monitor=monitor,Directivity=scalar_field)
+    """
+
+    monitor: DirectivityMonitor = pd.Field(
+        ...,
+        title="DirectivityMonitor",
+        description="DirectivityMonitor with an angle-based projection grid.",
+    )
+
+    directivity: DirectivityDataArray = pd.Field(
+        ..., title="Directivity", description="Directivity with an angle-based projection grid."
+    )
+
+
 class FieldProjectionCartesianData(AbstractFieldProjectionData):
     """Data associated with a :class:`.FieldProjectionCartesianMonitor`: components of
     projected fields.
@@ -2790,6 +2824,7 @@ def adjoint_source_amp(self, amp: DataArray) -> PlaneWave:
     FluxData,
     FluxTimeData,
     FieldProjectionKSpaceData,
+    DirectivityData,
     FieldProjectionCartesianData,
     FieldProjectionAngleData,
     DiffractionData,