3.3.2.1. NXarchive

Status:

application definition, extends NXobject

Description:

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

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: (required) NXentry

@index: (required) NX_CHAR

title: (required) NX_CHAR ⤆

experiment_identifier: (required) NX_CHAR ⤆

unique identifier for the experiment

experiment_description: (required) NX_CHAR ⤆

Brief description of the experiment and its objectives

collection_identifier: (required) NX_CHAR ⤆

ID of user or DAQ define group of data files

collection_description: (required) NX_CHAR ⤆

Brief summary of the collection, including grouping criteria

entry_identifier: (required) NX_CHAR ⤆

unique identifier for this measurement as provided by the facility

start_time: (required) NX_DATE_TIME ⤆

end_time: (required) NX_DATE_TIME ⤆

duration: (required) NX_FLOAT {units=NX_TIME}

TODO: needs documentation

collection_time: (required) NX_FLOAT {units=NX_TIME} ⤆

TODO: needs documentation

run_cycle: (required) NX_CHAR ⤆

TODO: needs documentation

revision: (required) NX_CHAR ⤆

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

definition: (required) NX_CHAR ⤆

Official NeXus NXDL schema to which this file conforms ...

Official NeXus NXDL schema to which this file conforms

Obligatory value: NXarchive

program: (required) NX_CHAR

The program and version used for generating this file

@version: (required) NX_CHAR

release_date: (required) NX_CHAR {units=NX_TIME}

when this file is to be released into PD

user: (required) NXuser ⤆

name: (required) NX_CHAR ⤆

role: (required) NX_CHAR ⤆

role of the user

facility_user_id: (required) NX_CHAR ⤆

ID of the user in the facility burocracy database

instrument: (required) NXinstrument ⤆

name: (required) NX_CHAR ⤆

description: (required) NX_CHAR

Brief description of the instrument

SOURCE: (required) NXsource ⤆

type: (required) 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: (required) NX_CHAR ⤆

probe: (required) NX_CHAR ⤆

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

sample: (required) NXsample ⤆

name: (required) NX_CHAR ⤆

Descriptive name of sample

sample_id: (required) NX_CHAR

Unique database id of the sample

description: (required) NX_CHAR ⤆

type: (required) NX_CHAR ⤆

Any of these values:

  • sample

  • sample+can

  • calibration sample

  • normalisation sample

  • simulated data

  • none

  • sample_environment

chemical_formula: (required) NX_CHAR ⤆

Chemical formula formatted according to CIF conventions

preparation_date: (required) NX_CHAR {units=NX_TIME}

situation: (required) NX_CHAR ⤆

Description of the environment the sample is in: ...

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

temperature: (required) NX_FLOAT {units=NX_TEMPERATURE} ⤆

magnetic_field: (required) NX_FLOAT {units=NX_CURRENT} ⤆

electric_field: (required) NX_FLOAT {units=NX_VOLTAGE} ⤆

stress_field: (required) NX_FLOAT {units=NX_UNITLESS} ⤆

pressure: (required) NX_FLOAT {units=NX_PRESSURE} ⤆

Hypertext Anchors

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

NXDL Source:

https://github.com/nexusformat/definitions/blob/main/applications/NXarchive.nxdl.xml