NXtofraw

Status:

application definition, extends NXobject

Description:

This is an application definition for raw data from a generic TOF instrument

Symbols:

The symbol(s) listed here will be used below to coordinate datasets with the same shape.

nDet: Number of detectors

nTimeChan: nTimeChan description

Groups cited:

NXdata, NXdetector, NXentry, NXinstrument, NXmonitor, NXsample, NXuser

Structure:

entry: (required) NXentry

title: (required) NX_CHAR

start_time: (required) NX_DATE_TIME

definition: (required) NX_CHAR

Official NeXus NXDL schema to which this file conforms

Obligatory value: NXtofraw

duration: (required) NX_FLOAT

run_number: (required) NX_INT

pre_sample_flightpath: (required) NX_FLOAT {units=NX_LENGTH}

This is the flight path before the sample position. This can be determined by a chopper, by the moderator, or the source itself. In other words: it is the distance to the component which gives the T0 signal to the detector electronics. If another component in the NXinstrument hierarchy provides this information, this should be a link.

user: (required) NXuser

name: (required) NX_CHAR

instrument: (required) NXinstrument

detector: (required) NXdetector

data[nDet, nTimeChan]: (required) NX_INT

detector_number[nDet]: (required) NX_INT

distance[nDet]: (required) NX_FLOAT {units=NX_LENGTH}

distance to sample for each detector

time_of_flight[nTimeChan]: (required) NX_FLOAT {units=NX_TIME_OF_FLIGHT}

polar_angle[nDet]: (required) NX_FLOAT {units=NX_ANGLE}

polar angle for each detector element

azimuthal_angle[nDet]: (required) NX_FLOAT {units=NX_ANGLE}

polar angle for each detector element

SAMPLE: (required) NXsample

name: (required) NX_CHAR

Descriptive name of sample

nature: (required) NX_CHAR

Any of these values: powder | liquid | single crystal

MONITOR: (required) NXmonitor

mode: (required) NX_CHAR

Count to a preset value based on either clock time (timer) or received monitor counts (monitor).

Any of these values: monitor | timer

preset: (required) NX_FLOAT

preset value for time or monitor

distance: (required) NX_FLOAT {units=NX_LENGTH}

data[nTimeChan]: (required) NX_INT

time_of_flight[nTimeChan]: (required) NX_FLOAT {units=NX_TIME_OF_FLIGHT}

integral_counts: (required) NX_INT {units=NX_UNITLESS}

data: (required) NXdata

data: link (suggested target: /NXentry/NXinstrument/NXdetector/data)

detector_number: link (suggested target: /NXentry/NXinstrument/NXdetector/detector_number)

time_of_flight: link (suggested target: /NXentry/NXinstrument/NXdetector/time_of_flight)

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

/NXtofraw/entry-group

#nxtofraw-entry-group

/NXtofraw/entry/data-group

#nxtofraw-entry-data-group

/NXtofraw/entry/data/data-link

#nxtofraw-entry-data-data-link

/NXtofraw/entry/data/detector_number-link

#nxtofraw-entry-data-detector-number-link

/NXtofraw/entry/data/time_of_flight-link

#nxtofraw-entry-data-time-of-flight-link

/NXtofraw/entry/definition-field

#nxtofraw-entry-definition-field

/NXtofraw/entry/duration-field

#nxtofraw-entry-duration-field

/NXtofraw/entry/instrument-group

#nxtofraw-entry-instrument-group

/NXtofraw/entry/instrument/detector-group

#nxtofraw-entry-instrument-detector-group

/NXtofraw/entry/instrument/detector/azimuthal_angle-field

#nxtofraw-entry-instrument-detector-azimuthal-angle-field

/NXtofraw/entry/instrument/detector/data-field

#nxtofraw-entry-instrument-detector-data-field

/NXtofraw/entry/instrument/detector/detector_number-field

#nxtofraw-entry-instrument-detector-detector-number-field

/NXtofraw/entry/instrument/detector/distance-field

#nxtofraw-entry-instrument-detector-distance-field

/NXtofraw/entry/instrument/detector/polar_angle-field

#nxtofraw-entry-instrument-detector-polar-angle-field

/NXtofraw/entry/instrument/detector/time_of_flight-field

#nxtofraw-entry-instrument-detector-time-of-flight-field

/NXtofraw/entry/MONITOR-group

#nxtofraw-entry-monitor-group

/NXtofraw/entry/MONITOR/data-field

#nxtofraw-entry-monitor-data-field

/NXtofraw/entry/MONITOR/distance-field

#nxtofraw-entry-monitor-distance-field

/NXtofraw/entry/MONITOR/integral_counts-field

#nxtofraw-entry-monitor-integral-counts-field

/NXtofraw/entry/MONITOR/mode-field

#nxtofraw-entry-monitor-mode-field

/NXtofraw/entry/MONITOR/preset-field

#nxtofraw-entry-monitor-preset-field

/NXtofraw/entry/MONITOR/time_of_flight-field

#nxtofraw-entry-monitor-time-of-flight-field

/NXtofraw/entry/pre_sample_flightpath-field

#nxtofraw-entry-pre-sample-flightpath-field

/NXtofraw/entry/run_number-field

#nxtofraw-entry-run-number-field

/NXtofraw/entry/SAMPLE-group

#nxtofraw-entry-sample-group

/NXtofraw/entry/SAMPLE/name-field

#nxtofraw-entry-sample-name-field

/NXtofraw/entry/SAMPLE/nature-field

#nxtofraw-entry-sample-nature-field

/NXtofraw/entry/start_time-field

#nxtofraw-entry-start-time-field

/NXtofraw/entry/title-field

#nxtofraw-entry-title-field

/NXtofraw/entry/user-group

#nxtofraw-entry-user-group

/NXtofraw/entry/user/name-field

#nxtofraw-entry-user-name-field

NXDL Source:

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