1
2
3pymcaroitool(1)        PyMca X-Ray Fluorescence Toolkit        pymcaroitool(1)
4
5
6

NAME

8       pymcaroitool - PyMca region-of-interest imaging X application
9
10

SYNOPSIS

12       pymcaroitool [OPTIONS]... [FILE(S)]
13
14

DESCRIPTION

16       Start  the  graphical  user  interface  of the PyMca X-Ray Fluorescence
17       Toolkit region-of-interest imaging tool.
18
19       This tool is best suited for handling datasets that can be  represented
20       by  three-dimensional arrays. Typical cases are stacks of images (first
21       dimension is image number) or 2D maps of 1D spectra (last dimension  is
22       spectrum channel number).
23
24       It  allows  one to display maps of particular regions of the spectra or
25       spectra of a particular region of the map.
26
27       A system of plugins allows to extend the  capabilities  of  this  tool.
28       Plugins for multivariate analysis are already built in.
29
30
31       If  FILE is given, it will be opened in the program provided its format
32       is supported.
33
34
35

EXAMPLES

37       pymcaroitool
38
39       Start the program with a file browser to select the input files.
40
41       pymcaroitool --binding=XX
42
43       Start the program using the selected Qt binding. It has to  be  one  of
44       PyQt5 (default), PyQt6, PySide6 or PySide2.
45
46       pymcaroitool file_0001.edf
47
48       Tries to open the file named file_0001.edf and all indexed files of the
49       form file_????.edf where ???? is a number.
50
51       pymcaroitool --imagestack=1 file_0001.edf
52
53       Tries to open the file named file_0001.edf and all indexed files of the
54       form file_????.edf where ???? is a number as a set of images.
55
56       pymcaroitool uncompressed_tiff_file_0001.tif
57
58       Tries to open a series of uncompressed TIFF files as an image stack.
59
60       pymcaroitool --begin=100 --end=200 --filepattern=file_%05d.edf
61
62       Start  the program loading the single indexed files from file_00100.edf
63       to file_00200.edf
64
65       pymcaroitool       --begin=10,100        --end=20,200        --filepat‐
66       tern=row%d_col%04d.dat
67
68       Load    the    double    indexed    files    from    row10_col0100.dat,
69       row10_col0101.dat, ...  to row20_col0199.dat, row20_col0200.dat
70
71       pymcaroitool --logging=XX
72
73       Set the logging level. Allowed values are, in increasing order of  ver‐
74       bosity:  critical,  error,  warning  (default),  info, debug.  Alterna‐
75       tively, you can specify a value in range 0 (critical) to 4 (debug).
76
77
78
79

CAVEATS

81       If files f_000.xxx and f_001.xxx are present in the same directory, and
82       only  one of them is selected, the program will always try to load both
83       of them unless a cumbersome way using a file pattern is used.
84
85

SEE ALSO

87       HDF5, h5py
88
89
90
91ESRF                             January 2023                  pymcaroitool(1)
Impressum