aresys_io 0.0.0.dev0__tar.gz

aresys_io-0.0.0.dev0/.gitignore

@@ -0,0 +1,197 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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/
+
+# 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/
+
+# 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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm-project.org/#use-with-ide
+.pdm.toml
+.pdm-python
+.pdm-build/
+pdm.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# Distribution / packaging
+build/
+_build/
+dist/
+*.egg-info/
+.ipynb_checkpoints/
+.nox
+
+# Pyenv
+.python-version
+
+# VS Code project settings
+.vscode
+
+# PyCharm project settings
+.idea
+
+# Spyder project settings
+.spyproject
+
+# Environments
+venv*
+
+# Docker
+docker-compose.yml
+Dockerfile
+.devcontainer
+
+# Other
+*.bak
+.coverage
+htmlcov
+*.svg

aresys_io-0.0.0.dev0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) Aresys S.r.l. <info@aresys.it>
+
+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.

aresys_io-0.0.0.dev0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.5
+Name: aresys_io
+Version: 0.0.0.dev0
+Summary: Python library for reading and writing Aresys EO/SAR product formats.
+Project-URL: Homepage, https://github.com/aresys-srl/aresys_io
+Project-URL: Repository, https://github.com/aresys-srl/aresys_io
+Project-URL: Documentation, https://opensource.aresys.it/aresys_io
+Author-email: "Aresys S.R.L." <info@aresys.it>
+License: MIT License
+        
+        Copyright (C) Aresys S.r.l. <info@aresys.it>
+        
+        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.
+License-File: LICENSE.txt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: lxml
+Requires-Dist: numpy>2
+Requires-Dist: numpydantic
+Requires-Dist: perseo-core
+Requires-Dist: pydantic
+Requires-Dist: scipy
+Requires-Dist: xsdata>=26.2
+Provides-Extra: dev
+Requires-Dist: ruff>=0.16.7; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocstrings-python; extra == 'docs'
+Requires-Dist: zensical; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Provides-Extra: typecheck
+Requires-Dist: pyrefly==1.1.0; extra == 'typecheck'
+Requires-Dist: scipy-stubs; extra == 'typecheck'
+Description-Content-Type: text/markdown
+
+# aresys_io README
+
+Python library for reading and writing Aresys EO/SAR product formats.
+
+## Installation
+
+This package can be installed using ``pip``:
+
+```
+pip install aresys_io
+```
+
+This project uses Hatchling building backend.
+

aresys_io-0.0.0.dev0/README.md

@@ -0,0 +1,14 @@
+# aresys_io README
+
+Python library for reading and writing Aresys EO/SAR product formats.
+
+## Installation
+
+This package can be installed using ``pip``:
+
+```
+pip install aresys_io
+```
+
+This project uses Hatchling building backend.
+

aresys_io-0.0.0.dev0/docs/.gitignore

@@ -0,0 +1 @@
+build.md

aresys_io-0.0.0.dev0/docs/about/build.template.md

@@ -0,0 +1,13 @@
+---
+icon: lucide/badge-info
+---
+
+# Build
+
+Documentation build info and versioning information.
+
+Version: ==__TAG__==
+
+Commit: ==__SHA__==
+
+Build date: ==__DATE__==

aresys_io-0.0.0.dev0/docs/changelog.md

@@ -0,0 +1,26 @@
+---
+icon: lucide/history
+title: "Changelog"
+tags:
+    - changelog
+    - release notes
+---
+
+# Changelog
+
+## v1.1.1
+
+**Other changes**
+
+- Improving `MetaDataChannel` and `MetaData` classes with ``__contains__`` methods.
+- Vectorized Polynomials evaluation in range and separating input azimuth and range values.
+
+## v1.1.0
+
+First public release.
+
+The interface has been reviewed and updated.
+
+## v1.0.0
+
+First beta release.

aresys_io-0.0.0.dev0/docs/documentation/point_target/api.md

