Download
for other NeXus tools and utilities, see : http://www.nexusformat.org/
Usage
Just type 'nxextractor"' in a console. You will get the usage string as output:
INFO app:Found default configuration file: /usr/Local/configFiles/GD/RecordingConfigurations/common/nxextract.conf
ERROR app:No template file provided!!
nxextractor v1.16.0
Usage:
nxextract options input NeXus Files and/or directories...
Options:
-t, --template <file> Template file
-D, --Define <symbols> Symbols list
-l, --list Templates list
-c, --configuration <file> Configuration file
-s, --silent Silent mode
-m, --mode <octal value> Access mode of output files in octal ex:'755'
-w, --ownership <user_id:group_id> User and group in the form 'user:group'
-h, --help Show this usage
-v, --version Program version
Options
template
There are two ways of choosing a template:
- by it's full path:
nxextractor -t /path/to/my/template.nxs ...
- by it's name, which is a shortest way:
nxextractor -t template ...
list
INFO app:Found default configuration file: /usr/Local/configFiles/GD/RecordingConfigurations/common/nxextract.conf
scan_1D_images_bmp_raw
scan
The --list option has returned two names: scan_1D_images_bmp_raw and scan. On this server one can use the short way to invoke these templates.
Define
By convention, the symbol dir is used in all the templates: it define the output directory path:
NOTE: Do not forget the space between --Define (or -D) and the name of the symbol !
However, the usage of this option and the dir symbol is not mandatory. This is the case (at SOLEIL) if the configuration file nxextract.conf contains a set of rules defining the right output path into the storage facility according to the location of the input nexus files.
configuration
silent
Turn-off thelog messages (warning, info)
mode & ownership
An example: How to extract data from NeXus files stored a project directory
This example are working on every SOLEIL beamlines.
In order to be able to get read access on data fro the project 'm_project' you have to log as user 'my_project' on a terminal in the beamline control network:
Lets suppose the data were acquired using the ScanServer, so the template to use is 'scan'.
Running the extracting tool in order to extract data from all NeXus files stored in a directory: