pyKLIP Logo

Setup

  • Installation
  • Release Notes

The Basics

  • Basic KLIP Tutorial with GPI
  • Instrument Tutorials
  • Calibrating Algorithm Throughput & Generating Contrast Curves
  • RDI with a PSF Library

Planet Detection

  • Planet detection
  • Forward Model Matched Filter (FMMF)
  • Planet Evidence Module

Characterization

  • Foward-Model Astrometry and Photometry
  • Spectrum Extraction using extractSpec FM
  • Disk Foward Modelling (DiskFM)

API

  • Developing for pyKLIP
  • pyklip package
    • Subpackages
      • pyklip.fmlib package
      • pyklip.instruments package
      • pyklip.kpp package
        • Subpackages
        • Module contents
    • Submodules
    • pyklip.covars module
    • pyklip.empca module
    • pyklip.fakes module
    • pyklip.fitpsf module
    • pyklip.fm module
    • pyklip.klip module
    • pyklip.nmf_imaging module
    • pyklip.parallelized module
    • pyklip.rdi module
    • pyklip.spectra_management module
    • Module contents
pyKLIP
  • pyklip package
  • pyklip.kpp package
  • View page source

pyklip.kpp package

Subpackages

  • pyklip.kpp.detection package
    • Submodules
    • pyklip.kpp.detection.detection module
      • point_source_detection()
    • Module contents
  • pyklip.kpp.metrics package
    • Submodules
    • pyklip.kpp.metrics.crossCorr module
      • calculate_cc()
    • pyklip.kpp.metrics.matchedfilter module
      • calculate_matchedfilter()
      • calculate_matchedfilter_star()
      • run_matchedfilter()
    • Module contents
  • pyklip.kpp.stat package
    • Submodules
    • pyklip.kpp.stat.statPerPix_utils module
      • get_image_stat_map_perPixMasking()
      • get_image_stat_map_perPixMasking_threadTask()
      • get_image_stat_map_perPixMasking_threadTask_star()
    • pyklip.kpp.stat.stat_utils module
      • get_cdf_model()
      • get_cube_stddev()
      • get_image_PDF()
      • get_image_stat()
      • get_image_stat_map()
      • get_image_stddev()
      • get_pdf_model()
    • Module contents
  • pyklip.kpp.utils package
    • Submodules
    • pyklip.kpp.utils.GPIimage module
      • get_IOWA()
      • get_occ()
    • pyklip.kpp.utils.mathfunc module
      • LSQ_model_exp()
      • gauss2d()
      • hat()
      • model_exp()
    • pyklip.kpp.utils.multiproc module
      • NoDaemonPool
        • NoDaemonPool.Process
      • NoDaemonProcess
        • NoDaemonProcess.daemon
    • pyklip.kpp.utils.oi module
      • get_pos_known_objects()
      • make_GOI_list()
      • mask_known_objects()
    • Module contents

Module contents

Previous Next

© Copyright 2026, pyKLIP Developers.

Built with Sphinx using a theme provided by Read the Docs.