@@ -0,0 +1,18 @@
+---
+icon: fontawesome/brands/python
+title: "API"
+tags:
+    - point targets
+    - simulation
+    - e2e
+    - API
+    - python
+---
+
+## Point Target Binary
+
+::: aresys_io.product.point_target.point_target_binary
+
+## Nominal Point Targets
+
+::: aresys_io.product.point_target.nominal_point_targets

aresys_io-0.0.0.dev0/docs/documentation/point_target/index.md

@@ -0,0 +1,111 @@
+---
+icon: lucide/crosshair
+title: "Point Target Binary"
+tags:
+    - point target
+    - simulation
+    - e2e
+    - calibration
+    - python
+---
+
+# Point Target Binary { #targets data-toc-label="Point Target" }
+
+The **Point Target Binary** format is the official Aresys format for storing and organizing artificial or real
+point targets used throughout SAR simulation and calibration processing chains.
+
+Each target is defined by its 3D spatial coordinates and its full polarimetric radar cross section (RCS). The format
+stores discrete radar reflectors (such as corner reflectors, active radar calibrators, or synthetic point scatterers) and
+it's mainly used in SAR end-to-end (E2E) simulators, performance assessment, and impulse response function (IRF) analysis.
+
+Managing and working with this format is handled directly via `aresys_io.product` or in the dedicated module `aresys_io.product.point_target`.
+Common operations include:
+
+- creating and writing Point Target Binary products
+- reading point target coordinates and polarimetric RCS values
+- chunked and windowed reading for large simulation datasets
+- memory-mapped access for zero-copy, efficient streaming of large scatterer fields
+- converting arrays to structured nominal point target objects
+
+## Product Structure
+
+A Point Target Binary product is physically organized as a **folder** containing a fixed set of binary raster files
+accompanied by corresponding XML metadata files.
+
+A complete point target product consists of **7 binary raster files** and **7 matching XML annotation files**:
+
+- **3 Coordinates rasters & metadata**: one for each spatial dimension ($X$, $Y$, and $Z$) in Cartesian coordinates (typically ECEF).
+- **4 Radar Cross Section (RCS) rasters & metadata**: one for each linear polarization channel ($HH$, $HV$, $VH$, and $VV$) representing the complex scattering matrix.
+
+Each binary file represents a 1D column raster containing the respective value for every point target in the dataset.
+
+## Point Target Binary at a Glance
+
+From a structural point of view, a Point Target Binary product folder is organized as follows:
+
+```text
+Point Target Folder/
+├── PointTargetPosX          # X coordinate binary raster
+├── PointTargetPosX.xml      # X coordinate metadata
+├── PointTargetPosY          # Y coordinate binary raster
+├── PointTargetPosY.xml      # Y coordinate metadata
+├── PointTargetPosZ          # Z coordinate binary raster
+├── PointTargetPosZ.xml      # Z coordinate metadata
+├── PointTargetRCSHH         # HH polarization complex RCS binary raster
+├── PointTargetRCSHH.xml     # HH polarization metadata
+├── PointTargetRCSHV         # HV polarization complex RCS binary raster
+├── PointTargetRCSHV.xml     # HV polarization metadata
+├── PointTargetRCSVH         # VH polarization complex RCS binary raster
+├── PointTargetRCSVH.xml     # VH polarization metadata
+├── PointTargetRCSVV         # VV polarization complex RCS binary raster
+└── PointTargetRCSVV.xml     # VV polarization metadata
+```
+
+All 7 raster files share the exact same number of lines ($N$, corresponding to the total number of point targets) and have
+a single sample per line (`samples = 1`).
+
+## Product Components
+
+### Coordinates Rasters and Metadata
+
+The **coordinates rasters** store the 3D position vector for each point target:
+
+- `PointTargetPosX`: $X$ coordinate in meters.
+- `PointTargetPosY`: $Y$ coordinate in meters.
+- `PointTargetPosZ`: $Z$ coordinate in meters.
+
+Positions are stored as floating-point values, using either single precision (`FLOAT32`) or double precision (`FLOAT64`).
+Each raster has an associated XML annotation file containing a `RasterInfo` element describing the data layout, cell type,
+number of lines ($N$), and byte order.
+
+### RCS Rasters and Metadata
+
+The **RCS rasters** store the complex scattering coefficients representing the full polarimetric scattering matrix for
+each point target:
+
+- `PointTargetRCSHH`: Horizontal transmit, Horizontal receive ($S_{HH}$).
+- `PointTargetRCSHV`: Vertical transmit, Horizontal receive ($S_{HV}$).
+- `PointTargetRCSVH`: Horizontal transmit, Vertical receive ($S_{VH}$).
+- `PointTargetRCSVV`: Vertical transmit, Vertical receive ($S_{VV}$).
+
+Scattering values are stored as complex numbers, using either single-precision complex (`FLOAT_COMPLEX`) or double-precision
+complex (`DOUBLE_COMPLEX`). The corresponding XML files provide standard Aresys metadata for each polarization channel.
+
+### Consistency Requirements
+
+When opening a Point Target Binary product in read mode:
+
+1. The folder must exist and be a valid directory.
+2. All 7 binary raster files and all 7 XML metadata files must be present.
+3. Every metadata file must specify `samples = 1`.
+4. The number of lines (`lines`) must be consistent across all 7 metadata files, defining the total number of targets.
+
+## High-Level Representation: Nominal Point Targets
+
+While the binary product stores tabular data in separate rasters for performance and fast column access, `aresys_io`
+also provides a high-level Python representation:
+
+- `NominalPointTarget`: A dataclass encapsulating an individual target's 3D position vector ($X, Y, Z$), complex polarimetric
+  scattering coefficients ($S_{HH}, S_{HV}, S_{VH}, S_{VV}$), and an optional delay.
+- `convert_array_to_point_target_structure()`: A conversion utility to transform raw coordinate and RCS arrays into a
+  keyed dictionary of `NominalPointTarget` instances.

