File: scripts.rst

package info (click to toggle)
pyfai 0.10.2-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 116,836 kB
  • ctags: 36,561
  • sloc: python: 28,463; lisp: 4,241; ansic: 118; sh: 16; makefile: 14
file content (39 lines) | stat: -rw-r--r-- 1,667 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
pyFAI scripts manual
====================

While pyFAI is first and foremost a Python library to be used by developers, a set of scripts is provided to process
a full diffraction experiment on the command line without knowing anything about Python.
Those scipts can be divided into 3 categories: pre-processing tools which prepare the dataset for the calibration tool.
The calibration is the determination of the geometry of the experimental setup using Debye-Scherrer rings of a reference compound (or calibrant).
Finally a full dataset can be integrated using different tools targeted at different experiments.

Pre-processing tools:
 * drawMask_pymca: tool for drawing a mask on top of an image
 * pyFAI-average: tool for averaging/median/... filtering images (i.e. for dark current)

Calibration tools:
 * pyFAI-calib: manually select the rings and refine the geometry
 * pyFAI-recalib: automatic ring extraction to refine the geometry (deprecated: see "recalib" option in pyFAI-calib)
 * MX-calibrate: Calibrate automatically a set of images taken at various detector distances
 * check_calib: checks the calibration of an image at the sub-pixel level (deprecated: see "validate" option in pyFAI-calib)

Azimuthal integration tools:
 * pyFAI-integrate: the only graphical interface for integration
 * pyFAI-saxs: command line interface for small-angle scattering
 * pyFAI-waxs: command line interface for powder difration
 * diff_tomo: diffraction mapping&tomography tool

.. toctree::
   :maxdepth: 4

   pyFAI-average
   drawMask_pymca
   pyFAI-calib
   pyFAI-recalib
   check_calib
   MX-calibrate
   pyFAI-integrate
   diff_tomo
   pyFAI-saxs
   pyFAI-waxs