pyFAI API

This chapter describes the programming interface of pyFAI, so what you can expect after having launched Jupyter notebook (or ipython) and typed:

import pyFAI

The most important class is AzimuthalIntegrator which is an object containing both the geometry (it inherits from Geometry, another class) and exposes important methods (functions) like integrate1d and integrate2d.

• pyFAI Package
• average Module
• azimuthalIntegrator Module
• multi_geometry Module
• integrate_widget Module
• geometry Module
• geometryRefinement Module
• goniometer Module
• detectors Module
• spline Module
• io Module
• calibration Module
• control_points Module
• peak_picker Module
• massif Module
• blob_detection Module
• calibrant Module
• distortion Module
• worker Module
• units Module
• utils.__init__ Module
  • utils.bayes Module
  • utils.shell Module
  • utils.stringutil Module
• opencl.__init__ Module
  • opencl.common Module
  • opencl.processing Module
  • opencl.preproc Module
  • opencl.azim_hist Module
  • opencl.azim_lut Module
  • opencl.azim_csr Module
• gui.__init__ Module
  • gui.matplotlib Module
  • gui.qt Module
  • gui.utils Module
• ext.__init__ Module
  • ext.bilinear Module
  • ext._bispev Module
  • ext._blob Module
  • ext._convolution Module
  • ext._distortion Module
  • ext._geometry Module
  • ext.histogram Module
  • ext.morphology Module
  • ext.reconstruct Module
  • ext.relabel Module
  • ext.preproc Module
  • ext._tree Module
  • ext.watershed Module