NXarchive

Status:

application definition, extends NXobject

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: (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

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: 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

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

documentation (reST source) anchor

web page (HTML) anchor

/NXarchive/entry-group

#nxarchive-entry-group

/NXarchive/entry/collection_description-field

#nxarchive-entry-collection-description-field

/NXarchive/entry/collection_identifier-field

#nxarchive-entry-collection-identifier-field

/NXarchive/entry/collection_time-field

#nxarchive-entry-collection-time-field

/NXarchive/entry/definition-field

#nxarchive-entry-definition-field

/NXarchive/entry/duration-field

#nxarchive-entry-duration-field

/NXarchive/entry/end_time-field

#nxarchive-entry-end-time-field

/NXarchive/entry/entry_identifier-field

#nxarchive-entry-entry-identifier-field

/NXarchive/entry/experiment_description-field

#nxarchive-entry-experiment-description-field

/NXarchive/entry/experiment_identifier-field

#nxarchive-entry-experiment-identifier-field

/NXarchive/entry/instrument-group

#nxarchive-entry-instrument-group

/NXarchive/entry/instrument/description-field

#nxarchive-entry-instrument-description-field

/NXarchive/entry/instrument/name-field

#nxarchive-entry-instrument-name-field

/NXarchive/entry/instrument/SOURCE-group

#nxarchive-entry-instrument-source-group

/NXarchive/entry/instrument/SOURCE/name-field

#nxarchive-entry-instrument-source-name-field

/NXarchive/entry/instrument/SOURCE/probe-field

#nxarchive-entry-instrument-source-probe-field

/NXarchive/entry/instrument/SOURCE/type-field

#nxarchive-entry-instrument-source-type-field

/NXarchive/entry/program-field

#nxarchive-entry-program-field

/NXarchive/entry/program@version-attribute

#nxarchive-entry-program-version-attribute

/NXarchive/entry/release_date-field

#nxarchive-entry-release-date-field

/NXarchive/entry/revision-field

#nxarchive-entry-revision-field

/NXarchive/entry/run_cycle-field

#nxarchive-entry-run-cycle-field

/NXarchive/entry/sample-group

#nxarchive-entry-sample-group

/NXarchive/entry/sample/chemical_formula-field

#nxarchive-entry-sample-chemical-formula-field

/NXarchive/entry/sample/description-field

#nxarchive-entry-sample-description-field

/NXarchive/entry/sample/electric_field-field

#nxarchive-entry-sample-electric-field-field

/NXarchive/entry/sample/magnetic_field-field

#nxarchive-entry-sample-magnetic-field-field

/NXarchive/entry/sample/name-field

#nxarchive-entry-sample-name-field

/NXarchive/entry/sample/preparation_date-field

#nxarchive-entry-sample-preparation-date-field

/NXarchive/entry/sample/pressure-field

#nxarchive-entry-sample-pressure-field

/NXarchive/entry/sample/sample_id-field

#nxarchive-entry-sample-sample-id-field

/NXarchive/entry/sample/situation-field

#nxarchive-entry-sample-situation-field

/NXarchive/entry/sample/stress_field-field

#nxarchive-entry-sample-stress-field-field

/NXarchive/entry/sample/temperature-field

#nxarchive-entry-sample-temperature-field

/NXarchive/entry/sample/type-field

#nxarchive-entry-sample-type-field

/NXarchive/entry/start_time-field

#nxarchive-entry-start-time-field

/NXarchive/entry/title-field

#nxarchive-entry-title-field

/NXarchive/entry/user-group

#nxarchive-entry-user-group

/NXarchive/entry/user/facility_user_id-field

#nxarchive-entry-user-facility-user-id-field

/NXarchive/entry/user/name-field

#nxarchive-entry-user-name-field

/NXarchive/entry/user/role-field

#nxarchive-entry-user-role-field

/NXarchive/entry@index-attribute

#nxarchive-entry-index-attribute

NXDL Source:

https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/applications/NXarchive.nxdl.xml