ADI.jl
ADI.jl: A Julia Package for High-Contrast Imaging - Published in JOSS (2020)
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 3 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
✓Committers with academic emails
1 of 8 committers (12.5%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Keywords from Contributors
Repository
Algorithms for performing angular differential imaging (ADI)
Basic Info
- Host: GitHub
- Owner: JuliaHCI
- License: mit
- Language: Julia
- Default Branch: main
- Homepage: https://juliahci.github.io/ADI.jl/dev/
- Size: 67.3 MB
Statistics
- Stars: 6
- Watchers: 1
- Forks: 7
- Open Issues: 3
- Releases: 22
Topics
Metadata Files
README.md
ADI.jl
A package for angular differential imaging (ADI) post-processing algorithms.
Installation
ADI.jl is a registered package and can be installed using the Julia package manager. From the Julia REPL, enter Pkg mode (by pressing ])
```julia julia>]
(@v1.5) pkg> add ADI ```
To exit Pkg mode, just backspace. Once the package is installed it can be imported with
julia
julia> using ADI
To exit Pkg mode, just backspace. Once the package is installed it can be imported with For more information, see the Pkg documentation.
Citations
If you use ADI.jl or derivatives in your work, please consider citing both the JOSS paper and the code record. The JOSS paper citation can be found in CITATION.bib. The code will have a unique reference for each released version, so visit the Zenodo record to grab the BibTeX for whichever version you used.
Usage
The following is an extremely brief PCA reduction of an ADI cube. Please see the documentation for further usage, tutorials, and api reference.
```julia julia> using ADI
julia> cube, angles = # load data
julia> alg = PCA(ncomps=10)
julia> flat_resid = alg(cube, angles) # ADI
julia> flatresidrdi = alg(cube, angles; ref=cube_ref) # flexible RDI ```
get the S/N and significance
```julia julia> fwhm = # PSF fwhm in pixels
julia> snmap = detectionmap(snr, flat_residual, fwhm)
julia> sigmap = detectionmap(significance, flat_residual, fwhm) ```
get the contrast curve
```julia julia> psf = # load psf or choose from HCIToolbox.Kernels
julia> cc = contrast_curve(alg, cube, angles, psf; fwhm=fwhm) ```
which can be easily loaded into a DataFrame or anything adopting the Tables.jl interface.
```julia julia> using DataFrames
julia> df = DataFrame(cc)
julia> first(df, 5) ```
Contributing and Support
In general contributions should follow ColPrac. If you are interested in extending/improving ADI.jl, head to the discussions to reach out. For support with using ADI.jl, please open an issue describing the problem and steps to reproduce it.
License
This package is licensed under the MIT Expat license. See LICENSE for more information.
Author's Note: This package is still under active development and is subject to change. Anything from minor behind-the-scenes details to large-scale design can change as I incorporate more methods into ADI.jl. I don't plan on spending much time with deprecation warnings throughout this process, since that limits my ability to experiment with implementation ideas and design goals. This package follows semantic versioning, so an upgrade from 0.6 to 0.7 may be breaking and I recommend anybody using this package to browse the release notes for changes. Once ADI.jl is somewhat stable, I'll release a version 1.0, at which point I'll worry about deprecations and other long-term usability considerations.
Owner
- Name: JuliaHCI
- Login: JuliaHCI
- Kind: organization
- Repositories: 8
- Profile: https://github.com/JuliaHCI
An organization for high-contrast imaging using Julia.
JOSS Publication
ADI.jl: A Julia Package for High-Contrast Imaging
Authors
Institute for Astronomy, University of Hawai'i
Institute for Astronomy, University of Hawai'i
Editor
Dan Foreman-Mackey
Tags
astronomy high-contrast imaging direct imaging image processingCitation (CITATION.bib)
% JOSS paper
@article{Lucas2020,
doi = {10.21105/joss.02843},
url = {https://doi.org/10.21105/joss.02843},
year = {2020},
publisher = {The Open Journal},
volume = {5},
number = {56},
pages = {2843},
author = {Miles Lucas and Michael Bottom},
title = {ADI.jl: A Julia Package for High-Contrast Imaging},
journal = {Journal of Open Source Software}
}
GitHub Events
Total
- Fork event: 1
Last Year
- Issue comment event: 1
- Pull request event: 1
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Miles Lucas | m****s@h****u | 323 |
| github-actions[bot] | 4****] | 16 |
| dependabot[bot] | 4****] | 4 |
| Dan Foreman-Mackey | f****y@g****m | 3 |
| Mosè Giordano | g****o | 3 |
| scexao6 | s****6@n****g | 2 |
| Jason Wang | j****g@o****m | 1 |
| Breandan McClure | b****e@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 10
- Total pull requests: 54
- Average time to close issues: 5 days
- Average time to close pull requests: 9 days
- Total issue authors: 4
- Total pull request authors: 9
- Average comments per issue: 3.7
- Average comments per pull request: 0.81
- Merged pull requests: 36
- Bot issues: 0
- Bot pull requests: 16
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.5
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- giordano (5)
- semaphoreP (2)
- mileslucas (2)
- JuliaTagBot (1)
Pull Request Authors
- mileslucas (31)
- github-actions[bot] (12)
- dependabot[bot] (4)
- giordano (2)
- icweaver (1)
- semaphoreP (1)
- jsnguyen (1)
- dfm (1)
- breandanmcclure (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 22
juliahub.com: ADI
Algorithms for performing angular differential imaging (ADI)
- Homepage: https://juliahci.github.io/ADI.jl/dev/
- Documentation: https://docs.juliahub.com/General/ADI/stable/
- License: MIT
-
Latest release: 0.9.0
published almost 3 years ago
Rankings
Dependencies
- vip-hci ==0.9.11
- JuliaRegistries/TagBot v1 composite
- actions/cache v1 composite
- actions/checkout v2 composite
- codecov/codecov-action v1 composite
- julia-actions/cache v1 composite
- julia-actions/julia-buildpkg latest composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-docdeploy releases/v1 composite
- julia-actions/julia-processcoverage v1 composite
- julia-actions/julia-runtest latest composite
- julia-actions/setup-julia v1 composite
- actions/checkout v2 composite
- julia-actions/RegisterAction latest composite