ePDFsuite

Getting started

  • Installation
    • No-install option
    • Requirements
    • From PyPI (recommended)
    • From source
    • Camera calibration
    • Optional dependencies
  • Quick start
    • Typical workflow
    • Passing a custom centre to integrate()
    • With MTF deconvolution
    • Without a PONI file (scaled images)
  • Streamlit application
    • Online version (no installation)
    • Local installation
    • Interface overview
      • Tab 1 — Define Sample and Reference
      • Tab 2 — Extract ePDF
    • When to use the app vs. the Python API

API reference

  • API reference
    • epdfsuite.ePDFsuite
      • SAEDProcessor
        • SAEDProcessor.integrate()
        • SAEDProcessor.plot()
        • SAEDProcessor.plot_recalibrated_image()
        • SAEDProcessor.inspect_histogram()
        • SAEDProcessor.extract_epdf()
      • extract_epdf()
      • PDFResultsReference
        • PDFResultsReference.r
        • PDFResultsReference.g
      • PDFInteractive
        • PDFInteractive.update_plot()
        • PDFInteractive.save_results()
        • PDFInteractive.show()
      • extract_ePDF_from_mutliple_files()
    • epdfsuite.pdf_extraction
      • parse_formula()
      • compute_avg_scattering_factor()
      • compute_f2avg()
      • fit_polynomial_background()
      • compute_ePDF()
    • epdfsuite.utilities
      • draw_mask()
      • detect_edge_angle_hough()
      • compute_mtf_slanted_edge()
      • estimate_wiener_epsilon_spectral()
      • extract_noise_and_signal_patches()
      • deconvolve_mtf_2d()
      • compute_dqe()
      • deconvolve_mtf_dqe_2d()
      • deconvolve_mtf_2d_rl()
    • epdfsuite.calibration
      • build_calibration_data_from_cif()
      • perform_geometric_calibration()
      • get_calibration_parameters()
    • epdfsuite.recalibration
      • recalibrate_from_isocurve()
    • epdfsuite.filereader
      • extract_camera_type()
      • extract_wavelength()
      • get_detector_params()
      • load_data()
      • add_detector()
    • epdfsuite.snr
      • compute_SNR()
      • compute_SNR_from_file()
    • epdfsuite.lobato_scattering
      • electron_scattering_factor()
      • x_ray_scattering_factor()
      • compute_scattering_profile()
      • LobatoScatteringCalculator
        • LobatoScatteringCalculator.line_profiles()
        • LobatoScatteringCalculator.get_parameters()
    • epdfsuite.camera_library

About

  • Changelog
    • 0.2.0 (current)
    • 0.1.4
    • 0.1.0
ePDFsuite
  • API reference
  • View page source

API reference

epdfsuite.ePDFsuite

epdfsuite.pdf_extraction

epdfsuite.utilities

epdfsuite.calibration

epdfsuite.recalibration

epdfsuite.filereader

epdfsuite.snr

epdfsuite.lobato_scattering

Lobato parametrization for electron and X-ray scattering factors.

epdfsuite.camera_library

Previous Next

© Copyright 2024, Nicolas Ratel-Ramond.

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