FELINE
FELINE: A Tool to Detect Emission Line Galaxies in 3D Data - Published in JOSS (2025)
Science Score: 100.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 1 DOI reference(s) in JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
4 of 9 committers (44.4%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
FindEmissionLINEs
Basic Info
- Host: GitHub
- Owner: enthusi
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Homepage: https://feline.readthedocs.io/en/latest/
- Size: 5.62 MB
Statistics
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 0
- Releases: 2
Metadata Files
README.md
Feline (Find Emission Lines)
Project Overview
Feline combines a fully parallelized galaxy line template matching with the matched filter approach for individual emission features of LSDcat. For the 3D matched filtering, the complete data cube is first median filtered to remove all continuum sources, and then cross-correlated with a template of an isolated emission feature in two spatial and one spectral dimension. We assumed a simple Gaussian with a FWHM of $250 \ \rm{km}/\rm{s}$ for the line profile and a PSF based on the given seeing in the data cube. The FELINE algorithm then evaluates the likelihood in each spectrum of the cube for emission lines at the positions provided by a given redshift and a certain combination of typical emission features. FELINE probes all possible combinations of up to 14 transitions paired in 9 groups: $\rm{H}\alpha, \rm{H}\beta, \rm{H}\gamma, \rm{H}\delta$, $\rm{[OII]}$, $\rm{[OIII]}$, $\rm{[NII]}$, $\rm{[SII]}$, and $\rm{[NeIII]}$ for the redshift range of interest $(0.4 < z < 1.4)$. This particular selection of lines is motivated by the most prominent emission features expected in the MUSE data within this redshift range. This results in $512 \ (2^9)$ different models that are assessed at roughly $8,000$ different redshifts for each of the approx $90,000$ spectra in a single data cube. To ensure that only lines above a certain $\rm{S}\rm{N}$ threshold contribute to each model, a penalty value is subtracted for each additional line. The $\rm{S}/\rm{N}$ near strong sky lines are set exactly to that threshold. Hence lines that fall onto such a contaminated region will not affect model quality. This is particularly useful for doublet lines that then contribute to a model even when one of the lines aligns with a skyline. Furthermore, the $\rm{S}/\rm{N}$ is saturated at a certain threshold to limit the impact of extremely strong lines on the overall budget of the tested template. For each spaxel the model with the highest accumulative probability over all contributing lines and its corresponding redshift are determined. This approach has the benefit to pick up extremely weak emitters that show multiple emissions lines while avoiding the deluge of false positives when looking for single lines below a certain $\rm{S}/\rm{N}$ threshold.
This can be applied to each spatial element independently and was thus fully parallelized. From the resulting spatial map of best model probabilities, the peaks were automatically selected via maximum filter and 1D spectra were extracted for each emission line galaxy candidate. The extracted spectra are fitted using an emission-line galaxy template, where the redshift and individual line strengths are the only free parameters. This fitting process achieves sub-pixel accuracy in the initial redshift estimate while also providing additional diagnostic parameters, such as the $\rm{[OII]}$ doublet ratio, to aid in subsequent manual inspection.
Installation
FELINE requires specific software dependencies for installation and operation. Please follow the instructions below to set up FELINE:
Prerequisites
To clone the repository with ssh run the following command:
bash
git clone git@github.com:enthusi/feline.git
Ensure the following software is installed on your system:
bash
python3.x (3.8 or higher)
python3.x-dev
python3.x-venv
clang (recommended due to a significant performance boost compared to gcc) or gcc
SDL2 (Optional: Needed for graphical output during runtime)
[!NOTE] macOS users: If you use
clang, make sure nativeclangis installed (brew install clang) since Apple's Clang doesn't supportopenmp. Secondly, you needlibomp, e.g.,brew install libomp. \ For users who want to usegcc, only need to adjust the following Makefile lines: \[1] CC = gcc-<version>\[2] CFLAGS = -O3 -ffast-math -fopenmp -g -std=c99Linux users (Debian/Ubuntu): If you use
clang, you only need to installlibomp-dev, e.g.,apt install libomp-dev. \ For users who want to usegcc, only need to adjust the following Makefile lines: \[1] CC = gcc\[2] CFLAGS = -O3 -ffast-math -fopenmp -g -std=c99
Usage Guide
For further information see our Documentation Website.
Contribution Guidelines
We Welcome everyone who wants to Contribute to our Project Code of Conduct and Contribution Guidelines.
Acknowledgments
We would like to acknowledge the use of the LSDCat (Line Source Detection and Cataloguing Tool) project for our preprocessing steps. The LSDCat project was developed by Edmund Christian Herenz and has been instrumental in our data analysis.
For more information about LSDCat, please visit the LSDCat project page.
Owner
- Name: Martin Wendt
- Login: enthusi
- Kind: user
- Website: http://martinwendt.de
- Repositories: 3
- Profile: https://github.com/enthusi
Martin Wendt
JOSS Publication
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Wendt
given-names: Martin
affiliation: University of Potsdam
orcid: https://orcid.org/0000-0001-5020-9994
- family-names: Henschel
given-names: Marvin
affiliation: University of Potsdam
orcid: https://orcid.org/0009-0000-9462-433X
- family-names: Soth
given-names: "Oskar Fjonn"
affiliation: University of Potsdam
orcid: https://orcid.org/0009-0004-1200-9130
title: "FELINE: A Tool to Detect Emission Line Galaxies in 3D Data"
version: 1.1.0
doi: 10.21105/joss.07528
date-released: 2024-09-12
GitHub Events
Total
- Create event: 4
- Release event: 1
- Issues event: 21
- Watch event: 3
- Delete event: 2
- Issue comment event: 9
- Push event: 154
- Pull request event: 28
- Fork event: 3
Last Year
- Create event: 4
- Release event: 1
- Issues event: 21
- Watch event: 3
- Delete event: 2
- Issue comment event: 9
- Push event: 154
- Pull request event: 28
- Fork event: 3
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Oskar Soth | 1****h | 262 |
| marvin | m****l@u****e | 130 |
| Martin Wendt | m****t@g****e | 66 |
| Oskar Soth | o****h@u****e | 31 |
| Martin Wendt | c****4@e****e | 3 |
| Warrick Ball | w****l@g****m | 2 |
| Ivelina Momcheva | i****a@g****m | 2 |
| Simon Mutch | s****h@u****u | 1 |
| enthusi | m****t@g****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 15
- Total pull requests: 31
- Average time to close issues: 13 days
- Average time to close pull requests: about 8 hours
- Total issue authors: 3
- Total pull request authors: 5
- Average comments per issue: 1.0
- Average comments per pull request: 0.19
- Merged pull requests: 31
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 10
- Pull requests: 30
- Average time to close issues: 12 days
- Average time to close pull requests: about 8 hours
- Issue authors: 3
- Pull request authors: 5
- Average comments per issue: 1.0
- Average comments per pull request: 0.2
- Merged pull requests: 30
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- osoth (7)
- bronreichardtchu (5)
- smutch (2)
Pull Request Authors
- osoth (12)
- brain-coder (11)
- ivastar (4)
- smutch (2)
- warrickball (2)
