Benchmarking suite for synthetic aperture radar imagery anomaly detection (SARIAD) algorithms
Overview
This package is designed for anomaly detection in Synthetic Aperture Radar (SAR) images, leveraging PyTorch Lightning and models from Anomalib. The package is modular, allowing easy benchmarking and dataset integration.
Directory Structure
SARIAD/
├── config/
│ ├── default.yaml
│ ├── environment.yaml # Conda environment file
├── datasets/
│ ├── __init__.py
│ ├── MSTAR/
│ ├── custom_dataset/
│ └── sar_datamodule.py
├── models/
│ ├── __init__.py
│ ├── anomalib_models.py
│ ├── autoencoder.py
│ └── transformer.py
├── preprocessing/
│ ├── __init__.py
│ ├── normalize.py
│ ├── augmentations.py
│ └── utils.py
├── benchmarks/
│ ├── __init__.py
│ └── benchmarking.py
├── main.py
├── __init__.py
└── utils/
├── __init__.py
└── config_loader.py
Installation
Our package is on PyPI and thus can simply be installed with pip install SARIAD using python>=3.13.
Development Installation
# Clone the repository
git clone https://github.com/Advanced-Vision-and-Learning-Lab/SARIAD
# Install SARIAD in editable mode
pip install -e .
Configuration
Edit the YAML file located in config/default.yaml to specify the dataset path, model, and training parameters.
Usage
# Train with a specific configuration
python main.py --config config/default.yaml
Benchmarking
To enable benchmarking, set benchmark.enabled: True in the YAML file and specify the number of runs.
Preprocessing
- normalize.py: Functions for data normalization.
- augmentations.py: Functions for data augmentations.
- utils.py: Utility functions for SAR-specific preprocessing.
The SARDataModule located in the datasets folder imports these functions to ensure consistent preprocessing across datasets.
License
MIT License
Acknowledgments
This project is inspired by Anomalib and Benchmarks for Medical Anomaly Detection (BMAD).
Contributing
Contributions are welcome! To contribute:
- Fork the repository on GitHub.
- Create a new branch with a descriptive name.
- Make your changes and ensure they follow the code style guidelines.
- Write unit tests for any new features or bug fixes.
- Submit a pull request with a clear description of your changes.
For major changes, please open an issue first to discuss what you'd like to change. We appreciate your contributions to improve this work!
Citing SARIAD
If you use the SARIAD code, please cite the following reference using the following entry.
Plain Text:
L. Chauvin, S. Gupta, A. Ibarra and J. Peeples, "Benchmarking suite for synthetic aperture radar imagery anomaly detection (SARIAD) algorithms," in Algorithms for Synthetic Aperture Radar Imagery XXXII, vol. TBD. International Society for Optics and Photonics (SPIE), 2025, DOI: 10.1117/12.3052519
BibTex:
@inproceedings{Chauvin2025Benchmarking,
title={Benchmarking suite for synthetic aperture radar imagery anomaly detection (SARIAD) algorithms},
author={Chauvin, Lucian and Gupta, Somil, and Ibarra, Angelina, and Peeples, Joshua},
booktitle={Algorithms for Synthetic Aperture Radar Imagery XXXII},
pages={TBD},
year={2025},
organization={International Society for Optics and Photonics (SPIE)}
doi={10.1117/12.3052519}
}
Citing MSTAR
If you use this dataset in your research, please cite the following paper:
@misc{mstar2025,
title = {MSTAR Public Dataset},
author = {{U.S. Air Force}},
year = {1995},
note = {Sensor Data Management System (SDMS)},
url = {https://www.sdms.afrl.af.mil/index.php?collection=mstar}
}
Metadata
Release files for SARIAD 0.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sariad-0.1.7.tar.gz | 138.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sariad-0.1.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 421.0 kB
Release files / sariad-0.1.7.tar.gz
| Download URL | sariad-0.1.7.tar.gz |
|---|---|
| Size | 138.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d5ae62376bbec3d8262d80ce10a8604b4a20d6d483fa268c2371bbe6b917a96c
|
|
BLAKE2b-256 checksum How to use checksums |
db28995e848fe6321f61f746f927036c832c3f414fe202fde95413c7d5b6bb15
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 7, 2025.
Transparency logRelease files / sariad-0.1.7-py3-none-any.whl
| Download URL | sariad-0.1.7-py3-none-any.whl |
|---|---|
| Size | 282.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
776f99bb8efaf0bc9b4686c055b5fc5128be9c5c2daae78647a58bf618eddd98
|
|
BLAKE2b-256 checksum How to use checksums |
0edc10b84e6fa07f0c293e034304c3c1f48a3ec0318ce40c03e42b43c0aaa9fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 7, 2025.
Transparency log