Skip to content

GreeDS algorithm from Pairet etal 2020. Re-implemented to be independent from MAYONNAISE

Notifications You must be signed in to change notification settings

Sand-jrd/GreeDS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 

Repository files navigation

GreeDS

I-PCA (Iterative Principal Component Analysis) tools developed to process ADI cube.

Refactored implementation of the original code from Pairet et al. Can be used independently of the optimization Inverse Problem part (MAYONNAISE) + few fixes such as deprecated packages

Updates :

  • More options such as: choosing starting rank, having an incremental number of iterations per rank, and also output options.
  • NEW: Can be used with references thus leveraging Angular and Reference Differential Imaging Strategy (ARDI).

Install package

Install package with pip:

pip install GreeDS

Usage/Example

This package contains only one function. All necessary information is in the function comments. Follow instructions in the demo or notebooek to test the algorithm with your own datasets.

Import the function:

from GreeDS import GreeDS

Load your dataset and call the function:

from vip_hci.fits import open_fits
cube = open_fits("your_cube.fits")
angles = open_fits("your_PA_angles.fits")

# Optional
ref = open_fits("your_refs.fits")

Set parameters:

r = 10  # Iteration over PCA-rank
l = 10  # Iteration per rank
r_start = 1  # PCA-rank to start iteration (good for faint signals)
pup_size = 3  # Radius of numerical mask to hide coro

Call GreeDS and get your results:

res = GreeDS(cube, angles, r=r, l=l, r_start=r_start, pup=pup_size)

Related

Also check out other packages for Exoplanet/disk direct imaging:

Also see docs about the maths behind the algorithms (GreeDS/MUSTARD) and their comparison:

Feedback/Support

You can contact me by email: sjuillard@uliege.be

About

GreeDS algorithm from Pairet etal 2020. Re-implemented to be independent from MAYONNAISE

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages