Qpimage is a Python library that provides a convenient interface to many common functionalities that are used in quantitative phase imaging. This is the documentation of qpimage version 0.9.3.

Documentation

• Introduction
  • The Problem
  • Why qpimage?
  • What are the alternatives?
  • Citing qpimage
• Getting started
  • Installing qpimage
  • User API
    • Basic usage
    • Storing QPImage data on disk
    • Dealing with measurement series
    • Notes
• Examples
  • Simple phase
  • Background image tilt correction
  • Background image offset correction
  • Masked background image correction
  • Background image 2nd order polynomial correction
  • Object-mask background image correction
  • Off-axis hologram of a single cell
  • Filter choices for interferometric imaging
• HDF5 file format
  • QPImage
    • Attributes
    • Groups
  • QPSeries
• Code reference
  • module level aliases
    • qpimage.QPImage
    • qpimage.QPSeries
    • qpimage.META_KEYS
  • bg_estimate (background-estimation)
    • Constants
      • VALID_FIT_OFFSETS
      • VALID_FIT_PROFILES
    • Methods
      • estimate()
      • offset_gaussian()
      • offset_mode()
      • profile_tilt()
      • profile_poly2o()
      • poly2o_model()
      • poly2o_residual()
      • tilt_model()
      • tilt_residual()
  • core (QPImage)
    • Constants
      • VALID_INPUT_DATA
    • Classes
      • QPImage
    • Methods
      • copyh5()
  • image_data (basic image management)
    • Constants
      • COMPRESSION
      • VALID_BG_KEYS
    • Classes
      • Amplitude
      • Phase
      • ImageData
    • Methods
      • write_image_dataset()
  • integrity_check (check QPImage data)
    • Exceptions
      • IntegrityCheckError
    • Methods
      • check()
      • check_attributes()
      • check_background()
  • meta (definitions for QPImage meta data)
    • Constants
      • META_KEYS
    • Exceptions
      • MetaDataMissingError
    • Classes
      • MetaDict
  • series (QPSeries)
    • Classes
      • QPSeries

• Changelog
• Bilbliography

Indices and tables

• Index

• Module Index

• Search Page