eas-3d-pattern 0.1.2__tar.gz → 0.1.3__tar.gz

{eas_3d_pattern-0.1.2 → eas_3d_pattern-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: eas-3d-pattern
-Version: 0.1.2
+Version: 0.1.3
 Summary: A tool to visualize 3D antenna pattern files in JSON format.
 License: MIT License
          
@@ -23,9 +23,10 @@ License: MIT License
          LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
          OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
          SOFTWARE.
+License-File: LICENSE
 Keywords: antenna,pattern,3d pattern,visualization,NGMN,BASTA,RF,JSON
 Author: Georg Polownikow
-Author-email: georg.polownikow@ericsson.com
+Author-email: georg.polownikow@gmail.com
 Requires-Python: >=3.11,<3.14
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Telecommunications Industry
@@ -39,6 +40,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Requires-Dist: jsonschema (>=4.24.0,<5.0.0)
 Requires-Dist: kaleido (>=0.1.0,<0.2.0)
+Requires-Dist: nbformat (>=4.2.0,<6.0.0)
 Requires-Dist: numpy (>=2.0.0,<3.0.0)
 Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
 Requires-Dist: pandas (>=2.2.2,<3.0.0)

{eas_3d_pattern-0.1.2 → eas_3d_pattern-0.1.3}/pyproject.toml

@@ -3,7 +3,7 @@ name = "eas-3d-pattern"
 dynamic = []
 description = "A tool to visualize 3D antenna pattern files in JSON format."
 authors = [
-    {name = "Georg Polownikow",email = "georg.polownikow@ericsson.com"}
+    {name = "Georg Polownikow",email = "georg.polownikow@gmail.com"}
 ]
 license = {file = "LICENSE"}
 readme = "README.md"
@@ -20,6 +20,7 @@ dependencies = [
     "kaleido (>=0.1.0, <0.2.0)",
     "requests (>=2.32.2,<3.0.0)",
     "tqdm (>=4.67.1,<5.0.0)",
+    "nbformat (>=4.2.0,<6.0.0)",
 ]
 
 classifiers = [
@@ -34,7 +35,7 @@ classifiers = [
     "Operating System :: OS Independent",
     "Topic :: Scientific/Engineering :: Visualization",
 ]
-version = "0.1.2"
+version = "0.1.3"
 
 [project.urls]
 homepage = "https://www.ericsson.com/antenna-system"

{eas_3d_pattern-0.1.2 → eas_3d_pattern-0.1.3}/src/eas_3d_pattern/__init__.py

@@ -1,4 +1,5 @@
 import logging
+from importlib.metadata import PackageNotFoundError, version
 
 from .parser import AntennaPattern
 from .sample_data import SAMPLE_JSON
@@ -10,6 +11,10 @@ LIBRARY_PACKAGE_NAME = __name__
 library_root_logger = logging.getLogger(LIBRARY_PACKAGE_NAME)
 if not library_root_logger.hasHandlers():
     library_root_logger.addHandler(logging.NullHandler())
+try:
+    __version__ = version(LIBRARY_PACKAGE_NAME)
+except PackageNotFoundError:
+    __version__ = "0+unknown"
 
 __all__ = [
     "SAMPLE_JSON",
@@ -18,5 +23,3 @@ __all__ = [
     "SectorDefinition",
     "generate_report_eas",
 ]
-
-__version__ = "0.1.1"

{eas_3d_pattern-0.1.2 → eas_3d_pattern-0.1.3}/src/eas_3d_pattern/parser.py

@@ -505,6 +505,81 @@ class AntennaPattern:
         metadata.pop("Data_Set_Row_Structure", None)
         return metadata
 
+    def calculate_directivity(self) -> float:
+        """Calculate the directivity of the antenna pattern data.
+
+        Directivity is calculated with the average radiation intensity over the whole sphere and the maximum radiation intensity.
+        Can only be calculated if data is complete (full sphere). Regular grids are advised.
+        Fancy geometry calculation with something like Delaunay+Voronoi is not supported for now.
+
+        Args:
+            None
+
+        Raises:
+            None
+
+        Returns:
+            float: The directivity value in dBi.
+
+        Example:
+            >>> directivity_dbi = antenna_pattern.calculate_directivity()
+            >>> losses = gain_dbi - directivity_dbi
+        """
+        logger.debug("AntennaPattern: Calculating directivity of antenna pattern data.")
+        if "dOmega" not in list(self.Pattern_3D.data_vars.keys()):
+            weight = np.repeat(
+                np.sin(np.deg2rad(self.Pattern_3D.Theta.values)).T[:, None],
+                len(self.Pattern_3D.Phi),
+                axis=1,
+            )
+            dTheta = np.abs(np.gradient(np.deg2rad(self.Pattern_3D["Theta"]))).reshape(
+                -1, 1
+            )
+            dPhi = np.abs(np.gradient(np.deg2rad(self.Pattern_3D["Phi"]))).reshape(
+                1, -1
+            )
+            factor = dTheta * dPhi
+            dOmega = weight * factor
+            self.Pattern_3D["dOmega"] = xr.DataArray(
+                dOmega,
+                dims=("Theta", "Phi"),
+                coords={"Theta": self.Pattern_3D.Theta, "Phi": self.Pattern_3D.Phi},
+                name="dOmega",
+            )
+        Umax = float(self.Pattern_3D["P_tp_lin"].max())
+        Uavg = float(
+            (self.Pattern_3D["P_tp_lin"] * self.Pattern_3D["dOmega"]).sum(
+                ("Theta", "Phi")
+            )
+            / (self.Pattern_3D["dOmega"].sum())
+        )
+        directivity_dbi = float(10 * np.log10(Umax / Uavg))
+        return directivity_dbi
+
+    def calculate_losses(self) -> float:
+        """Calculate the losses of the antenna pattern data.
+
+        Antenna losses are calculated by the gain value within the header and the calculated directivity.
+
+        Args:
+            None
+
+        Raises:
+            None
+
+        Returns:
+            float: The loss value in dB (gain - directivity).
+
+        Example:
+            >>> losses = antenna_pattern.calculate_losses()
+        """
+        logger.debug("AntennaPattern: Calculating losses of antenna pattern data.")
+        if self.gain_dbi is None:
+            raise ValueError(
+                "AntennaPattern: Loss can only be calculated if 'Gain' is available in the header"
+            )
+        return float(self.gain_dbi - self.calculate_directivity())
+
     def calculate_beam_efficiency(
         self, sector_definitions: SectorDefinition | None = None, powersum: bool = True
     ) -> dict[str, float]:
@@ -709,9 +784,9 @@ class AntennaPattern:
     def plot(
         self, component_name: str = "P_tp_dB", show_fig: bool = True
     ) -> None | go.Figure:
-        """Plots the radation pattern as heatmap.
+        """Plots the radiation pattern as heatmap.
 
-        Plots with ploty the radation pattern as heatmap.
+        Plots with plotly the radiation pattern as heatmap.
         Normalized radation pattern are shown in dB.
 
         Args:
@@ -783,6 +858,138 @@ class AntennaPattern:
             return None
         return fig
 
+    def plot_3D(
+        self,
+        component_name: str = "P_tp_dB",
+        db_floor: float = -30.0,
+        show_axes_arrows: bool = True,
+        show_fig: bool = True,
+    ) -> None | go.Figure:
+        """Plots the radiation pattern as 3D polar plot.
+
+        Plots with plotly the radiation pattern as 3D polar plot.
+        dB_floor is set to -30 as average baseline.
+
+        Args:
+            component_name (str, optional): Name of the component to be plotted. Defaults to 'P_tp_dB', thus power pattern.
+            db_floor (float, optional): Sets a minimum floor to have smoother plots. Defaults to -30.
+            show_axes_arrows (bool, optional): Shows coordinate axes arrows in the plot. Defaults to True.
+            show_fig (bool, optional): Whether to show the figure. Defaults to True.
+
+        Returns:
+            None | go.Figure: None if show_fig is False else go.Figure
+
+        """
+        if component_name not in self.Pattern_3D.data_vars:
+            logger.error(
+                f"AntennaPattern: Component '{component_name}' not found. Make sure to select a component with data."
+            )
+            raise ValueError(
+                f"AntennaPattern: Component '{component_name}' not found. Make sure to select a component with data."
+            )
+
+        theta_rad = np.radians(self.Pattern_3D.coords["Theta"].values)
+        phi_rad = np.radians(self.Pattern_3D.coords["Phi"].values)
+        theta_grid, phi_grid = np.meshgrid(theta_rad, phi_rad, indexing="ij")
+        r = self.Pattern_3D[component_name].values
+        r_clipped = np.clip(r, db_floor, r.max())
+        r_clipped -= r_clipped.min()
+        X = r_clipped * np.sin(theta_grid) * np.cos(phi_grid)
+        Y = r_clipped * np.sin(theta_grid) * np.sin(phi_grid)
+        Z = r_clipped * np.cos(theta_grid)
+
+        fig = go.Figure()
+        fig.add_trace(
+            go.Surface(
+                x=X,
+                y=Y,
+                z=Z,
+                surfacecolor=r,
+                colorscale="turbo",
+                cmin=db_floor,
+                cmax=0,
+                colorbar={"title": component_name, "thickness": 9},
+            )
+        )
+        fig.update_layout(
+            title={
+                "text": os.path.basename(self.data_filepath),
+                "x": 0.5,
+                "y": 0.93,
+                "yanchor": "bottom",
+                "font": {"size": 16},
+            },
+            height=650,
+            margin={"t": 50, "l": 0, "r": 0, "b": 0},
+            scene={
+                "aspectmode": "data",
+                "xaxis_title": "x",
+                "yaxis_title": "y",
+                "zaxis_title": "z",
+            },
+        )
+        if show_axes_arrows:
+            L = r_clipped.max() + 6
+            fig.add_trace(
+                go.Scatter3d(
+                    x=[0, L],
+                    y=[0, 0],
+                    z=[0, 0],
+                    mode="lines",
+                    line={"color": "black", "width": 6},
+                    showlegend=False,
+                    hoverinfo="skip",
+                    hovertemplate=None,
+                )
+            )
+            fig.add_trace(
+                go.Scatter3d(
+                    x=[0, 0],
+                    y=[0, L / 2],
+                    z=[0, 0],
+                    mode="lines",
+                    line={"color": "black", "width": 6},
+                    showlegend=False,
+                    hoverinfo="skip",
+                    hovertemplate=None,
+                )
+            )
+            fig.add_trace(
+                go.Scatter3d(
+                    x=[0, 0],
+                    y=[0, 0],
+                    z=[0, L / 2],
+                    mode="lines",
+                    line={"color": "black", "width": 6},
+                    showlegend=False,
+                    hoverinfo="skip",
+                    hovertemplate=None,
+                )
+            )
+            fig.add_trace(
+                go.Cone(
+                    x=[L, 0, 0],
+                    y=[0, L / 2, 0],
+                    z=[0, 0, L / 2],
+                    u=[4, 0, 0],
+                    v=[0, 4, 0],
+                    w=[0, 0, 4],
+                    anchor="tail",
+                    showscale=False,
+                    autocolorscale=False,
+                    sizemode="absolute",
+                    sizeref=0.3,
+                    colorscale=[[0, "black"], [1, "black"]],
+                    showlegend=False,
+                    hoverinfo="skip",
+                    hovertemplate=None,
+                )
+            )
+        if show_fig:
+            fig.show()
+            return None
+        return fig
+
     def __str__(self) -> str:
         buf = io.StringIO()
         self.raw_pattern_dataframe.info(buf=buf)

{eas_3d_pattern-0.1.2 → eas_3d_pattern-0.1.3}/src/eas_3d_pattern/util_func/report.py

@@ -71,7 +71,7 @@ def generate_report_eas(
         ... )  # with own subband
     """
     input_directory = Path(input_directory)
-    files = list(input_directory.glob("*.json"))
+    files = list(input_directory.glob("*.[jJ][sS][oO][nN]"))
     if len(files) == 0:
         raise ValueError("Report: No .json files found in the directory.")
     output_directory = Path(output_directory)
@@ -115,6 +115,42 @@ def _process_a_file(
         data = pattern.get_metadata_dict()
         top_border = pattern.calculate_top_3db_point(power=False)
         eas_sectors = SectorDefinition(load_default=True, top_border=top_border)
+        if (data["Phi_HPBW"] <= 50) & (pattern.Pattern_3D.peak_coordinates[1] < -20):
+            logging.info(
+                "Reporting: Identified dual beam antenna. Overwriting sectors to dual beam definition for reporting."
+            )
+            eas_sectors.add_sector(
+                name="Cell",
+                theta_min=(top_border, "<="),
+                theta_max=(165, "<="),
+                phi_min=(-60.0, "<="),
+                phi_max=(0, "<="),
+            )
+            eas_sectors.add_sector(
+                name="Int2",
+                theta_min=(top_border, "<="),
+                theta_max=(165, "<="),
+                phi_min=(0.0, "<"),
+                phi_max=(180.0, "<="),
+            )
+        if (data["Phi_HPBW"] <= 50) & (pattern.Pattern_3D.peak_coordinates[1] > 20):
+            logging.info(
+                "Reporting: Identified dual beam antenna. Changing sectors to dual beam definition for reporting."
+            )
+            eas_sectors.add_sector(
+                name="Cell",
+                theta_min=(top_border, "<="),
+                theta_max=(165, "<="),
+                phi_min=(0.0, "<="),
+                phi_max=(60.0, "<="),
+            )
+            eas_sectors.add_sector(
+                name="Int1",
+                theta_min=(top_border, "<="),
+                theta_max=(165, "<="),
+                phi_min=(-180.0, "<="),
+                phi_max=(0.0, "<"),
+            )
         eff = pattern.calculate_beam_efficiency(sector_definitions=eas_sectors)
         data.update({f"{k}": v * 100 for k, v in eff.items()})
         data.update(