Getting Started
TL;DR Setup Guide
Installation and Dependencies
Recommendations and Best Practices
Tutorials
Tutorial Notebooks
spaceKLIP Functionality (Unfinished)
Stage 1
Stage 2
Image Tools
PSF Subtraction
Analysis Tools
About
Contact
Attribution
Package content
Detailed spaceKLIP API
spaceKLIP
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
A
adjust_dir() (spaceKLIP.database.Database method)
adjust_spttype() (in module spaceKLIP.psflib)
align_frames() (spaceKLIP.imagetools.ImageTools method)
alignlsq() (in module spaceKLIP.utils)
all_logging_disabled() (in module spaceKLIP.logging_tools)
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_masking_prechecks() (in module spaceKLIP.coron1pipeline)
apply_rateint_outliers() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
average_channels() (spaceKLIP.fnoise_clean.CleanFullFrame method)
B
bandpass (spaceKLIP.psf.JWST_PSF property)
best_convfit_and_residuals() (in module spaceKLIP.analysistools)
bg_minimize() (in module spaceKLIP.utils)
bg_subtract() (spaceKLIP.fnoise_clean.CleanSubarray method)
blur_frames() (spaceKLIP.imagetools.ImageTools method)
build_refdb() (in module spaceKLIP.psflib)
C
calc_bias() (spaceKLIP.expjumpramp.Covar method)
calculate_alignment() (spaceKLIP.imagetools.ImageTools method)
calculate_centers() (spaceKLIP.imagetools.ImageTools method)
calculate_centers_binary() (spaceKLIP.imagetools.ImageTools method)
calibrate_contrast() (spaceKLIP.analysistools.AnalysisTools method)
channel_smooth_savgol() (in module spaceKLIP.fnoise_clean)
chisqr_red() (in module spaceKLIP.utils)
class_alias (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP attribute)
(spaceKLIP.coron1pipeline.MaskGroupsStep attribute)
(spaceKLIP.coron2pipeline.Coron2Pipeline_spaceKLIP attribute)
(spaceKLIP.expjumpramp.ExperimentalJumpRampStep attribute)
(spaceKLIP.fnoise_clean.kTCSubtractStep attribute)
(spaceKLIP.fnoise_clean.OneOverfStep attribute)
clean() (spaceKLIP.fnoise_clean.CleanFullFrame method)
(spaceKLIP.fnoise_clean.CleanSubarray method)
clean_background() (spaceKLIP.imagetools.ImageTools method)
clean_bad_pixels() (spaceKLIP.imagetools.ImageTools method)
CleanFullFrame (class in spaceKLIP.fnoise_clean)
CleanSubarray (class in spaceKLIP.fnoise_clean)
coadd_frames() (spaceKLIP.imagetools.ImageTools method)
compare_clean_methods() (in module spaceKLIP.plotting)
compare_find_methods() (in module spaceKLIP.plotting)
compModern() (in module spaceKLIP.plotting)
config_stpipe_log() (in module spaceKLIP.utils)
Coron1Pipeline_spaceKLIP (class in spaceKLIP.coron1pipeline)
Coron2Pipeline_spaceKLIP (class in spaceKLIP.coron2pipeline)
Coron3Pipeline_spaceKLIP (class in spaceKLIP.coron3pipeline)
Covar (class in spaceKLIP.expjumpramp)
crds_logging_disabled() (in module spaceKLIP.logging_tools)
create_alldiffs2use() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
create_bkg_mask() (in module spaceKLIP.fnoise_clean)
create_covar() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
create_database() (in module spaceKLIP.database)
create_diffs() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
create_dq_ints() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
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)
decode_simbad_sptype() (in module spaceKLIP.psflib)
display_coron_dataset() (in module spaceKLIP.plotting)
display_coron_image() (in module spaceKLIP.plotting)
display_image_comparisons() (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)
download_mast() (in module spaceKLIP.psflib)
draw_compass_mpl() (in module spaceKLIP.wcs_utils)
E
estimate_extended() (in module spaceKLIP.analysistools)
estimate_padding_for_shift() (in module spaceKLIP.utils)
ExperimentalJumpRampStep (class in spaceKLIP.expjumpramp)
extract_companions() (spaceKLIP.analysistools.AnalysisTools method)
F
fill_masked_reads() (spaceKLIP.expjumpramp.Ramp_Result method)
filter (spaceKLIP.psf.JWST_PSF property)
find_bad_pixels() (spaceKLIP.imagetools.ImageTools method)
find_bad_pixels_custom() (spaceKLIP.imagetools.ImageTools method)
find_bad_pixels_gradient() (spaceKLIP.imagetools.ImageTools method)
find_bad_pixels_sigclip() (spaceKLIP.imagetools.ImageTools method)
find_bad_pixels_timeints() (spaceKLIP.imagetools.ImageTools method)
find_nircam_centers() (spaceKLIP.imagetools.ImageTools method)
fit() (spaceKLIP.fnoise_clean.CleanFullFrame method)
(spaceKLIP.fnoise_clean.CleanSubarray method)
fit_ramps() (in module spaceKLIP.expjumpramp)
fit_slopes_to_ramp_data() (in module spaceKLIP.fnoise_clean)
fix_bad_pixels() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels_astrofix() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels_interp2d() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels_localmed() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels_medfilt() (spaceKLIP.imagetools.ImageTools method)
fix_bad_pixels_timemed() (spaceKLIP.imagetools.ImageTools method)
flatten_model (spaceKLIP.fnoise_clean.CleanFullFrame property)
fov_pix (spaceKLIP.psf.JWST_PSF property)
G
gaussian_kernel() (in module spaceKLIP.utils)
gen_offsetpsf() (in module spaceKLIP.psf)
gen_psf() (spaceKLIP.psf.JWST_PSF method)
gen_psf_idl() (spaceKLIP.psf.JWST_PSF method)
get_bkg() (in module spaceKLIP.fnoise_clean)
get_compass_info() (in module spaceKLIP.wcs_utils)
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_pce_info() (in module spaceKLIP.utils)
get_pyklip_filepaths() (in module spaceKLIP.pyklippipeline)
get_sciref_files() (in module spaceKLIP.psflib)
get_siaf() (in module spaceKLIP.utils)
get_stellar_magnitudes() (in module spaceKLIP.starphot)
get_subarray_ref() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
get_tp_comsubst() (in module spaceKLIP.utils)
get_transmission() (in module spaceKLIP.psf)
get_visitid() (in module spaceKLIP.utils)
getramps() (in module spaceKLIP.expjumpramp)
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)
inject_companions() (spaceKLIP.imagetools.ImageTools method)
interpret_dq_value() (in module spaceKLIP.utils)
isnone() (in module spaceKLIP.psflib)
J
jumpramp_column() (in module spaceKLIP.expjumpramp)
jumpramp_column_helper() (in module spaceKLIP.expjumpramp)
JWST_PSF (class in spaceKLIP.psf)
K
kTCSubtractStep (class in spaceKLIP.fnoise_clean)
L
load_pce_data() (in module spaceKLIP.utils)
load_plt_style() (in module spaceKLIP.plotting)
load_refdb() (in module spaceKLIP.psflib)
loss_function() (in module spaceKLIP.analysistools)
M
make_asn_file() (in module spaceKLIP.coron3pipeline)
make_clean_class() (in module spaceKLIP.fnoise_clean)
mask_helper() (in module spaceKLIP.fnoise_clean)
mask_jumps() (in module spaceKLIP.expjumpramp)
mask_NDsquares() (spaceKLIP.imagetools.ImageTools method)
MaskGroupsStep (class in spaceKLIP.coron1pipeline)
module
spaceKLIP.analysistools
spaceKLIP.classpsfsubpipeline
spaceKLIP.coron1pipeline
spaceKLIP.coron2pipeline
spaceKLIP.coron3pipeline
spaceKLIP.database
spaceKLIP.expjumpramp
spaceKLIP.fnoise_clean
spaceKLIP.imagetools
spaceKLIP.logging_tools
spaceKLIP.mast
spaceKLIP.plotting
spaceKLIP.psf
spaceKLIP.psflib
spaceKLIP.pyklippipeline
spaceKLIP.starphot
spaceKLIP.utils
spaceKLIP.wcs_utils
N
name (spaceKLIP.psf.JWST_PSF property)
nfclean_mulitprocess_helper() (in module spaceKLIP.fnoise_clean)
not_isnone() (in module spaceKLIP.psflib)
nx (spaceKLIP.fnoise_clean.CleanSubarray property)
ny (spaceKLIP.fnoise_clean.CleanSubarray property)
O
OneOverfStep (class in spaceKLIP.fnoise_clean)
oversample (spaceKLIP.psf.JWST_PSF property)
P
pad_frames() (spaceKLIP.imagetools.ImageTools method)
persistence_trimming() (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)
pop_pxar_kw() (in module spaceKLIP.utils)
prepare_group_masking_advanced() (in module spaceKLIP.coron1pipeline)
prepare_group_masking_basic() (in module spaceKLIP.coron1pipeline)
prepare_group_masking_custom() (in module spaceKLIP.coron1pipeline)
print_obs() (spaceKLIP.database.Database method)
print_red() (spaceKLIP.database.Database method)
print_src() (spaceKLIP.database.Database method)
proc_CubeModel() (spaceKLIP.fnoise_clean.OneOverfStep method)
proc_ImageModel() (spaceKLIP.fnoise_clean.OneOverfStep method)
proc_RampModel() (spaceKLIP.fnoise_clean.OneOverfStep method)
process() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
(spaceKLIP.coron1pipeline.MaskGroupsStep method)
(spaceKLIP.coron2pipeline.Coron2Pipeline_spaceKLIP method)
(spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
(spaceKLIP.fnoise_clean.kTCSubtractStep method)
(spaceKLIP.fnoise_clean.OneOverfStep method)
produce_ramp_images() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
pupil_mask (spaceKLIP.psf.JWST_PSF property)
Q
query_coron_datasets() (in module spaceKLIP.mast)
quick_plot() (spaceKLIP.fnoise_clean.OneOverfStep method)
R
Ramp_Result (class in spaceKLIP.expjumpramp)
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)
read_votable() (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)
resample_frames() (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_default_style() (in module spaceKLIP.plotting)
set_dnu_to_nan() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
set_params() (in module spaceKLIP.mast)
set_surrounded_pixels() (in module spaceKLIP.utils)
setup_output() (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP method)
shift_frames() (spaceKLIP.imagetools.ImageTools method)
spaceKLIP.analysistools
module
spaceKLIP.classpsfsubpipeline
module
spaceKLIP.coron1pipeline
module
spaceKLIP.coron2pipeline
module
spaceKLIP.coron3pipeline
module
spaceKLIP.database
module
spaceKLIP.expjumpramp
module
spaceKLIP.fnoise_clean
module
spaceKLIP.imagetools
module
spaceKLIP.logging_tools
module
spaceKLIP.mast
module
spaceKLIP.plotting
module
spaceKLIP.psf
module
spaceKLIP.psflib
module
spaceKLIP.pyklippipeline
module
spaceKLIP.starphot
module
spaceKLIP.utils
module
spaceKLIP.wcs_utils
module
spec (spaceKLIP.coron1pipeline.Coron1Pipeline_spaceKLIP attribute)
(spaceKLIP.coron1pipeline.MaskGroupsStep attribute)
(spaceKLIP.coron2pipeline.Coron2Pipeline_spaceKLIP attribute)
(spaceKLIP.expjumpramp.ExperimentalJumpRampStep attribute)
(spaceKLIP.fnoise_clean.kTCSubtractStep attribute)
(spaceKLIP.fnoise_clean.OneOverfStep attribute)
subtract_background() (spaceKLIP.imagetools.ImageTools method)
subtract_background_godoy() (spaceKLIP.imagetools.ImageTools method)
subtract_median() (spaceKLIP.imagetools.ImageTools method)
subtract_nircam_coron_background() (spaceKLIP.imagetools.ImageTools method)
subtractlsq() (in module spaceKLIP.utils)
summarize() (spaceKLIP.database.Database method)
suppress_stdout() (in module spaceKLIP.logging_tools)
T
tickFont() (in module spaceKLIP.plotting)
U
update_db_sptypes() (in module spaceKLIP.psflib)
update_frames_with_nans_from_nanmask() (spaceKLIP.imagetools.ImageTools method)
update_groupdq() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
update_miri_offsets() (spaceKLIP.imagetools.ImageTools method)
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
weighted_average() (spaceKLIP.expjumpramp.ExperimentalJumpRampStep method)
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)