hyperbench 0.1.0__tar.gz

hyperbench-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ritik Shah
+
+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.

hyperbench-0.1.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: hyperbench
+Version: 0.1.0
+Summary: Synthetic benchmarking for hyperspectral super-resolution methods
+Author: HyperBench Authors
+License: MIT
+Keywords: hyperspectral imaging,super-resolution,remote sensing,benchmarking,image fusion
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy==1.26.4
+Requires-Dist: scipy>=1.10
+Requires-Dist: opencv-python==4.9.0.80
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: sewar>=0.4.6
+Requires-Dist: spectral>=0.23
+Requires-Dist: ipykernel>=6.29
+Requires-Dist: jupyterlab>=4.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# HyperBench
+
+**HyperBench** is a synthetic benchmarking framework for fusion based hyperspectral
+super-resolution (HSR) methods. It provides a standardized, reproducible
+pipeline for evaluating models using controlled degradations, consistent
+metrics, and structured experiment outputs.
+
+HyperBench is designed as an **inference-time evaluation tool**. It does
+not perform model training. Instead, it enables users to test
+already-trained models under a wide range of synthetic scenarios.
+
+**Project Home: https://github.com/ritikgshah/HyperBench**. Please visit the github repository for exact implementation details and documentation. This PyPi project is solely meant to serve as the distribution method. 
+
+------------------------------------------------------------------------
+
+## Key Features
+
+### Synthetic Degradation Pipeline
+
+HyperBench generates realistic low-resolution inputs from
+high-resolution hyperspectral scenes:
+
+-   Spatial degradation via configurable Point Spread Functions (PSFs)
+-   Spectral degradation via configurable Spectral Response Functions
+    (SRFs)
+-   Controlled noise injection using SNR (dB)
+
+------------------------------------------------------------------------
+
+### Flexible Experiment Design
+
+Users can define experiments using:
+
+-   Explicit degradation specifications
+-   PSF configurations (type, sigma, kernel size)
+-   Noise levels (spatial and spectral)
+-   MSI band counts
+
+------------------------------------------------------------------------
+
+### Model-Agnostic Adapter Interface
+
+HyperBench works with any model that follows a simple contract:
+
+def run_pipeline(HR_MSI, LR_HSI, srf, psf=None, metadata=None): return
+prediction
+
+or
+
+return prediction, stats
+
+Supported formats: - NumPy - TensorFlow - PyTorch
+
+------------------------------------------------------------------------
+
+### Built-in Metrics
+
+-   RMSE
+-   PSNR
+-   SSIM
+-   UIQI
+-   ERGAS
+-   SAM
+
+------------------------------------------------------------------------
+
+### Output Clipping Policy
+
+Optional clipping to \[0,1\] before metric evaluation.
+
+------------------------------------------------------------------------
+
+### Structured CSV Logging
+
+Each experiment produces structured CSV output with: - parameters -
+metrics - optional model stats
+
+------------------------------------------------------------------------
+
+### Visualization Utilities
+
+-   RGB visualization
+-   band inspection
+-   PSF and SRF visualization
+-   spectral plots
+
+------------------------------------------------------------------------
+
+### Framework Support
+
+-   NumPy
+-   TensorFlow
+-   PyTorch
+
+Automatic device handling included.
+
+------------------------------------------------------------------------
+
+## Installation
+
+pip install hyperbench
+
+------------------------------------------------------------------------
+
+## Command Line Interface
+
+hyperbench run\
+--config config.yaml\
+--pipeline-module path/to/model.py\
+--method-name MyModel\
+--input-backend tensorflow
+
+------------------------------------------------------------------------
+
+## Configuration
+
+Supports JSON and YAML configuration files.
+
+------------------------------------------------------------------------
+
+## Design Philosophy
+
+-   Reproducibility
+-   Standardization
+-   Flexibility
+
+------------------------------------------------------------------------
+
+## Scope
+
+HyperBench is strictly an evaluation framework.
+
+------------------------------------------------------------------------
+
+## License
+
+MIT License

hyperbench-0.1.0/README.md

