latest
Getting Started
TL;DR Setup Guide
Installation and Dependencies
Tutorials
Tutorial Notebooks
Tutorial for NIRCam coronagraphy reduction with spaceKLIP
Tutorial for MIRI coronagraphy reduction with spaceKLIP
Tutorial for NIRCam post-pipeline contrast analyses using spaceKLIP
Tutorial for MIRI post-pipeline contrast analyses
MAST query and download tools for coronagraphic datasets
spaceKLIP Functionality (Unfinished)
Stage 1
Stage 2
Image Tools
PSF Subtraction
Analysis Tools
About
Contact
Attribution
Package content
Detailed spaceKLIP API
Index
spaceKLIP
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
A
align_frames() (spaceKLIP.imagetools.ImageTools method)
alignlsq() (in module spaceKLIP.utils)
AnalysisTools (class in spaceKLIP.analysistools)
annotate_compass() (in module spaceKLIP.plotting)
annotate_scale_bar() (in module spaceKLIP.plotting)
annotate_secondary_axes_arcsec() (in module spaceKLIP.plotting)
apply_rateint_outliers() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
B
bandpass (spaceKLIP.psf.JWST_PSF property)
blur_frames() (spaceKLIP.imagetools.ImageTools method)
C
calibrate_contrast() (spaceKLIP.analysistools.AnalysisTools method)
chisqr_red() (in module spaceKLIP.utils)
class_alias (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP attribute)
(spaceKLIP.coron2pipeline.Coron2Pipeline_spaceKLIP attribute)
coadd_frames() (spaceKLIP.imagetools.ImageTools method)
compModern() (in module spaceKLIP.plotting)
Coron1Pipeline_spaceKLIP (class in spaceKLIP.coron1pipeline)
Coron2Pipeline_spaceKLIP (class in spaceKLIP.coron2pipeline)
Coron3Pipeline_spaceKLIP (class in spaceKLIP.coron3pipeline)
create_database() (in module spaceKLIP.database)
crop_frames() (spaceKLIP.imagetools.ImageTools method)
crop_image() (in module spaceKLIP.utils)
cube_fit() (in module spaceKLIP.utils)
cube_outlier_detection() (in module spaceKLIP.utils)
D
Database (class in spaceKLIP.database)
display_coron_dataset() (in module spaceKLIP.plotting)
display_coron_image() (in module spaceKLIP.plotting)
do_pseudo_refpix() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
do_refpix() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
do_saturation() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
download_files() (in module spaceKLIP.mast)
E
extract_companions() (spaceKLIP.analysistools.AnalysisTools method)
F
filter (spaceKLIP.psf.JWST_PSF property)
find_bad_pixels_bpclean() (spaceKLIP.imagetools.ImageTools method)
find_bad_pixels_custom() (spaceKLIP.imagetools.ImageTools method)
find_nircam_centers() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels_dqmed() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels_medfilt() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels_timemed() (spaceKLIP.imagetools.ImageTools method)
fov_pix (spaceKLIP.psf.JWST_PSF property)
G
gen_offsetpsf() (in module spaceKLIP.psf)
gen_psf() (spaceKLIP.psf.JWST_PSF method)
gen_psf_idl() (spaceKLIP.psf.JWST_PSF method)
get_dqmask() (in module spaceKLIP.utils)
get_filter_info() (in module spaceKLIP.utils)
get_mast_filename() (in module spaceKLIP.mast)
get_nrcmask_from_apname() (in module spaceKLIP.utils)
get_offsetpsf() (in module spaceKLIP.psf)
get_pyklip_filepaths() (in module spaceKLIP.pyklippipeline)
get_stellar_magnitudes() (in module spaceKLIP.starphot)
get_tp_comsubst() (in module spaceKLIP.utils)
get_transmission() (in module spaceKLIP.psf)
H
hpf() (spaceKLIP.imagetools.ImageTools method)
I
image_mask (spaceKLIP.psf.JWST_PSF property)
ImageTools (class in spaceKLIP.imagetools)
imshift() (in module spaceKLIP.utils)
inject_and_recover() (in module spaceKLIP.analysistools)
interpret_dq_value() (in module spaceKLIP.utils)
J
JWST_PSF (class in spaceKLIP.psf)
L
load_plt_style() (in module spaceKLIP.plotting)
M
make_asn_file() (in module spaceKLIP.coron3pipeline)
module
spaceKLIP
spaceKLIP.analysistools
spaceKLIP.classpsfsubpipeline
spaceKLIP.coron1pipeline
spaceKLIP.coron2pipeline
spaceKLIP.coron3pipeline
spaceKLIP.database
spaceKLIP.imagetools
spaceKLIP.mast
spaceKLIP.plotting
spaceKLIP.psf
spaceKLIP.pyklippipeline
spaceKLIP.starphot
spaceKLIP.utils
N
name (spaceKLIP.psf.JWST_PSF property)
O
oversample (spaceKLIP.psf.JWST_PSF property)
P
pad_frames() (spaceKLIP.imagetools.ImageTools method)
plot_chains() (in module spaceKLIP.plotting)
plot_contrast_calibrated() (in module spaceKLIP.plotting)
plot_contrast_images() (in module spaceKLIP.plotting)
plot_contrast_raw() (in module spaceKLIP.plotting)
plot_fm_psf() (in module spaceKLIP.plotting)
plot_injected_locs() (in module spaceKLIP.plotting)
plot_subimages() (in module spaceKLIP.plotting)
print_obs() (spaceKLIP.database.Database method)
print_red() (spaceKLIP.database.Database method)
print_src() (spaceKLIP.database.Database method)
process() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
(spaceKLIP.coron2pipeline.Coron2Pipeline_spaceKLIP method)
pupil_mask (spaceKLIP.psf.JWST_PSF property)
Q
query_coron_datasets() (in module spaceKLIP.mast)
R
raw_contrast() (spaceKLIP.analysistools.AnalysisTools method)
read_jwst_s012_data() (spaceKLIP.database.Database method)
read_jwst_s3_data() (spaceKLIP.database.Database method)
read_jwst_s4_data() (spaceKLIP.database.Database method)
read_msk() (in module spaceKLIP.utils)
read_obs() (in module spaceKLIP.utils)
read_red() (in module spaceKLIP.utils)
read_spec_file() (in module spaceKLIP.starphot)
recenter_frames() (spaceKLIP.imagetools.ImageTools method)
recenter_jens() (in module spaceKLIP.psf)
recenterlsq() (in module spaceKLIP.utils)
remove_frames() (spaceKLIP.imagetools.ImageTools method)
replace_nans() (spaceKLIP.imagetools.ImageTools method)
rth_to_xy() (spaceKLIP.psf.JWST_PSF method)
run_obs() (in module spaceKLIP.classpsfsubpipeline)
(in module spaceKLIP.coron1pipeline)
(in module spaceKLIP.coron2pipeline)
(in module spaceKLIP.coron3pipeline)
(in module spaceKLIP.pyklippipeline)
run_single_file() (in module spaceKLIP.coron1pipeline)
(in module spaceKLIP.coron2pipeline)
run_step() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
S
set_params() (in module spaceKLIP.mast)
set_surrounded_pixels() (in module spaceKLIP.utils)
setup_output() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
spaceKLIP
module
spaceKLIP.analysistools
module
spaceKLIP.classpsfsubpipeline
module
spaceKLIP.coron1pipeline
module
spaceKLIP.coron2pipeline
module
spaceKLIP.coron3pipeline
module
spaceKLIP.database
module
spaceKLIP.imagetools
module
spaceKLIP.mast
module
spaceKLIP.plotting
module
spaceKLIP.psf
module
spaceKLIP.pyklippipeline
module
spaceKLIP.starphot
module
spaceKLIP.utils
module
spec (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP attribute)
(spaceKLIP.coron2pipeline.Coron2Pipeline_spaceKLIP attribute)
subtract_background() (spaceKLIP.imagetools.ImageTools method)
subtract_median() (spaceKLIP.imagetools.ImageTools method)
subtractlsq() (in module spaceKLIP.utils)
summarize() (spaceKLIP.database.Database method)
T
tickFont() (in module spaceKLIP.plotting)
U
update_nircam_centers() (spaceKLIP.imagetools.ImageTools method)
update_obs() (spaceKLIP.database.Database method)
update_src() (spaceKLIP.database.Database method)
use_coeff (spaceKLIP.psf.JWST_PSF property)
W
write_fitpsf_images() (in module spaceKLIP.utils)
write_msk() (in module spaceKLIP.utils)
write_obs() (in module spaceKLIP.utils)
write_starfile() (in module spaceKLIP.utils)
Read the Docs
v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds