xnft-lemma-scanner 1.0.1__tar.gz

xnft_lemma_scanner-1.0.1/.gitignore

@@ -0,0 +1,235 @@
+*~lock~
+*/figures/*
+
+# pixi environments
+.pixi/*
+!.pixi/config.toml
+
+# Sphinx
+docs/build
+
+# macOS
+.DS_Store
+
+# == Python ===
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+# *.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+report.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+# Generated api docs
+docs/source/api/
+docs/*.pdf
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+code-quality-report.json
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

xnft_lemma_scanner-1.0.1/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2026 LEmmA, Electromagnetics Research Group, Michigan State University.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 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.

xnft_lemma_scanner-1.0.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.5
+Name: xnft-lemma-scanner
+Version: 1.0.1
+Summary: Antenna measurement and analysis software.
+Author: LEmmA Group, Michigan State University
+Author-email: Jason Merlo <merlojas@msu.edu>, Mauro Ettorre <ettorre@msu.edu>
+Maintainer-email: Jason Merlo <merlojas@msu.edu>
+License-Expression: LicenseRef-Proprietary
+License-File: LICENSE
+Requires-Python: <3.15,>=3.12
+Description-Content-Type: text/markdown
+
+# LEmmA Scanner _xNFT_ Extension
+
+Repository for the LEmmA planar near-field scanner _xNFT_ field loader extension.

xnft_lemma_scanner-1.0.1/README.md

@@ -0,0 +1,3 @@
+# LEmmA Scanner _xNFT_ Extension
+
+Repository for the LEmmA planar near-field scanner _xNFT_ field loader extension.

xnft_lemma_scanner-1.0.1/pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "xnft-lemma-scanner"
+dynamic = ["version"]
+authors = [
+  { name = "LEmmA Group, Michigan State University" },
+  { name = "Jason Merlo", email = "merlojas@msu.edu" },
+  { name = "Mauro Ettorre", email = "ettorre@msu.edu" },
+]
+maintainers = [{ name = "Jason Merlo", email = "merlojas@msu.edu" }]
+readme = "README.md"
+description = "Antenna measurement and analysis software."
+license = "LicenseRef-Proprietary"
+
+requires-python = ">=3.12,<3.15"
+
+# [project.scripts]
+# xnft = "xnft.gui.app:main"
+
+[project.urls]
+
+
+[build-system]
+requires = ["hatchling>=1.32.4,<2", "hatch-vcs>=0.5.0,<0.6"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+tag-pattern = "^(?:pypi-)?v(?P<version>.*)$"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/xnft_lemma_scanner"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/src/xnft_lemma_scanner",
+  "/pyproject.toml",
+  "/README.md",
+  "/LICENSE",
+]
+exclude = ["/tests", "/data", "/docs", "/.pixi", "/.pixi-cache"]
+
+# === PyTest Configuration ===
+
+[tool.pytest.ini_options]
+addopts = "--cov='xnft' --cov-report term --cov-report xml:coverage.xml --junitxml report.xml -n auto"
+
+[tool.coverage.run]
+source = ["src"]
+omit = ["**/.pixi/**", "**/tests/**"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "pragma: no cover",
+  "if TYPE_CHECKING:",
+  "if __name__ == .__main__.:",
+]
+
+[tool.ruff]
+# Exclude CI pixi cache folder.
+extend-exclude = [".pixi-cache"]
+
+
+# === xNFT Plugin Configuration ===
+[project.entry-points."xnft.plugins"]
+example = "xnft_lemma_scanner.plugin"

xnft_lemma_scanner-1.0.1/src/xnft_lemma_scanner/loaders/fields/lemma.py

@@ -0,0 +1,243 @@
+"""
+File for LEmmA near field scanner file format.
+
+Copyright 2025-2026 LEmmA, Electromagnetics Research Group, Michigan State University.
+"""
+
+import logging
+
+import h5py
+import numpy as np
+import xarray as xr
+from xnft.common.enums import (
+    CoordinateSystemType,
+    DataPolarizationType,
+    FieldType,
+    ScanType,
+    SParameterType,
+)
+from xnft.common.registry import registry
+from xnft.common.types import FieldDataset, FileInfo, PolarizationType
+
+logger = logging.getLogger(__name__)
+
+
+# Constant for scanner distnaces
+POINTS_PER_METER = 200_000
+
+# Register DataSource
+LEMMA_SOURCE_V1 = registry.data_sources.register(
+    id="xnft-lemma-scanner.lemma_v1",
+    display_name="LEmmA Scanner V1",
+)
+LEMMA_SOURCE_V2 = registry.data_sources.register(
+    id="xnft-lemma-scanner.lemma_v2",
+    display_name="LEmmA Scanner V2",
+)
+
+
+@registry.loaders.fields.register(
+    source=LEMMA_SOURCE_V1,
+    field_type=FieldType.NEAR,
+    scan_type=ScanType.PLANAR,
+    data_polarization=DataPolarizationType.SINGLE_POL,
+    extension=".h5",
+    has_sp=True,
+)
+def load_lemma_v1_h5(file_list: list[FileInfo]) -> xr.Dataset:
+
+    co_file_info = cx_file_info = None
+    for file_info in file_list:
+        if file_info.polarization == PolarizationType.CO_POL:
+            co_file_info = file_info
+        elif file_info.polarization == PolarizationType.CROSS_POL:
+            cx_file_info = file_info
+        else:
+            raise TypeError(
+                "LEmmA loader only accepts polarization types CO_POL and CROSS_POL, not both "
+                "or none",
+            )
+
+    if co_file_info is None and cx_file_info is None:
+        raise RuntimeError("At least `co_pol` or `cross_pol` must be specified.")
+
+    # Open file
+    for file_info in file_list:
+        with h5py.File(file_info.path, "r") as dataset:
+            sample_frequencies = dataset["f"][()][0]
+            sample_locations = dataset["points"][()] / POINTS_PER_METER
+            x_locs = sample_locations[:, 2]
+            # NOTE: Swap y and z axes
+            y_locs = sample_locations[:, 0]
+
+            # TODO/FIXME: Hardcoded z-distance!!
+            z_locs = sample_locations[:, 1] + 0.069
+
+            # NOTE: We're only taking the first item in the set
+            if file_info.s_parameters != set():
+                sp = next(iter(file_info.s_parameters))
+            else:
+                sp = SParameterType.S21
+
+            field_amplitude = dataset[f"{sp}real"][()] + 1.0j * dataset[f"{sp}imag"][()]
+
+            if file_info.polarization == PolarizationType.CO_POL:
+                ey_array = field_amplitude
+                if cx_file_info is None:
+                    ex_array = np.zeros_like(ey_array)
+            if file_info.polarization == PolarizationType.CROSS_POL:
+                ex_array = field_amplitude
+                if co_file_info is None:
+                    ey_array = np.zeros_like(ex_array)
+
+    x_list = x_locs.tolist()
+    y_list = y_locs.tolist()
+    z_list = z_locs.tolist()
+
+    frequency_list = sample_frequencies.tolist()
+
+    ez_array = np.zeros_like(ex_array)
+
+    x_sample_location_array = np.sort(np.array(list(set(x_list))))
+    y_sample_location_array = np.sort(np.array(list(set(y_list))))
+    z_sample_location_array = np.sort(np.array(list(set(z_list))))
+
+    sample_frequency_array = np.sort(np.array(list(set(frequency_list))))
+
+    logger.debug(
+        "Sample location array shape: (x:%d, y:%d, z:%d, freq:%d)",
+        x_sample_location_array.size,
+        y_sample_location_array.size,
+        z_sample_location_array.size,
+        sample_frequency_array.size,
+    )
+
+    # Allocate new data array in multidimensional format
+    fields_shape = (
+        3,  # 3 for x,y,z component of the field
+        x_sample_location_array.size,
+        y_sample_location_array.size,
+        z_sample_location_array.size,
+        sample_frequency_array.size,
+    )
+    e_field = np.empty(fields_shape, dtype=np.complex128)
+
+    # Find to insert field values in e_field array
+    x_idx = np.searchsorted(x_sample_location_array, x_locs)
+    y_idx = np.searchsorted(y_sample_location_array, y_locs)
+    z_idx = np.searchsorted(z_sample_location_array, z_locs)
+
+    for f_idx in range(sample_frequencies.size):
+        e_field[0, x_idx, y_idx, z_idx, f_idx] = ex_array[:, f_idx]
+        e_field[1, x_idx, y_idx, z_idx, f_idx] = ey_array[:, f_idx]
+        e_field[2, x_idx, y_idx, z_idx, f_idx] = ez_array[:, f_idx]
+
+    fields = FieldDataset.create(
+        e_field=e_field,
+        h_field=None,
+        spatial_coords={
+            "x": x_sample_location_array,
+            "y": y_sample_location_array,
+            "z": z_sample_location_array,
+        },
+        frequency=sample_frequency_array,
+        coordinate_system=CoordinateSystemType.CARTESIAN,
+        field_type=FieldType.NEAR,
+        data_source=LEMMA_SOURCE_V1,
+    )
+
+    return fields
+
+
+@registry.loaders.fields.register(
+    source=LEMMA_SOURCE_V2,
+    field_type=FieldType.NEAR,
+    scan_type=ScanType.PLANAR,
+    data_polarization=DataPolarizationType.SINGLE_POL,
+    extension=".h5",
+    has_sp=True,
+)
+def load_lemma_v2_h5(file_list: list[FileInfo]) -> xr.Dataset:
+
+    # Open file
+    for file_info in file_list:
+        with h5py.File(file_info.path, "r") as dataset:
+            sample_frequencies = dataset["f"][()][0]
+            sample_locations = dataset["points"][()] / POINTS_PER_METER
+            x_locs = sample_locations[:, 0]
+            y_locs = sample_locations[:, 1]
+            # TODO/FIXME: temporary hardcoded z-distance; need scanner to report correct value
+            z_locs = sample_locations[:, 2] + 0.07
+
+            # NOTE: We're only taking the first item in the set
+            if file_info.s_parameters != set():
+                sp = next(iter(file_info.s_parameters))
+            else:
+                sp = SParameterType.S21
+
+            field_amplitude = dataset[f"{sp}real"][()] + 1.0j * dataset[f"{sp}imag"][()]
+
+            # TODO/FIXME: Assumes all measurements are co-pol ONLY
+            logger.warning(
+                "LEmmA V2 loader currently assumes _all_ measurements are co-pol only. Cross-pol measurements are treated as co-pol.",
+            )
+            ey_array = field_amplitude
+            ex_array = np.zeros_like(ey_array)
+
+    x_list = x_locs.tolist()
+    y_list = y_locs.tolist()
+    z_list = z_locs.tolist()
+
+    frequency_list = sample_frequencies.tolist()
+
+    ez_array = np.zeros_like(ey_array)
+
+    x_sample_location_array = np.sort(np.array(list(set(x_list))))
+    y_sample_location_array = np.sort(np.array(list(set(y_list))))
+    z_sample_location_array = np.sort(np.array(list(set(z_list))))
+
+    sample_frequency_array = np.sort(np.array(list(set(frequency_list))))
+
+    logger.debug(
+        "Sample location array shape: (x:%d, y:%d, z:%d, freq:%d)",
+        x_sample_location_array.size,
+        y_sample_location_array.size,
+        z_sample_location_array.size,
+        sample_frequency_array.size,
+    )
+
+    # Allocate new data array in multidimensional format
+    fields_shape = (
+        3,  # 3 for x,y,z component of the field
+        x_sample_location_array.size,
+        y_sample_location_array.size,
+        z_sample_location_array.size,
+        sample_frequency_array.size,
+    )
+    e_field = np.empty(fields_shape, dtype=np.complex128)
+
+    # Find to insert field values in e_field array
+    x_idx = np.searchsorted(x_sample_location_array, x_locs)
+    y_idx = np.searchsorted(y_sample_location_array, y_locs)
+    z_idx = np.searchsorted(z_sample_location_array, z_locs)
+
+    for f_idx in range(sample_frequencies.size):
+        e_field[0, x_idx, y_idx, z_idx, f_idx] = ex_array[:, f_idx]
+        e_field[1, x_idx, y_idx, z_idx, f_idx] = ey_array[:, f_idx]
+        e_field[2, x_idx, y_idx, z_idx, f_idx] = ez_array[:, f_idx]
+
+    fields = FieldDataset.create(
+        e_field=e_field,
+        h_field=None,
+        spatial_coords={
+            "x": x_sample_location_array,
+            "y": y_sample_location_array,
+            "z": z_sample_location_array,
+        },
+        frequency=sample_frequency_array,
+        coordinate_system=CoordinateSystemType.CARTESIAN,
+        field_type=FieldType.NEAR,
+        data_source=LEMMA_SOURCE_V2,
+    )
+
+    return fields

xnft_lemma_scanner-1.0.1/src/xnft_lemma_scanner/plugin.py

@@ -0,0 +1,9 @@
+"""
+Plugin manifest file.
+
+All files with registry decorators must be imported here.
+
+Copyright 2026 LEmmA, Electromagnetics Research Group, Michigan State University.
+"""
+
+from xnft_lemma_scanner.loaders.fields.lemma import load_lemma_v1_h5, load_lemma_v2_h5  # noqa: F401