@@ -0,0 +1,137 @@
+# HyperBench
+
+**HyperBench** is a synthetic benchmarking framework for fusion based hyperspectral
+super-resolution (HSR) methods. It provides a standardized, reproducible
+pipeline for evaluating models using controlled degradations, consistent
+metrics, and structured experiment outputs.
+
+HyperBench is designed as an **inference-time evaluation tool**. It does
+not perform model training. Instead, it enables users to test
+already-trained models under a wide range of synthetic scenarios.
+
+**Project Home: https://github.com/ritikgshah/HyperBench**. Please visit the github repository for exact implementation details and documentation. This PyPi project is solely meant to serve as the distribution method. 
+
+------------------------------------------------------------------------
+
+## Key Features
+
+### Synthetic Degradation Pipeline
+
+HyperBench generates realistic low-resolution inputs from
+high-resolution hyperspectral scenes:
+
+-   Spatial degradation via configurable Point Spread Functions (PSFs)
+-   Spectral degradation via configurable Spectral Response Functions
+    (SRFs)
+-   Controlled noise injection using SNR (dB)
+
+------------------------------------------------------------------------
+
+### Flexible Experiment Design
+
+Users can define experiments using:
+
+-   Explicit degradation specifications
+-   PSF configurations (type, sigma, kernel size)
+-   Noise levels (spatial and spectral)
+-   MSI band counts
+
+------------------------------------------------------------------------
+
+### Model-Agnostic Adapter Interface
+
+HyperBench works with any model that follows a simple contract:
+
+def run_pipeline(HR_MSI, LR_HSI, srf, psf=None, metadata=None): return
+prediction
+
+or
+
+return prediction, stats
+
+Supported formats: - NumPy - TensorFlow - PyTorch
+
+------------------------------------------------------------------------
+
+### Built-in Metrics
+
+-   RMSE
+-   PSNR
+-   SSIM
+-   UIQI
+-   ERGAS
+-   SAM
+
+------------------------------------------------------------------------
+
+### Output Clipping Policy
+
+Optional clipping to \[0,1\] before metric evaluation.
+
+------------------------------------------------------------------------
+
+### Structured CSV Logging
+
+Each experiment produces structured CSV output with: - parameters -
+metrics - optional model stats
+
+------------------------------------------------------------------------
+
+### Visualization Utilities
+
+-   RGB visualization
+-   band inspection
+-   PSF and SRF visualization
+-   spectral plots
+
+------------------------------------------------------------------------
+
+### Framework Support
+
+-   NumPy
+-   TensorFlow
+-   PyTorch
+
+Automatic device handling included.
+
+------------------------------------------------------------------------
+
+## Installation
+
+pip install hyperbench
+
+------------------------------------------------------------------------
+
+## Command Line Interface
+
+hyperbench run\
+--config config.yaml\
+--pipeline-module path/to/model.py\
+--method-name MyModel\
+--input-backend tensorflow
+
+------------------------------------------------------------------------
+
+## Configuration
+
+Supports JSON and YAML configuration files.
+
+------------------------------------------------------------------------
+
+## Design Philosophy
+
+-   Reproducibility
+-   Standardization
+-   Flexibility
+
+------------------------------------------------------------------------
+
+## Scope
+
+HyperBench is strictly an evaluation framework.
+
+------------------------------------------------------------------------
+
+## License
+
+MIT License

hyperbench-0.1.0/pyproject.toml

