Skip to main content
Ctrl+K

pyFAI 2025.3.0 documentation

  • General introduction
  • Example of usage
  • Conventions
  • Application manuals
  • Design of the library
    • Python programming API
    • Installation
    • Ecosystem
    • Project
    • Change-log of versions
    • Publications about pyFAI
    • Bibliography
    • Glossary
  • General introduction
  • Example of usage
  • Conventions
  • Application manuals
  • Design of the library
  • Python programming API
  • Installation
  • Ecosystem
  • Project
  • Change-log of versions
  • Publications about pyFAI
  • Bibliography
  • Glossary

Section Navigation

  • Cookbook recipes
    • Calibration of a diffraction setup using the Graphical User Interface (GUI)
    • Calibration of a diffraction setup using the Command Line Interface (CLI)
    • Calibration of a diffraction setup using Jupyter notebooks
    • Azimuthal integration using the graphical user interface
    • Performing the azimutal integration from shell scripts
    • Integration with Python
  • Tutorials
    • Introduction to the tutorials
    • Geometries in pyFAI
    • Orientation management
    • Detector geometric distortions and corrections
      • Detector distortion corrections
      • CCD calibration
      • Calibration of the pixel position for a Pilatus detector
      • Calibration of a very large Pilatus detector with overlapping grid position
      • Distortion of Eiger2 CdTe detector from ID11
    • Calibrant selection and generation
      • Selection of a calibrant
      • Creation of a new calibrant
      • Creation of a calibrant file
      • Creation of a new calibrant
    • Re-calibration of a diffraction image with Jupyter
    • Flatfield calibration
    • Extracting ellipse parameters from rings
    • Pixel splitting
    • Filtering signal in azimuthal space
    • Uncertainty propagation and error-models equivalence
    • Azimuthal averaging in log-scaled bins
    • Multi-geometry azimuthal integration
      • Demo of usage of the MultiGeometry class of pyFAI
      • Demo of usage of the MultiGeometryFiber class of pyFAI
    • Goniometer and translation table calibration
      • Calibration of a detector on a translation table
      • Calibration of a 2 theta arm with a Pilatus 100k detector
      • ImXPAD S540 detector at D2AM
      • Fitting wavelength with multiple sample-detector distances
      • MX Calibrate
    • Inpainting missing data
    • Thick detectors
      • Pilatus on a goniometer at ID28
      • Modeling of the thickness of the sensor
      • Deconvolution of the Thickness effect
      • Parallax effect
    • Variance of SAXS data
    • Weighted vs Unweighted average for azimuthal integration
    • Signal separation
      • Signal separation between amorphous and crystalline phases
      • Wilson plots generated from sparse datasets
      • Laue diffraction peak identification
      • Implementation of PeakFinder8 on GPU
      • How to retrieve dynamically masked pixels during sigma-clipping
    • High performance computing
      • Parallel processing of a stack of data stored in HDF5 with multi-threading
      • Image decompression and azimuthal integration on the GPU
      • Multiprocessing on GPU
    • 2D Integration in non-azimuthal space
    • Representation of a Fiber Diffraction / Grazing Incidence pattern
    • Using pyFAI with data from Synchrotron Soleil
      • Calibration of the 9-Mythen detector at the Cristal beamline at Soleil
  • Example of usage
  • Tutorials

Tutorials#

Tutorials explain the Python interface of pyFAI and use the jupyter notebook interface, formerly known as ipython notebooks. The two first tutorials are an introduction to the usage of pyFAI from Python for diffraction data reduction. The subsequent tutorials are more in depth explanation and require a good Python fluency and to a certain extent, of the pyFAI library.

  • Introduction to the tutorials
  • Geometries in pyFAI
  • Orientation management
  • Detector geometric distortions and corrections
  • Calibrant selection and generation
  • Re-calibration of a diffraction image with Jupyter
  • Flatfield calibration
  • Extracting ellipse parameters from rings
  • Pixel splitting
  • Filtering signal in azimuthal space
  • Uncertainty propagation and error-models equivalence
  • Azimuthal averaging in log-scaled bins
  • Multi-geometry azimuthal integration
  • Goniometer and translation table calibration
  • Inpainting missing data
  • Thick detectors
  • Variance of SAXS data
  • Weighted vs Unweighted average for azimuthal integration
  • Signal separation
  • High performance computing
  • 2D Integration in non-azimuthal space
  • Representation of a Fiber Diffraction / Grazing Incidence pattern
  • FiberIntegrator
  • Using pyFAI with data from Synchrotron Soleil

previous

Integration with Python

next

Introduction to the tutorials

This Page

  • Show Source

© Copyright 2012-2025, European Synchrotron Radiation Facility, Grenoble..

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.