trap
Detection of exoplanets in direct imaging data by causal regression of temporal systematics
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 6 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.1%) to scientific vocabulary
Repository
Detection of exoplanets in direct imaging data by causal regression of temporal systematics
Basic Info
- Host: GitHub
- Owner: m-samland
- License: mit
- Language: Python
- Default Branch: main
- Size: 15.1 MB
Statistics
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 4
- Releases: 4
Metadata Files
README.md
TRAP – Temporal Reference Analysis for Planets
TRAP is a novel algorithm for the detection of exoplanets in high-contrast direct imaging data. Unlike traditional image-based approaches, TRAP models and removes stellar contamination using causal temporal regression, offering improved sensitivity to exoplanet signals at small angular separations from the host star.
📄 For a detailed methodology and scientific background, see:
Samland et al. 2021, A&A, 646, A24
Key Features
- Temporal Systematics Modeling: Models time-dependent stellar residuals using causal regression for improved contrast at small inner working angles.
- Automatic Detection and Characterization: Automatically detect point sources and extract their spectra.
- Spectral Template Matching: Works with external spectral templates (using
species) for improved detection. - Parallel Processing: Efficient parallelism via Ray, scalable from laptops to clusters.
- Automated Visualization: Generates diagnostic plots, spectra, and contrast curves for each reduction pipeline run.
Installation
TRAP requires Python 3.11 or 3.12. It can be installed directly from GitHub:
bash
pip install git+https://github.com/m-samland/trap
⚠️ TRAP uses Ray for multiprocessing. If you run TRAP on a computing cluster, make sure Ray is available on the cluster nodes.
Quick Start
A Jupyter notebook and example dataset based on VLT/SPHERE observations are provided. They demonstrate the full workflow: loading data, performing temporal regression, generating detection maps, and extracting companion spectra.
🔗 Related Project: spherical
Looking for a full data reduction pipeline for VLT/SPHERE-IFS data?
Check out spherical — a companion package to TRAP that provides an end-to-end workflow from data discovery and calibration to post-processing.
- 🔍 Automates retrieval of SPHERE-IFS raw and calibration data from the ESO archive
- ⚙️ Uses a Python-based, open-source pipeline based on the CHARIS data reduction pipeline
(Samland et al. 2022) — a high-performance alternative to the official SPHERE-DRH - 📊 Seamlessly integrates with TRAP for temporal analysis and exoplanet detection
- 🌈 Automatically applies TRAP’s template matching to collapse detection maps using spectral models (e.g., L- and T-type planets)
TRAP is fully supported as the post-processing backend in
spherical, making it easy to go from raw SPHERE data to scientifically validated planet detections.
👉 Learn more at: https://github.com/m-samland/spherical
Contributing
We warmly welcome contributions to TRAP! Here's how to get started:
Setup for Developers
Clone the repository and install it locally for development with tests:
bash
git clone https://github.com/m-samland/trap.git
cd trap
pip install -e ".[test]"
Contributing Guidelines
- Please use feature branches or forks for developing new features or bug fixes.
- Issue and Pull Request templates are provided—please use them.
- Always run the code linting tool (
ruff) before submitting a Pull Request:
bash
ruff check .
If you’re unsure where to start, check out the good first issues or open a discussion.
📖 Citing TRAP
If you use TRAP in your research, please cite:
Matthias Samland et al. (2021) – A temporal systematics model for improved direct detection of exoplanets at small angular separations
A&A, Vol. 646, A24
DOI: 10.1051/0004-6361/201937308
bibtex
@ARTICLE{2021A&A...646A..24S,
author = {{Samland}, M. and {Bouwman}, J. and {Hogg}, D.~W. and {Brandner}, W. and {Henning}, T. and {Janson}, M.},
title = "{TRAP: a temporal systematics model for improved direct detection of exoplanets at small angular separations}",
journal = {\aap},
year = 2021,
month = feb,
volume = {646},
pages = {A24},
doi = {10.1051/0004-6361/201937308},
archivePrefix = {arXiv},
eprint = {2011.12311},
primaryClass = {astro-ph.EP},
adsurl = {https://ui.adsabs.harvard.edu/abs/2021A&A...646A..24S},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
For other citation formats, visit the ADS entry.
Versioning
The peer-reviewed publication describes release version v1.0.0 of TRAP.
Subsequent changes and feature additions are documented in the CHANGELOG.
License
This project is licensed under the MIT License.
Author
Matthias Samland
GitHub: @m-samland
Owner
- Login: m-samland
- Kind: user
- Repositories: 1
- Profile: https://github.com/m-samland
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use TRAP in your research, please cite the following paper:"
title: "TRAP: a temporal systematics model for improved direct detection of exoplanets at small angular separations"
authors:
- family-names: Samland
given-names: Matthias
orcid: https://orcid.org/0000-0001-9992-4067
- family-names: Bouwman
given-names: Jeroen
- family-names: Hogg
given-names: David W.
- family-names: Brandner
given-names: Wolfgang
- family-names: Henning
given-names: Thomas
- family-names: Janson
given-names: Markus
abstract: >
TRAP is a novel algorithm for detecting exoplanets in high-contrast imaging data,
based on modeling temporal systematics. By working in the time domain rather than
the spatial domain, TRAP enables improved detection performance, especially at small
angular separations.
date-released: 2021-02-01
doi: 10.1051/0004-6361/201937308
license: MIT
repository-code: https://github.com/m-samland/trap
keywords:
- astronomy
- exoplanets
- high-contrast imaging
- direct imaging
- data analysis
- temporal modeling
- Python
preferred-citation:
type: article
authors:
- family-names: Samland
given-names: Matthias
- family-names: Bouwman
given-names: Jeroen
- family-names: Hogg
given-names: David W.
- family-names: Brandner
given-names: Wolfgang
- family-names: Henning
given-names: Thomas
- family-names: Janson
given-names: Markus
title: "TRAP: a temporal systematics model for improved direct detection of exoplanets at small angular separations"
journal: Astronomy & Astrophysics
volume: 646
page: A24
year: 2021
doi: 10.1051/0004-6361/201937308
url: https://ui.adsabs.harvard.edu/abs/2021A&A...646A..24S
GitHub Events
Total
- Create event: 4
- Release event: 1
- Issues event: 14
- Delete event: 2
- Issue comment event: 5
- Push event: 32
- Pull request event: 8
Last Year
- Create event: 4
- Release event: 1
- Issues event: 14
- Delete event: 2
- Issue comment event: 5
- Push event: 32
- Pull request event: 8
Dependencies
- astropy *
- bottleneck *
- matplotlib *
- natsort *
- numba *
- numpy *
- pandas *
- photutils *
- ray *
- scikit-learn *
- scipy *
- seaborn *
- species *
- tqdm *