aresys_io-0.0.0.dev0/docs/documentation/point_target/quickstart.md

@@ -0,0 +1,162 @@
+---
+icon: lucide/zap
+title: "Quickstart"
+tags:
+    - point target
+    - simulation
+    - e2e
+    - python
+    - quickstart
+    - example
+---
+
+# Quickstart example
+
+The following is a complete, runnable example that demonstrates all the functionalities described in the previous
+sections. Copy it into a Python file and run it to start working with Point Target Binary products.
+
+```python
+import shutil
+from pathlib import Path
+
+import numpy as np
+
+from aresys_io.product import (
+    PointSetProduct,
+    convert_array_to_point_target_structure,
+)
+
+PRODUCT_PATH = Path("example_point_targets")
+NUM_TARGETS = 10
+
+
+# -----------------------------------------------------------------------------
+# 1. Synthesize point target data
+# -----------------------------------------------------------------------------
+
+print(f"Synthesizing {NUM_TARGETS} point targets...")
+
+# Target coordinates: (N, 3) in Cartesian / ECEF coordinates [X, Y, Z]
+base_coord = np.array([2197913.48, 1102055.64, 5865641.61])
+offsets = np.arange(NUM_TARGETS)[:, np.newaxis] * 100.0
+coords = base_coord + offsets
+
+# Polarimetric RCS: (N, 4) complex scattering values [HH, HV, VH, VV]
+# Simulating trihedral corner reflectors (co-pol = 1.0, cross-pol = 0.0)
+rcs = np.zeros((NUM_TARGETS, 4), dtype=np.complex128)
+rcs[:, 0] = 1.0 + 0.0j  # HH
+rcs[:, 1] = 0.0 + 0.0j  # HV
+rcs[:, 2] = 0.0 + 0.0j  # VH
+rcs[:, 3] = 1.0 + 0.0j  # VV
+
+print(f"Coordinates shape: {coords.shape}")
+print(f"RCS shape: {rcs.shape}")
+
+
+# -----------------------------------------------------------------------------
+# 2. Write Point Target Binary product
+# -----------------------------------------------------------------------------
+
+print(f"\nWriting Point Target Binary product to: {PRODUCT_PATH.resolve()}")
+
+prod_writer = PointSetProduct(PRODUCT_PATH, open_mode="w")
+prod_writer.write_data(
+    coords=coords,
+    rcs=rcs,
+    coords_data_type="FLOAT64",
+    rcs_data_type="FLOAT_COMPLEX",
+)
+
+print("Product successfully created.")
+
+
+# -----------------------------------------------------------------------------
+# 3. Open and inspect product in read mode
+# -----------------------------------------------------------------------------
+
+print("\nOpening product in read mode...")
+
+prod_reader = PointSetProduct(PRODUCT_PATH, open_mode="r")
+
+print(f"Product path: {prod_reader.product_path}")
+print(f"Number of targets: {prod_reader.number_of_targets}")
+
+
+# -----------------------------------------------------------------------------
+# 4. Read all data
+# -----------------------------------------------------------------------------
+
+print("\nReading all point target data...")
+
+read_coords, read_rcs = prod_reader.read_data()
+
+print(f"Read coordinates shape: {read_coords.shape}, dtype: {read_coords.dtype}")
+print(f"Read RCS shape: {read_rcs.shape}, dtype: {read_rcs.dtype}")
+print(f"First target position: {read_coords[0]}")
+print(f"First target RCS: HH={read_rcs[0, 0]}, VV={read_rcs[0, 3]}")
+
+
+# -----------------------------------------------------------------------------
+# 5. Windowed / subset reading
+# -----------------------------------------------------------------------------
+
+print("\nReading a subset of targets (windowed read)...")
+
+sub_coords, sub_rcs = prod_reader.read_data(start=2, num_points=4)
+
+print(f"Subset coordinates shape: {sub_coords.shape}")
+print(f"Subset RCS shape: {sub_rcs.shape}")
+
+
+# -----------------------------------------------------------------------------
+# 6. Memory-mapped reading
+# -----------------------------------------------------------------------------
+
+print("\nStreaming targets via memory mapping...")
+
+with prod_reader.read_data_as_memmap() as (coords_mm, rcs_mm):
+    print(f"X coordinate memmap shape: {coords_mm.x.shape}")
+    print(f"HH RCS memmap shape: {rcs_mm.HH.shape}")
+
+    # Access elements directly on disk without allocating full arrays
+    for i in range(3):
+        print(
+            f"Target {i}: Pos=({coords_mm.x[i, 0]:.2f}, {coords_mm.y[i, 0]:.2f}, {coords_mm.z[i, 0]:.2f}) "
+            f"| HH={rcs_mm.HH[i, 0]}"
+        )
+
+
+# -----------------------------------------------------------------------------
+# 7. Convert to structured NominalPointTarget objects
+# -----------------------------------------------------------------------------
+
+print("\nConverting array data to NominalPointTarget dictionary...")
+
+target_ids = [f"CR_{i:02d}" for i in range(NUM_TARGETS)]
+targets_dict = convert_array_to_point_target_structure(
+    coords=read_coords,
+    rcs=read_rcs,
+    point_target_ids=target_ids,
+)
+
+sample_id = "CR_00"
+sample_target = targets_dict[sample_id]
+
+print(f"Target ID: {sample_id}")
+print(f"  Coordinates: {sample_target.xyz_coordinates}")
+print(f"  RCS HH: {sample_target.rcs_hh}")
+print(f"  RCS HV: {sample_target.rcs_hv}")
+print(f"  RCS VH: {sample_target.rcs_vh}")
+print(f"  RCS VV: {sample_target.rcs_vv}")
+print(f"  Delay: {sample_target.delay}")
+
+
+# -----------------------------------------------------------------------------
+# 8. Clean up example product folder
+# -----------------------------------------------------------------------------
+
+if PRODUCT_PATH.exists():
+    shutil.rmtree(PRODUCT_PATH)
+
+print("\nDone!")
+```