NXSUMMARY(1) General Commands Manual NXSUMMARY(1)
NAME
nxsummary - generate summary of a NeXus file
SYNOPSIS
nxdir [--xml] [--value<label>] [--writeconfig<file>] [--config<file>] [--verbose] [-h] [-v] [--] filename ...
DESCRIPTION
nxsummary generates a customised summary of NeXus files.
This program relies heavily on the configuration file specified or defaulting that on what is located in ${HOME}/.nxsummary.conf or
/etc/nxsummary.conf
CONFIGURATION FILE
A sample configuration file can be obtained using the "--writeconfig" flag. Each "item" tag in the file describes a node to print from the
NeXus file. The "path" attribute describes where in the NeXus file to get information from. The "label" attributes is what will be printed
when showing the value of the specified field. The optional "operation" attribute provides for certain operations to be performed on the
data before printing out the result.
Valid operations are:
COUNT The number of elements in the requested field.
DIMS The dimensions of the requested field.
SUM Add together all of the array elements and print the result.
UNITS:<new units>
Specify the units to print the result in.
OPTIONS
-xml Print result as xml.
--value label
Get value of the item pointed to by the label.
--writeconfig file
Write the default configuration out to a file.
--config file
Use specified configuration file.
--verbose
Be verbose.
-- Ignore following flags (treat as filenames).
-v|--version
Show version information.
-h|--help
Show usage information.
SEE ALSO
nxbrowse(1) http://www.nexusformat.org
AUTHOR
nxsummary was originally written by P. F. Peterson <petersonpf@ornl.gov>
This manual page was written by Tobias Richter <Tobias.Richter@diamond.ac.uk> and may be used by others.
July 2011 NXSUMMARY(1)
