s1-denoise 0.0.0.dev0__py3-none-any.whl

s1_denoise-0.0.0.dev0.dist-info/METADATA

@@ -0,0 +1,147 @@
+Metadata-Version: 2.5
+Name: s1-denoise
+Version: 0.0.0.dev0
+Summary: Noise vector reconstruction for Level 1 Sentinel-1 products
+Project-URL: Homepage, https://github.com/aresys-srl/s1-denoise
+Project-URL: Documentation, https://opensource.aresys.it/s1-denoise/
+Project-URL: Repository, https://github.com/aresys-srl/s1-denoise
+Project-URL: Issues, https://github.com/aresys-srl/s1-denoise/issues
+Project-URL: Changelog, https://opensource.aresys.it/s1-denoise/API/changelog/
+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
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: click
+Requires-Dist: colorlog
+Requires-Dist: lxml
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: perseo-core
+Requires-Dist: pillow
+Requires-Dist: rasterio
+Requires-Dist: scipy
+Requires-Dist: sentinel1decoder
+Requires-Dist: xmltodict
+Description-Content-Type: text/markdown
+
+# Sentinel-1 Level 1 Noise Processor
+
+#### Thermal noise vector reconstruction for Sentinel-1 Level 1 products
+
+The S1 L1N Processor reconstructs the thermal noise range vectors for Sentinel-1 IW and EW products (both SLC and GRD) and writes them to output XML files that follow the standard Sentinel-1 annotation format. The reconstructed vectors can then be compared against the nominal noise annotations embedded in the SAFE product to assess noise estimation quality.
+
+For each processed channel the processor:
+
+1. reads acquisition geometry and calibration data from auxiliary files (PP1, CAL, INS);
+2. models the thermal noise using range spread loss, elevation antenna pattern, and calibration LUT;
+3. optionally refines the noise power correction using an associated Level 0 Noise (L0N) product;
+4. discards noise pulses whose power deviates from the expected noise level in AUX_INS by more than −3/+1 dB;
+5. for GRD products, handles sub-swath separation, per-subswath noise reconstruction and cross-subswath merging;
+6. writes the output noise XML files and, if nominal noise annotations are present in the SAFE product, reports the Mean Absolute Error (MAE) and maximum absolute error in dB.
+
+📖 **Documentation:** <https://opensource.aresys.it/s1-denoise/>
+
+---
+
+## Installation
+
+**Requirements:** Python ≥ 3.11, pip.
+
+Install the package from PyPI into a virtual environment of your choice:
+
+```bash
+pip install s1-denoise
+```
+
+Alternatively, install the wheel attached to a [GitHub release](https://github.com/aresys-srl/s1-denoise/releases):
+
+```bash
+pip install s1_denoise-<version>-py3-none-any.whl
+```
+
+Both options install the `denoise` command into the active Python environment.
+
+---
+
+## Usage
+
+The processor is driven by a **Job Order XML file** that specifies input products, auxiliary files, and the output path.
+
+```bash
+denoise "/path/to/job/order.xml"
+```
+
+The processor reads each L1 SAFE product listed in the Job Order, generates the noise profiles, and writes the output XML files to the configured output directory. If nominal noise annotations are found inside the SAFE product, the MAE against them is logged automatically.
+
+For all available options:
+
+```bash
+denoise --help
+```
+
+To print the installed version:
+
+```bash
+denoise --version
+```
+
+### Job Order structure
+
+The Job Order is an XML file that configures:
+
+| Field | Description |
+|---|---|
+| Input L1 SAFE products | One or more Sentinel-1 SAFE folders to process |
+| Input L0N products (optional) | Associated Level 0 Noise products for refined power correction |
+| Auxiliary files | AUX_PP1, AUX_CAL, AUX_INS product paths |
+| Output path | Directory where output XML files are written |
+| Log level | Verbosity of the processor log |
+
+A Job Order template is provided in [`templates/JobOrder.xml`](templates/JobOrder.xml). See the [Job Order documentation](https://opensource.aresys.it/s1-denoise/user-guide/job-order/) for the supported file types.
+
+---
+
+## Visualisation
+
+To visually compare the original noise annotation with the reconstructed one:
+
+```bash
+./scripts/compare_noise.py <noise_xml_filepath> <denoise_xml_filepath> --colorbar 0.01
+```
+
+The `--colorbar` argument sets the symmetric boundary (in dB) for the 2D difference plot colorbar.
+
+---
+
+## Documentation
+
+The documentation is built with [Zensical](https://zensical.org/). To build it locally:
+
+```bash
+pip install zensical mkdocstrings-python
+python tools/build_doc.py
+```
+
+The site is generated in the `site/` folder. Use `zensical serve` for a live preview while editing the pages in `docs/`.

s1_denoise-0.0.0.dev0.dist-info/RECORD

@@ -0,0 +1,21 @@
+s1_denoise/__init__.py,sha256=XBpWIcCzYk1sHaf-mz4NLKDg677cZmVVJqAiEilpQwM,570
+s1_denoise/__main__.py,sha256=K4foei3lxXaiBIp6aS1CaQHnwIE0xKVyQ5ROwxYHUn4,1077
+s1_denoise/auxiliary_files.py,sha256=691a_3V7CsjMasOs0MESJfBTQmL65gIPtH2WXj_mmIc,16338
+s1_denoise/baq_decoder.py,sha256=9zbitiKkJVCG-fZW_vdXnA3SumVgCX1FzwBVZfAj0lo,6373
+s1_denoise/cli.py,sha256=uOiqZ8c5pk3Mv4ZEoaS5qL7HsbhNRqgXSrMGBX63S-Y,4566
+s1_denoise/error_calculation.py,sha256=4sMrh4UxX_sFDck-A1QFkxQqbZs5AhSmtHcVoP8eQ-s,8568
+s1_denoise/jo_parser.py,sha256=mVw01nTH13w0zHxmIleIAb43FkfFBiMp4lv8j0dkq7k,11894
+s1_denoise/l0_noise_power_calculation.py,sha256=B-WahMNqTqsadCJIRCpujOtxi5IZGEAxEyj_QJ3afAM,14604
+s1_denoise/logger.py,sha256=1YLMCdDQ__CEJibkIdUgtTE4LJsrZJu8kHVaA_YxLxc,2801
+s1_denoise/noise_norm_factor.py,sha256=z7UMxIapLyvW28fgSOZptVfuo91v1__H0iqNvAoQRnk,10785
+s1_denoise/noise_profiles.py,sha256=UEBqNLhNpnEE__aXbMfycM1gyYqn16LpH4rYUH1JnT4,12171
+s1_denoise/output.py,sha256=AgF4IownRfjnMQTBlncEEQ1a-wVRjRlFBQEddF4y3TE,20541
+s1_denoise/s1safe.py,sha256=QyHRbubkQ_pmdvrcG-Asp8lriuF144aF79eiJ3pJY58,47569
+s1_denoise/thermal_noise.py,sha256=iqrRONWLrTsUzgaCJqr-mAxba5eygR0T5rlyjBq-2ZA,30156
+s1_denoise/utils.py,sha256=HcgdFoAE0qkNqfGnmHewYg0dj_Q1cB6yQjJNpXO51CU,9416
+s1_denoise/xml_reader.py,sha256=p0OqVZHv_CluLIFnJhTOTx2L3QAXsocFWF2nby6g8D0,20566
+s1_denoise-0.0.0.dev0.dist-info/METADATA,sha256=98RQ6PLCEiVMshMBoSKgssreNvDxfwB6RYCS80hSnl0,5788
+s1_denoise-0.0.0.dev0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+s1_denoise-0.0.0.dev0.dist-info/entry_points.txt,sha256=9ZdqTYz5mRFdKxGEKkKNt8QwUnCxY4cP2dWbrv7a954,53
+s1_denoise-0.0.0.dev0.dist-info/licenses/LICENSE,sha256=a3_V9QnJUAnm2Uravyt09u1geH9O1SZTGI9NmGLEsoU,1081
+s1_denoise-0.0.0.dev0.dist-info/RECORD,,

s1_denoise-0.0.0.dev0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

s1_denoise-0.0.0.dev0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+denoise = s1_denoise.__main__:main

s1_denoise-0.0.0.dev0.dist-info/licenses/LICENSE

@@ -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.