Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.83 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.83 KB

LuckyImaging.jl

Build Status PkgEval Coverage License

Stable Dev

Installation

To use the LuckyImaging library, first install it using Pkg

julia> ]add LuckyImaging

Usage

To import the library

using LuckyImaging

then, load a data cube

cube = # ...

we can use lucky_image as an entry point to both classic and Fourier lucky imaging methods

image = lucky_image(cube; dims=3, q=0.9, alg=:classic, register=:peak)
imagef = lucky_image(cube; dims=3, q=0.5, alg=:fourier, upsample_factor=10)

see the docstrings for classic_lucky_image and fourier_lucky_image for more information on the algorithms and their options.

Contributing and Support

If you would like to contribute, feel free to open a pull request. If you want to discuss something before contributing, head over to discussions and join or open a new topic. If you're having problems with something, please open an issue.