File: pyFAI-diffmap.rst

package info (click to toggle)
pyfai 2025.12.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 94,932 kB
  • sloc: python: 69,579; lisp: 8,335; sh: 407; ansic: 247; makefile: 133; xml: 69
file content (94 lines) | stat: -rw-r--r-- 2,753 bytes parent folder | download | duplicates (4)
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
NAME
====

diff_tomo - GUI interface for reduction of diffraction tomography
experiments

DESCRIPTION
===========

usage: diff_map [options] **-p** ponifile imagefiles\* If the number of
files is too large, use double quotes like "*.edf"

Azimuthal integration for diffraction imaging. Diffraction mapping is an
experiment where 2D diffraction patterns are recorded while performing a
2D scan. Diff_map is a graphical application (based on pyFAI and h5py)
which allows the reduction of this 4D dataset into a 3D dataset
containing the two motion dimensions and the many diffraction angles
(thousands). The resulting dataset can be opened using PyMca roitool
where the 1d dataset has to be selected as last dimension. This result
file aims at being NeXus compliant. This tool can be used for
diffraction tomography experiment as well, considering the slow scan
direction as the rotation.

positional arguments:
---------------------

FILE
   List of files to integrate. Mandatory without GUI

optional arguments:
-------------------

**-h**, **--help**
   show this help message and exit

**-V**, **--version**
   show program's version number and exit

**-o** FILE, **--output** FILE
   HDF5 File where processed map will be saved. Mandatory without GUI

**-v**, **--verbose**
   switch to verbose/debug mode, default: quiet

**-P** FILE, **--prefix** FILE
   Prefix or common base for all files

**-e** EXTENSION, **--extension** EXTENSION
   Process all files with this extension

**-t** FAST, **--fast** FAST
   number of points for the fast motion. Mandatory without GUI

**-r** SLOW, **--slow** SLOW
   number of points for slow motion. Mandatory without GUI

**-c** NPT_RAD, **--npt** NPT_RAD
   number of points in diffraction powder pattern. Mandatory without GUI

**-d** FILE, **--dark** FILE
   list of dark images to average and subtract (comma separated list)

**-f** FILE, **--flat** FILE
   list of flat images to average and divide (comma separated list)

**-m** FILE, **--mask** FILE
   file containing the mask, no mask by default

**-p** FILE, **--poni** FILE
   file containing the diffraction parameter (poni-file), Mandatory
   without GUI

**-O** OFFSET, **--offset** OFFSET
   do not process the first files

**-g**, **--gpu**
   process using OpenCL on GPU

**-S**, **--stats**
   show statistics at the end

**--gui**
   Use the Graphical User Interface

**--no-gui**
   Do not use the Graphical User Interface

**--config** CONFIG
   provide a JSON configuration file

Bugs: Many, see hereafter: 1)If the number of files is too large, use
double quotes "*.edf" 2)There is a known bug on Debian7 where importing
a large number of file can take much longer than the integration itself:
consider passing files in the command line