1NXSUMMARY(1) General Commands Manual NXSUMMARY(1)
2
3
4
6 nxdiff - Generate summary of a NeXus file
7
9 nxsummary [--xml] [--value label] [--writeconfig config]
10 [--config config] [--verbose] [--] [--version] [-h]
11 [filename]
12
14 The nxsummary utility prints summary information about NeXus files.
15 This program relies heavily on the configuration file that is located
16 in "${HOME}/.nxsummary.conf" or "/etc/nxsummary.conf". A sample config‐
17 uration file can be obtained using the "--writeconfig" flag. Each item
18 tag in the file describes a node to print from the NeXus file. The path
19 attribute describes where in the NeXus file to get information from.
20 The label attributes is what will be printed when showing the value of
21 the specified field. The optional operation attribute provides for cer‐
22 tain operations to be performed on the data before printing out the
23 result. Valid operations are:
24
25 COUNT - The number of elements in the requested field.
26
27 DIMS - The dimensions of the requested field.
28
29 SUM - Add together all of the array elements and print the
30 result.
31
32 UNITS:newunits - Specify the units to print the result in.
33
34
36 The following options are supported
37
38 --version
39 Displays version information and exits.
40
41 -h|--help
42 Displays usage information and exits.
43
44 --xml Print results as xml
45
46 --value label
47 Get value of the item pointed to by the label
48
49 --writeconfig config
50 Write the default configuration out to a file
51
52 --config config
53 Specify configuration file
54
55 --verbose
56 Turn on verbose printing
57
58 --|--ignore_rest
59 Ignores the rest of the labeled arguments following this flag.
60
62 nxconvert(1), nxdir(1), nxtranslate(1), http://www.nexusformat.org
63
65 nxsummary was originally written by Peter Peterson
66 <petersonpf@ornl.gov> and may be used by others.
67
68
69
70 October 2011 NXSUMMARY(1)