@@ -0,0 +1,74 @@
+# Author: Ritik Shah
+
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hyperbench"
+version = "0.1.0"
+description = "Synthetic benchmarking for hyperspectral super-resolution methods"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [
+  { name = "HyperBench Authors" }
+]
+keywords = [
+  "hyperspectral imaging",
+  "super-resolution",
+  "remote sensing",
+  "benchmarking",
+  "image fusion",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Topic :: Scientific/Engineering :: Image Processing",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+
+dependencies = [
+  "numpy==1.26.4",
+  "scipy>=1.10",
+  "opencv-python==4.9.0.80",
+  "matplotlib>=3.7",
+  "sewar>=0.4.6",
+  "spectral>=0.23",
+  "ipykernel>=6.29",
+  "jupyterlab>=4.0",
+  "pyyaml>=6.0"
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0",
+  "pytest-cov>=4.1",
+  "build>=1.2",
+  "twine>=5.0",
+  "ruff>=0.6",
+]
+
+[project.scripts]
+hyperbench = "hyperbench.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+addopts = "-ra"
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B"]

hyperbench-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hyperbench-0.1.0/src/hyperbench/__about__.py

@@ -0,0 +1,7 @@
+# Author: Ritik Shah
+
+"""Package metadata for HyperBench."""
+
+__all__ = ["__version__"]
+
+__version__ = "0.1.0"

hyperbench-0.1.0/src/hyperbench/__init__.py

@@ -0,0 +1,157 @@
+# Author: Ritik Shah
+
+"""HyperBench: synthetic benchmarking for hyperspectral super-resolution."""
+
+from .__about__ import __version__
+
+from .adapters import (
+    BaseAdapter,
+    CallableAdapter,
+    PipelineAdapter,
+    ReconstructionInputs,
+    TensorFlowModelAdapter,
+    TorchModelAdapter,
+)
+from .benchmark import (
+    BenchmarkCase,
+    BenchmarkConfig,
+    BenchmarkResults,
+    DegradationSpec,
+    SyntheticCase,
+    generate_cases,
+    run_benchmark,
+)
+from .config import benchmark_config_from_dict, load_benchmark_config
+from .degradations import (
+    AVAILABLE_PSFS,
+    SUPPORTED_SRF_BAND_COUNTS,
+    make_psf,
+    normalize_image,
+    spatial_degradation,
+    spectral_degradation,
+)
+from .exceptions import (
+    AdapterError,
+    AdapterOutputError,
+    ConfigurationError,
+    FrameworkAvailabilityError,
+    HyperBenchError,
+    IOValidationError,
+    MetricsError,
+    PipelineError,
+    SceneKeyError,
+    ShapeMismatchError,
+    UnsupportedPSFError,
+    UnsupportedSRFError,
+)
+from .io import load_hsi
+from .metrics import (
+    AVAILABLE_METRICS,
+    DEFAULT_METRICS,
+    compute_ergas,
+    compute_psnr,
+    compute_rmse,
+    compute_sam,
+    compute_ssim,
+    compute_uiqi,
+    evaluate_metrics,
+)
+from .types import Array, Metadata, PathLike
+from .utils import (
+    convert_prediction_to_numpy_hwc,
+    get_preferred_tensorflow_device,
+    get_preferred_torch_device,
+    get_tensorflow_device_info,
+    get_torch_device_info,
+    is_tensorflow_available,
+    is_torch_available,
+    numpy_hwc_to_tf_image,
+    numpy_hwc_to_torch_image,
+    numpy_prediction_to_hwc,
+    numpy_to_tf_matrix,
+    numpy_to_torch_matrix,
+    plot_spectra,
+    print_data_stats,
+    print_framework_device_summary,
+    tf_image_to_numpy_hwc,
+    tf_matrix_to_numpy,
+    torch_image_to_numpy_hwc,
+    torch_matrix_to_numpy,
+    visualize_band,
+    visualize_hsi,
+    visualize_multispectral_with_srf,
+    visualize_psfs,
+)
+
+__all__ = [
+    "__version__",
+    "Array",
+    "PathLike",
+    "Metadata",
+    "HyperBenchError",
+    "ConfigurationError",
+    "IOValidationError",
+    "SceneKeyError",
+    "ShapeMismatchError",
+    "UnsupportedPSFError",
+    "UnsupportedSRFError",
+    "AdapterError",
+    "AdapterOutputError",
+    "PipelineError",
+    "MetricsError",
+    "FrameworkAvailabilityError",
+    "BaseAdapter",
+    "CallableAdapter",
+    "PipelineAdapter",
+    "TorchModelAdapter",
+    "TensorFlowModelAdapter",
+    "ReconstructionInputs",
+    "DegradationSpec",
+    "BenchmarkConfig",
+    "BenchmarkCase",
+    "SyntheticCase",
+    "BenchmarkResults",
+    "generate_cases",
+    "run_benchmark",
+    "benchmark_config_from_dict",
+    "load_benchmark_config",
+    "load_hsi",
+    "AVAILABLE_PSFS",
+    "SUPPORTED_SRF_BAND_COUNTS",
+    "make_psf",
+    "normalize_image",
+    "spatial_degradation",
+    "spectral_degradation",
+    "AVAILABLE_METRICS",
+    "DEFAULT_METRICS",
+    "compute_rmse",
+    "compute_psnr",
+    "compute_ssim",
+    "compute_uiqi",
+    "compute_ergas",
+    "compute_sam",
+    "evaluate_metrics",
+    "print_data_stats",
+    "visualize_hsi",
+    "visualize_band",
+    "visualize_multispectral_with_srf",
+    "plot_spectra",
+    "visualize_psfs",
+    "is_torch_available",
+    "is_tensorflow_available",
+    "get_torch_device_info",
+    "get_tensorflow_device_info",
+    "get_preferred_torch_device",
+    "get_preferred_tensorflow_device",
+    "print_framework_device_summary",
+    "numpy_hwc_to_tf_image",
+    "tf_image_to_numpy_hwc",
+    "numpy_to_tf_matrix",
+    "tf_matrix_to_numpy",
+    "numpy_hwc_to_torch_image",
+    "torch_image_to_numpy_hwc",
+    "numpy_to_torch_matrix",
+    "torch_matrix_to_numpy",
+    "numpy_prediction_to_hwc",
+    "convert_prediction_to_numpy_hwc",
+]

hyperbench-0.1.0/src/hyperbench/adapters/__init__.py

@@ -0,0 +1,19 @@
+# Author: Ritik Shah
+
+"""Model adapter layer for HyperBench."""
+
+from .base import BaseAdapter, ReconstructionInputs, ShapePolicy
+from .callable import CallableAdapter
+from .pipeline import PipelineAdapter
+from .tensorflow import TensorFlowModelAdapter
+from .torch import TorchModelAdapter
+
+__all__ = [
+    "ShapePolicy",
+    "ReconstructionInputs",
+    "BaseAdapter",
+    "CallableAdapter",
+    "PipelineAdapter",
+    "TorchModelAdapter",
+    "TensorFlowModelAdapter",
+]