2.3.3.1.45. NXroot

Status:

base class, extends NXobject

Description:

Definition of the root NeXus group.

Symbols:

No symbol table

Groups cited:

NXentry

Structure:

@NX_class: (optional) NX_CHAR

The root of any NeXus data file is an ``NXroot`` class ...

The root of any NeXus data file is an NXroot class (no other choice is allowed for a valid NeXus data file). This attribute cements that definition.

Obligatory value: NXroot

@file_time: (optional) NX_DATE_TIME

Date and time file was originally created

@file_name: (optional) NX_CHAR

File name of original NeXus file

@file_update_time: (optional) NX_DATE_TIME

Date and time of last file change at close

@NeXus_repository: (optional) NX_CHAR

A repository containing the application definitions ...

A repository containing the application definitions used for creating this file. If the NeXus_version attribute contains a commit distance and hash this should refer to this repository.

@NeXus_version: (optional) NX_CHAR

Version of NeXus definitions used in writing the file. ...

Version of NeXus definitions used in writing the file. This may either be a date based version tag of the form vYYYY.MM or a version tag with a commit distance and source control (e.g., git) hash of the form vYYYY.MM.post1.dev<commit-distance>.g<git-hash>. It may contain an additional .dYYYYMMDD timestamp appendix for dirty repositories. If the version contains a commit distance and hash the NeXus_repository attribute should be written with the repository url containing this version.

Only used when the NAPI or pynxtools has written the file. Note that this is different from the version of the base class or application definition version number.

@partial: (optional) NX_CHAR

A list of concepts in an application definition this file describes. ...

A list of concepts in an application definition this file describes. This is for partially filling an application definition. If this attribute is not present the application definition is assumed to be valid, if not only the specified concepts/paths are assumed to be valid.

@HDF_version: (optional) NX_CHAR

Version of HDF (version 4) library used in writing the file

@HDF5_Version: (optional) NX_CHAR

Version of HDF5 library used in writing the file. ...

Version of HDF5 library used in writing the file.

Note this attribute is spelled with uppercase “V”, different than other version attributes.

@XML_version: (optional) NX_CHAR

Version of XML support library used in writing the XML file

@h5py_version: (optional) NX_CHAR

Version of h5py Python package used in writing the file

@creator: (optional) NX_CHAR

facility or program where file originated

@creator_version: (optional) NX_CHAR

Version of facility or program used in writing the file

@default: (optional) NX_CHAR

Declares which :ref:`NXentry` group contains ...

Declares which NXentry group contains the data to be shown by default. It is used to resolve ambiguity when more than one NXentry group exists. The value names the default NXentry group. The value must be the name of a child of the current group. The child must be a NeXus group or a link to a NeXus group.

It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion.

ENTRY: (optional) NXentry

entries

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXroot.nxdl.xml