v1.4.0
Getting started
TL;DR setup guide
Installation and dependencies
Image conventions
Tutorials
Running the tutorials
1. Quick-start
2. Pre-processing
3. PSF modeling and subtraction
4. Metrics
5. ADI forward modeling of point sources
6. ADI forward modeling of disks
7. ADI+IFS: PSF subtraction and forward modeling
8. Image operations: FFT- vs interpolation-based methods
9. Using Dataset objects
About
Contact
Attribution
Frequently asked questions
Package content
vip_hci package
Index
VIP
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
V
|
W
|
X
A
add_algo() (vip_hci.metrics.roc.EvalRoc method)
andromeda() (in module vip_hci.invprob.andromeda)
aperture_flux() (in module vip_hci.metrics.contrcurve)
approx_stellar_position() (in module vip_hci.preproc.cosmetics)
B
backend (vip_hci.config.utils_conf.Progressbar attribute)
bkg_star_proba() (in module vip_hci.stats.bkg_proba)
byteswap_array() (in module vip_hci.fits.fits)
C
cart_to_pol() (in module vip_hci.var.coords)
cevr_to_ncomp() (vip_hci.psfsub.svd.SVDecomposer method)
chain_zero_truncated() (in module vip_hci.fm.negfc_mcmc)
check_array() (in module vip_hci.config.utils_conf)
check_enough_memory() (in module vip_hci.config.mem)
check_inclination() (vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
check_pa_vector() (in module vip_hci.preproc.parangles)
check_scal_vector() (in module vip_hci.preproc.rescaling)
clip_array() (in module vip_hci.stats.clip_sigma)
collapse() (vip_hci.hci_dataset.Dataset method)
collapse_psf_cube() (in module vip_hci.fm.fakecomp)
completeness_curve() (in module vip_hci.metrics.completeness)
completeness_map() (in module vip_hci.metrics.completeness)
compute_binary_map() (in module vip_hci.metrics.roc)
compute_derot_angles_cd() (in module vip_hci.preproc.parangles)
compute_derot_angles_pa() (in module vip_hci.preproc.parangles)
compute_paral_angles() (in module vip_hci.preproc.parangles)
compute_phase_function_from_cosphi() (vip_hci.fm.scattered_light_disk.Phase_function method)
compute_scattered_light() (vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
compute_statistics_parallel() (vip_hci.invprob.paco.FastPACO method)
compute_tpr_fps() (vip_hci.metrics.roc.EvalRoc method)
confidence() (in module vip_hci.fm.negfc_mcmc)
contrast_curve() (in module vip_hci.metrics.contrcurve)
copy() (vip_hci.hci_dataset.Dataset method)
create_ringed_spider_mask() (in module vip_hci.var.shapes)
create_synth_psf() (in module vip_hci.var.fit_2d)
crop() (vip_hci.hci_dataset.Frame method)
crop_frames() (vip_hci.hci_dataset.Dataset method)
cube_basic_stats() (in module vip_hci.stats.utils_stats)
cube_collapse() (in module vip_hci.preproc.subsampling)
cube_correct_nan() (in module vip_hci.preproc.cosmetics)
cube_crop_frames() (in module vip_hci.preproc.cosmetics)
cube_derotate() (in module vip_hci.preproc.derotation)
cube_detect_badfr_correlation() (in module vip_hci.preproc.badframes)
cube_detect_badfr_ellipticity() (in module vip_hci.preproc.badframes)
cube_detect_badfr_pxstats() (in module vip_hci.preproc.badframes)
cube_distance() (in module vip_hci.stats.distances)
cube_drop_frames() (in module vip_hci.preproc.cosmetics)
cube_filter_highpass() (in module vip_hci.var.filters)
cube_filter_iuwt() (in module vip_hci.var.filters)
cube_filter_lowpass() (in module vip_hci.var.filters)
cube_fix_badpix_annuli() (in module vip_hci.preproc.badpixremoval)
cube_fix_badpix_clump() (in module vip_hci.preproc.badpixremoval)
cube_fix_badpix_ifs() (in module vip_hci.preproc.badpixremoval)
cube_fix_badpix_interp() (in module vip_hci.preproc.badpixremoval)
cube_fix_badpix_isolated() (in module vip_hci.preproc.badpixremoval)
cube_inject_companions() (in module vip_hci.fm.fakecomp)
cube_inject_fakedisk() (in module vip_hci.fm.fakedisk)
cube_inject_trace() (in module vip_hci.fm.fakedisk)
cube_planet_free() (in module vip_hci.fm.utils_negfc)
cube_px_resampling() (in module vip_hci.preproc.rescaling)
cube_recenter_2dfit() (in module vip_hci.preproc.recentering)
cube_recenter_dft_upsampling() (in module vip_hci.preproc.recentering)
cube_recenter_radon() (in module vip_hci.preproc.recentering)
cube_recenter_satspots() (in module vip_hci.preproc.recentering)
cube_recenter_via_speckles() (in module vip_hci.preproc.recentering)
cube_rescaling_wavelengths() (in module vip_hci.preproc.rescaling)
cube_shift() (in module vip_hci.preproc.recentering)
cube_subsample() (in module vip_hci.preproc.subsampling)
cube_subsample_trimmean() (in module vip_hci.preproc.subsampling)
cube_subtract_sky_pca() (in module vip_hci.preproc.skysubtraction)
D
Dataset (class in vip_hci.hci_dataset)
density_cartesian() (vip_hci.fm.scattered_light_disk.Dust_distribution method)
density_cylindrical() (vip_hci.fm.scattered_light_disk.Dust_distribution method)
derotate() (vip_hci.hci_dataset.Dataset method)
descriptive_stats() (in module vip_hci.stats.utils_stats)
detect_blobs() (vip_hci.hci_dataset.Frame method)
detection() (in module vip_hci.metrics.detection)
dist() (in module vip_hci.var.coords)
dist_matrix() (in module vip_hci.var.coords)
drop_frames() (vip_hci.hci_dataset.Dataset method)
Dust_distribution (class in vip_hci.fm.scattered_light_disk)
E
EvalRoc (class in vip_hci.metrics.roc)
F
FastPACO (class in vip_hci.invprob.paco)
filter() (vip_hci.hci_dataset.Dataset method)
(vip_hci.hci_dataset.Frame method)
find_nearest() (in module vip_hci.fm.utils_negfc)
find_scal_vector() (in module vip_hci.preproc.rescaling)
firstguess() (in module vip_hci.fm.negfc_simplex)
firstguess_from_coord() (in module vip_hci.fm.negfc_simplex)
fit_2d2gaussian() (in module vip_hci.var.fit_2d)
fit_2dairydisk() (in module vip_hci.var.fit_2d)
fit_2dgaussian() (in module vip_hci.var.fit_2d)
fit_2dmoffat() (in module vip_hci.var.fit_2d)
fmmf() (in module vip_hci.invprob.fmmf)
Frame (class in vip_hci.hci_dataset)
frame_average_radprofile() (in module vip_hci.stats.im_stats)
frame_basic_stats() (in module vip_hci.stats.utils_stats)
frame_center() (in module vip_hci.var.coords)
frame_center_radon() (in module vip_hci.preproc.recentering)
frame_center_satspots() (in module vip_hci.preproc.recentering)
frame_crop() (in module vip_hci.preproc.cosmetics)
frame_deconvolution() (in module vip_hci.var.filters)
frame_diff() (in module vip_hci.psfsub.framediff)
frame_distances() (vip_hci.hci_dataset.Dataset method)
frame_filter_highpass() (in module vip_hci.var.filters)
frame_filter_lowpass() (in module vip_hci.var.filters)
frame_fix_badpix_fft() (in module vip_hci.preproc.badpixremoval)
frame_fix_badpix_isolated() (in module vip_hci.preproc.badpixremoval)
frame_histo_stats() (in module vip_hci.stats.im_stats)
frame_inject_companion() (in module vip_hci.fm.fakecomp)
frame_pad() (in module vip_hci.preproc.cosmetics)
frame_px_resampling() (in module vip_hci.preproc.rescaling)
frame_report() (in module vip_hci.metrics.snr_source)
frame_rescaling() (in module vip_hci.preproc.rescaling)
frame_rotate() (in module vip_hci.preproc.derotation)
frame_shift() (in module vip_hci.preproc.recentering)
frame_stats() (vip_hci.hci_dataset.Dataset method)
FullPACO (class in vip_hci.invprob.paco)
G
gelman_rubin() (in module vip_hci.fm.utils_mcmc)
gelman_rubin_from_chain() (in module vip_hci.fm.utils_mcmc)
generate_copies_with_injections() (vip_hci.hci_dataset.Dataset method)
generate_cube_copies_with_injections() (in module vip_hci.fm.fakecomp)
generate_matrix() (vip_hci.psfsub.svd.SVDecomposer method)
get_annular_wedge() (in module vip_hci.var.shapes)
get_annulus_segments() (in module vip_hci.var.shapes)
get_available_memory() (in module vip_hci.config.mem)
get_center() (vip_hci.hci_dataset.Frame method)
get_cevr() (vip_hci.psfsub.svd.SVDecomposer method)
get_circle() (in module vip_hci.var.shapes)
get_ell_annulus() (in module vip_hci.var.shapes)
get_ellipse() (in module vip_hci.var.shapes)
get_mu_and_sigma() (in module vip_hci.fm.negfc_fmerit)
get_nbytes() (vip_hci.hci_dataset.Dataset method)
get_square() (in module vip_hci.var.shapes)
H
HCIAndromeda (class in vip_hci.hci_postproc)
HCILLSG (class in vip_hci.hci_postproc)
HCILoci (class in vip_hci.hci_postproc)
HCIMedianSub (class in vip_hci.hci_postproc)
HCIPca (class in vip_hci.hci_postproc)
I
indep_ap_centers() (in module vip_hci.metrics.snr_source)
info_fits() (in module vip_hci.fits.fits)
inject_and_postprocess() (vip_hci.metrics.roc.EvalRoc method)
inject_companions() (vip_hci.hci_dataset.Dataset method)
inverse_stim_map() (in module vip_hci.metrics.stim)
iuwt_decomposition() (in module vip_hci.var.iuwt)
iuwt_recomposition() (in module vip_hci.var.iuwt)
L
llsg() (in module vip_hci.psfsub.llsg)
load_angles() (vip_hci.hci_dataset.Dataset method)
load_wavelengths() (vip_hci.hci_dataset.Dataset method)
M
make_snr_map() (vip_hci.hci_postproc.HCIAndromeda method)
mask_center() (vip_hci.hci_dataset.Dataset method)
mask_circle() (in module vip_hci.var.shapes)
mask_roi() (in module vip_hci.var.shapes)
mask_source_centers() (in module vip_hci.metrics.detection)
mask_sources() (in module vip_hci.metrics.detection)
matrix_scaling() (in module vip_hci.var.shapes)
mcmc_negfc_sampling() (in module vip_hci.fm.negfc_mcmc)
median_sub() (in module vip_hci.psfsub.medsub)
mp_a_trous() (in module vip_hci.var.iuwt)
mp_a_trous_kernel() (in module vip_hci.var.iuwt)
mp_iuwt_decomposition() (in module vip_hci.var.iuwt)
mp_iuwt_recomposition() (in module vip_hci.var.iuwt)
N
nested_negfc_sampling() (in module vip_hci.fm.negfc_nested)
nested_sampling_results() (in module vip_hci.fm.negfc_nested)
nmf() (in module vip_hci.psfsub.nmf_fullfr)
nmf_annular() (in module vip_hci.psfsub.nmf_local)
noise_per_annulus() (in module vip_hci.metrics.contrcurve)
normalize_psf() (in module vip_hci.fm.fakecomp)
(vip_hci.hci_dataset.Dataset method)
O
open_fits() (in module vip_hci.fits.fits)
P
PACOCalc() (vip_hci.invprob.paco.FastPACO method)
(vip_hci.invprob.paco.FullPACO method)
pca() (in module vip_hci.psfsub.pca_fullfr)
pca_annular() (in module vip_hci.psfsub.pca_local)
pca_annulus() (in module vip_hci.psfsub.utils_pca)
pca_grid() (in module vip_hci.psfsub.utils_pca)
peak_coordinates() (in module vip_hci.metrics.detection)
Phase_function (class in vip_hci.fm.scattered_light_disk)
plot() (vip_hci.hci_dataset.Dataset method)
(vip_hci.hci_dataset.Frame method)
plot_detmaps() (vip_hci.metrics.roc.EvalRoc method)
plot_phase_function() (vip_hci.fm.scattered_light_disk.Phase_function method)
plot_roc_curves() (vip_hci.metrics.roc.EvalRoc method)
pol_to_cart() (in module vip_hci.var.coords)
pol_to_eq() (in module vip_hci.var.coords)
prepare_matrix() (in module vip_hci.var.shapes)
print_info() (vip_hci.fm.scattered_light_disk.Dust_distribution method)
(vip_hci.fm.scattered_light_disk.Phase_function method)
(vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
Progressbar (class in vip_hci.config.utils_conf)
Q
QU_to_QUphi() (in module vip_hci.var.coords)
R
radial_profile() (vip_hci.hci_dataset.Frame method)
recenter() (vip_hci.hci_dataset.Dataset method)
(vip_hci.hci_dataset.Frame method)
remove_badframes() (vip_hci.hci_dataset.Dataset method)
rescale() (vip_hci.hci_dataset.Dataset method)
(vip_hci.hci_dataset.Frame method)
reshape_matrix() (in module vip_hci.var.shapes)
rotate() (vip_hci.hci_dataset.Frame method)
rotate_fft() (in module vip_hci.preproc.derotation)
run() (vip_hci.hci_postproc.HCIAndromeda method)
(vip_hci.hci_postproc.HCILLSG method)
(vip_hci.hci_postproc.HCILoci method)
(vip_hci.hci_postproc.HCIMedianSub method)
(vip_hci.hci_postproc.HCIPca method)
(vip_hci.psfsub.svd.SVDecomposer method)
S
scale_fft() (in module vip_hci.preproc.rescaling)
ScatteredLightDisk (class in vip_hci.fm.scattered_light_disk)
ser_a_trous() (in module vip_hci.var.iuwt)
ser_iuwt_decomposition() (in module vip_hci.var.iuwt)
ser_iuwt_recomposition() (in module vip_hci.var.iuwt)
set() (vip_hci.config.utils_conf.Progressbar method)
set_density_distribution() (vip_hci.fm.scattered_light_disk.Dust_distribution method)
(vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
set_flux_max() (vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
set_inclination() (vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
set_omega() (vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
set_pa() (vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
set_phase_function() (vip_hci.fm.scattered_light_disk.ScatteredLightDisk method)
shift() (vip_hci.hci_dataset.Frame method)
show_corner_plot() (in module vip_hci.fm.negfc_mcmc)
show_walk_plot() (in module vip_hci.fm.negfc_mcmc)
sigma_filter() (in module vip_hci.stats.clip_sigma)
significance() (in module vip_hci.metrics.snr_source)
snr() (in module vip_hci.metrics.snr_source)
(vip_hci.hci_dataset.Frame method)
snrmap() (in module vip_hci.metrics.snr_source)
speckle_noise_uncertainty() (in module vip_hci.fm.negfc_speckle_noise)
spectral_correlation() (in module vip_hci.stats.distances)
stats() (vip_hci.hci_dataset.Frame method)
stim_map() (in module vip_hci.metrics.stim)
subsample() (vip_hci.hci_dataset.Dataset method)
SVDecomposer (class in vip_hci.psfsub.svd)
T
thresholding() (in module vip_hci.psfsub.llsg)
throughput() (in module vip_hci.metrics.contrcurve)
time_fin() (in module vip_hci.config.timing)
time_ini() (in module vip_hci.config.timing)
timing() (in module vip_hci.config.timing)
V
verify_fits() (in module vip_hci.fits.fits)
vip_hci (module)
vip_hci.config (module)
vip_hci.config.mem (module)
vip_hci.config.param (module)
vip_hci.config.timing (module)
vip_hci.config.utils_conf (module)
vip_hci.fits (module)
vip_hci.fits.fits (module)
vip_hci.fm (module)
vip_hci.fm.fakecomp (module)
vip_hci.fm.fakedisk (module)
vip_hci.fm.negfc_fmerit (module)
vip_hci.fm.negfc_mcmc (module)
vip_hci.fm.negfc_nested (module)
vip_hci.fm.negfc_simplex (module)
vip_hci.fm.negfc_speckle_noise (module)
vip_hci.fm.scattered_light_disk (module)
vip_hci.fm.utils_mcmc (module)
vip_hci.fm.utils_negfc (module)
vip_hci.hci_dataset (module)
vip_hci.hci_postproc (module)
vip_hci.invprob (module)
vip_hci.invprob.andromeda (module)
vip_hci.invprob.fmmf (module)
vip_hci.invprob.paco (module)
vip_hci.invprob.utils_andro (module)
vip_hci.metrics (module)
vip_hci.metrics.completeness (module)
vip_hci.metrics.contrcurve (module)
vip_hci.metrics.detection (module)
vip_hci.metrics.roc (module)
vip_hci.metrics.snr_source (module)
vip_hci.metrics.stim (module)
vip_hci.preproc (module)
vip_hci.preproc.badframes (module)
vip_hci.preproc.badpixremoval (module)
vip_hci.preproc.cosmetics (module)
vip_hci.preproc.derotation (module)
vip_hci.preproc.parangles (module)
vip_hci.preproc.recentering (module)
vip_hci.preproc.rescaling (module)
vip_hci.preproc.skysubtraction (module)
vip_hci.preproc.subsampling (module)
vip_hci.psfsub (module)
vip_hci.psfsub.framediff (module)
vip_hci.psfsub.llsg (module)
vip_hci.psfsub.loci (module)
vip_hci.psfsub.medsub (module)
vip_hci.psfsub.nmf_fullfr (module)
vip_hci.psfsub.nmf_local (module)
vip_hci.psfsub.pca_fullfr (module)
vip_hci.psfsub.pca_local (module)
vip_hci.psfsub.svd (module)
vip_hci.psfsub.utils_pca (module)
vip_hci.stats (module)
vip_hci.stats.bkg_proba (module)
vip_hci.stats.clip_sigma (module)
vip_hci.stats.distances (module)
vip_hci.stats.im_stats (module)
vip_hci.stats.utils_stats (module)
vip_hci.var (module)
vip_hci.var.coords (module)
vip_hci.var.filters (module)
vip_hci.var.fit_2d (module)
vip_hci.var.iuwt (module)
vip_hci.var.shapes (module)
vip_hci.vip_ds9 (module)
W
write_fits() (in module vip_hci.fits.fits)
X
xloci() (in module vip_hci.psfsub.loci)
Read the Docs
v: v1.4.0
Versions
latest
v1.4.0
v1.1.1
v1.0.0
v0.9.11
v0.8.8
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.