File: pymcaroitool.1

package info (click to toggle)
pymca 5.1.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 40,004 kB
  • ctags: 17,800
  • sloc: python: 132,302; ansic: 20,016; cpp: 827; makefile: 48; sh: 30; xml: 24
file content (75 lines) | stat: -rw-r--r-- 2,072 bytes parent folder | download | duplicates (2)
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
.\" 
.\" Man page for pymcaroitool 
.\" 


.TH pymcaroitool 1 "March 2012" "ESRF" "PyMca X-Ray Fluorescence Toolkit"

.SH NAME

pymcaroitool - PyMca region-of-interest imaging X application

.SH SYNOPSIS

pymcaroitool [OPTIONS]... [FILE(S)]

.SH DESCRIPTION

.P
Start the graphical user interface of the PyMca X-Ray 
Fluorescence Toolkit region-of-interest imaging tool.

This tool is best suited for handling datasets that can be represented by 
three-dimensional arrays. Typical cases are stacks of images (first 
dimension is image number) or 2D maps of 1D spectra (last dimension is 
spectrum channel number).
 
It allows one to display maps of particular regions of the spectra or spectra 
of a particular region of the map.

A system of plugins allow to extend the capabilities of this tool. Plugins 
for multivariate analysis are already built in.
 
.P
If FILE is given, it will be opened in the program provided 
its format is supported.


.SH EXAMPLES

.B pymcaroitool
.P
Start the program with a file browser to select the input files.

.B pymcaroitool file_0001.edf
.P
Tries to open the file named file_0001.edf and all indexed files of 
the form file_????.edf where ???? is a number.

.B pymcaroitool --imagestack=1 file_0001.edf
.P
Tries to open the file named file_0001.edf and all indexed files of 
the form file_????.edf where ???? is a number as a set of images.


.B pymcaroitool uncompressed_tiff_file_0001.tif
.P
Tries to open a series of uncompressed TIFF files as an image stack.

.B pymcaroitool --begin=100 --end=200 --filepattern=file_%05d.edf
.P
Start the program loading the single indexed files from file_00100.edf to 
file_00200.edf

.B pymcaroitool --begin=10,100 --end=20,200 --filepattern=row%d_col%03d.dat
.P
Load the double indexed files from row10_col100.dat, row10_col101.dat, ... 
to row20_col00199.dat, row20_col00200.dat 

.SH CAVEATS
If files f_000.xxx and f_001.xxx are present in the same directory, the 
program will always try to load both of them unless a cumbersome way using 
a file pattern is used.

.SH SEE ALSO
HDF5, h5py