vortex-exoplanet / VIP

VIP is a python package/library for angular, reference star and spectral differential imaging for exoplanet/disk detection through high-contrast imaging.
http://vip.readthedocs.io/
MIT License
70 stars 57 forks source link

Replacement of sci_cube_skysub with DIKL #629

Closed Sand-jrd closed 5 months ago

Sand-jrd commented 5 months ago

Replacement the content of sci_cube_skysub with the DIKL procedure as explained in [REN23].

In pca_fullfr, the mask_rdi has been (re)-added to _adi_rdi_pca and is used along with sci_cube_skysub when it is provided. If not, it follows the procedure in place.

The argument mask_rdi in docstring has been updated accordingly and reference to [REN23] have been added.

Exemple :

To create masks

from vip_hci.var import get_annulus_segments
import numpy as np

ones= np.ones((350,350))
coro = 8
cring_out = 110
cring_in = 70

boat = get_annulus_segments(ones,coro,cring_out-coro, mode="mask")[0]
anchor = get_annulus_segments(ones,cring_in,cring_out-cring_in, mode="mask")[0]
image

Usage with pca

from vip_hci.psfsub import pca
res = pca(cube, angles, ref, mask_rdi=(anchor, boat), ncomp=2)
image
codecov-commenter commented 5 months ago

Codecov Report

Attention: Patch coverage is 55.33981% with 46 lines in your changes are missing coverage. Please review.

Project coverage is 52.13%. Comparing base (d9f1bef) to head (3a9bbf6).

Files Patch % Lines
vip_hci/psfsub/pca_fullfr.py 35.00% 26 Missing :warning:
vip_hci/preproc/skysubtraction.py 68.25% 20 Missing :warning:

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #629 +/- ## ========================================== + Coverage 51.88% 52.13% +0.25% ========================================== Files 87 87 Lines 16365 16404 +39 ========================================== + Hits 8490 8551 +61 + Misses 7875 7853 -22 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

VChristiaens commented 5 months ago

Thanks @Sand-jrd !