3.4.1. NXarchive

Status:

application definition, extends NXobject, version 1.0b

Description:

This is a definition for data to be archived by ICAT (http://www.icatproject.org/).

Symbols:

No symbol table

Groups cited:

NXentry, NXinstrument, NXsample, NXsource, NXuser

Structure:

entry: NXentry

@index: NX_CHAR

title: NX_CHAR

experiment_identifier: NX_CHAR

unique identifier for the experiment

experiment_description: NX_CHAR

Brief description of the experiment and its objectives

collection_identifier: NX_CHAR

ID of user or DAQ define group of data files

collection_description: NX_CHAR

Brief summary of the collection, including grouping criteria

entry_identifier: NX_CHAR

unique identifier for this measurement as provided by the facility

start_time: NX_DATE_TIME

end_time: NX_DATE_TIME

duration: NX_FLOAT {units=NX_TIME}

TODO: needs documentation

collection_time: NX_FLOAT {units=NX_TIME}

TODO: needs documentation

run_cycle: NX_CHAR

TODO: needs documentation

revision: NX_CHAR

revision ID of this file, may be after recalibration, reprocessing etc.

definition: NX_CHAR

Official NeXus NXDL schema to which this file conforms

Obligatory value: NXarchive

program: NX_CHAR

The program and version used for generating this file

@version: NX_CHAR

release_date: NX_CHAR {units=NX_TIME}

when this file is to be released into PD

user: NXuser

name: NX_CHAR

role: NX_CHAR

role of the user

facility_user_id: NX_CHAR

ID of the user in the facility burocracy database

instrument: NXinstrument

name: NX_CHAR

description: NX_CHAR

Brief description of the instrument

(source): NXsource

type: NX_CHAR

Any of these values:

• Spallation Neutron Source
• Pulsed Reactor Neutron Source
• Reactor Neutron Source
• Synchrotron X-Ray Source
• Pulsed Muon Source
• Rotating Anode X-Ray
• Fixed Tube X-Ray

name: NX_CHAR

probe: NX_CHAR

Any of these values: neutron | x-ray | electron

sample: NXsample

name: NX_CHAR

Descriptive name of sample

sample_id: NX_CHAR

Unique database id of the sample

description: NX_CHAR

type: NX_CHAR

Any of these values:

• sample
• sample+can
• calibration sample
• normalisation sample
• simulated data
• none
• sample_environment

chemical_formula: NX_CHAR

Chemical formula formatted according to CIF conventions

preparation_date: NX_CHAR {units=NX_TIME}

situation: NX_CHAR

Description of the environment the sample is in: air, vacuum, oxidizing atmosphere, dehydrated, etc.

temperature: NX_FLOAT {units=NX_TEMPERATURE}

magnetic_field: NX_FLOAT {units=NX_CURRENT}

electric_field: NX_FLOAT {units=NX_VOLTAGE}

stress_field: NX_FLOAT {units=NX_UNITLESS}

pressure: NX_FLOAT {units=NX_PRESSURE}

Source:

Automatically generated from https://github.com/nexusformat/definitions/blob/master/applications/NXarchive.nxdl.xml