Documentation for StraKLIP

StraKLIP is a Python-based data reduction and analysis toolkit for HST wide field imaging data. The development has mostly been focused on ACS and WFC3-IR/UVIS imaging. It is built on top of pyKLIP and provides functionality and customizations specific to HST data.

Compatible Simulated Data: Here

Getting Started

• Installation and Dependencies
• Pipeline Quick Start Guide
  • Pipeline Setup
  • Running the Pipeline

Tutorials (Unfinished)

• Tutorial Notebooks
• Tutorial: Joining DRC catalogues
  • Setup and imports
  • Loading input catalog
  • Lets populate the mvs_targets_df
  • Lets populate the `unq_dataframe’
• Tutorial: Data Reduction
  • Initial imports
  • Loading the pipeline configuration file for the project
  • Building the dataframes
  • Tiles
  • Photometry
  • FOW2CELL
• Tutorial: PSF Subtraction
  • Initial imports
  • Loading the dataframe
  • PSF subtraction
  • Photmetry
• Tutorial: Analysis (work in progress)
  • Initial imports
  • Loading the dataframe
  • Running the analysis

About

• Contact
• Attribution

Package content (Unfinished)

• Detailed StraKLIP API
  • straklip.config module
  • straklip.dataframe module
    • DataFrame
      • DataFrame.list_of_HDF5_keys()
      • DataFrame.load_dataframe()
      • DataFrame.remove_HDF5_key()
      • DataFrame.save_dataframes()
  • straklip.fake_star module
    • Fake_Star
      • Fake_Star.combine()
  • straklip.input_tables module
    • Tables
      • Tables.ancillary_info()
      • Tables.canonize()
      • Tables.check_fits_file_existence()
      • Tables.load_table_into_df()
      • Tables.rename_df()
      • Tables.select_tables()
  • straklip.photometry module
    • Detection
      • Detection.find_peaks()
      • Detection.find_sources()
    • flux_converter
      • flux_converter.counts_and_errors()
      • flux_converter.flux2mag()
      • flux_converter.mag2flux()
      • flux_converter.radial_profile()
    • photometry_AP
      • photometry_AP.aperture_mask()
      • photometry_AP.aperture_stats()
      • photometry_AP.grow_curves()
      • photometry_AP.mask_aperture_data()
    • photometry_MF
      • photometry_MF.mf_stats()
    • photometry_PSF
      • photometry_PSF.equivalent_noise_area()
      • photometry_PSF.psf_stats()
  • straklip.showroom module
  • straklip.stralog module
    • MakeFileHandler
    • getLogger()
    • mkdir_p()
    • setupLogger()
  • straklip.tiles module
    • Tile
      • Tile.append_tile()
      • Tile.load_tile()
      • Tile.mk_tile()
      • Tile.plot_tile()