jemorrison/vip_extras

Datacubes, Jupyter tutorials and other materials related to VIP (https://github.com/vortex-exoplanet/VIP)

VIP extras

additional material for VIP

Tutorials

Tutorials in form of Jupyter notebooks can be found in the tutorials/ folder. They can be visualized directly here on GitHub (by just clicking on them), or using the nbviewer service.

01. Quick-start Tutorial

GitHub / nbviewer / binder

This tutorial covers:

• how to load ADI-ready datacubes;
• how to use some of the stellar PSF subtraction algorithms implemented in VIP to produce final post-processed images.

02. Pre-processing Tutorial

GitHub / nbviewer / binder

This tutorial showcases the pre-processing routines available routines in VIP (i.e. how to prepare a datacube before PSF modeling and subtraction). More specifically, the tutorial shows how to carry out the following tasks:

• recentering of a NACO L' coronagraphic dataset and trimming bad frames out;
• correcting bad pixels and recentering a SPHERE/IFS coronagraphic dataset;
• performing a "full pre-processing" of a non-coronagraphic SINFONI dataset.

03. PSF modeling and subtraction Tutorial

GitHub / nbviewer / binder

This tutorial covers:

• how to load ADI-ready datacubes;
• how to use the stellar PSF subtraction algorithms implemented in VIP to produce final post-processed images (more details and higher completeness than the quick-start tutorial).

04. Metrics Tutorial

GitHub / nbviewer / binder

This tutorial covers:

• how to compute the S/N ratio of a given companion candidate;
• how to calculate the significance of a detection;
• how to compute S/N ratio maps and STIM maps;
• how to use the automatic point-source detection function;
• how to compute throughput and contrast curves.

05. Forward modeling of point sources Tutorial

GitHub / nbviewer / binder

This tutorial covers:

• how to generate and inject fake companions in a cube;
• how to estimate the astrometry and photometry of a directly imaged companion, and associated uncertainties.

06. Forward modeling of disk Tutorial

GitHub / nbviewer / binder

This tutorial covers:

• how to generate different models of synthetic (debris) disks;
• how to inject model disks in ADI cubes, for forward modeling.

07. IFS+ADI PSF subtraction and forward modeling Tutorial

GitHub / nbviewer / binder

This tutorial covers:

• how to inject a planet spectrum in a 4D (IFS+ADI) datacube;
• how to post-process 4D (IFS+ADI) datacubes;
• how to retrieve the parameters of a planet present in a 4D (IFS+ADI) datacube (astro- and spectrometry).

08. FFT-based vs. interpolation-based image operations Tutorial

GitHub / nbviewer / binder

This tutorial shows a quantitative comparison between FFT-based and interpolation-based methods for:

• image rotations;
• image scaling;
• sub-px shifts.

09. Dataset Objects Tutorial

GitHub / nbviewer / binder

This tutorial gives an overview of the new object oriented way of using VIP.

Datasets

The datasets in the datasets/ folder are available in FITS format, with the fully pre-processed (ADI-ready) datasets also available in VIP's own Dataset format (as .npz).

NACO betapic

Small ADI cube with 39 frames. naco_betapic.npz contains just the "raw" data (cube, psf, angles, px_scale), while naco_betapic_preproc.npz is slightly preprocessed (cropped, psf normalized).

SPHERE v471tau

ADI+IFS (4D) cube, ideal to test both ADI and SDI functionalities. The cube, psf images, derotation angles and wavelength vector are provided.

SPHERE PDS 70

ADI+IFS (4D) center cube, ideal to test recentering of SPHERE/IFS data. The center cube, psf images, and wavelength vector are provided.

SINFONI HD 179218

IFS (3D) cube, ideal to test preprocessing and SDI functionalities. The cube and wavelength vector are provided.