Nomenclature#

This page documents the terms used in the documentation of the NeXus files written by spec2nexus.

symbolic

example

meaning

NAME:NXclass

data:NXdata

HDF5 name of group and NeXus base class used

{NAME}

scan_number

name is chosen as described

@{NAME}

@default

HDF5 attribute of the parent group or field 2

NX_{datatype}

NX_NUMBER

uses this NeXus data type 3

NX_{unittype}

NX_CHAR

uses this NeXus unit type 4

/SCAN

/S1.1

name of the scan NXentry [#NXentry] group in the NeXus HDF5 file

Note

for reference: tree views

In this documentation, the command 5:

punx tree FILENAME.hdf5

is used to generate a tree view of an HDF5 file’s structure.

1

SPEC Standard Data-File Format : https://certif.com/spec_manual/mac_3_13.html

2

A NeXus field is the same as an HDF5 dataset. The rename is due to historical reasons in NeXus when XML was used as a back-end data file storage format.

3

List of NeXus data types: https://manual.nexusformat.org/nxdl-types.html#field-types-allowed-in-nxdl-specifications

4

List of NeXus unit categories: https://manual.nexusformat.org/nxdl-types.html#unit-categories-allowed-in-nxdl-specifications

5

Visualize NeXus file tree structure : https://prjemian.github.io/punx/tree.html#tree

NeXus base classes

6

NXbeam: https://manual.nexusformat.org/classes/base_classes/NXbeam.html

7

NXdata: https://manual.nexusformat.org/classes/base_classes/NXdata.html

8

NXdetector: https://manual.nexusformat.org/classes/base_classes/NXdetector.html

9

NXentry: https://manual.nexusformat.org/classes/base_classes/NXentry.html

10

NXinstrument: https://manual.nexusformat.org/classes/base_classes/NXinstrument.html

11

NXmonitor: https://manual.nexusformat.org/classes/base_classes/NXmonitor.html

12

NXmonochromator: https://manual.nexusformat.org/classes/base_classes/NXmonochromator.html

13

NXnote: https://manual.nexusformat.org/classes/base_classes/NXnote.html

14

NXpositioner: https://manual.nexusformat.org/classes/base_classes/NXpositioner.html

15

NXroot: https://manual.nexusformat.org/classes/base_classes/NXroot.html

16

NXsample: https://manual.nexusformat.org/classes/base_classes/NXsample.html