3.3.2.21. 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: (required) NX_INT (Rank: 2, Dimensions: [nDet, nTimeChan])

detector_number: (required) NX_INT (Rank: 1, Dimensions: [nDet])

distance: (required) NX_FLOAT (Rank: 1, Dimensions: [nDet]) {units=NX_LENGTH}

distance to sample for each detector

time_of_flight: (required) NX_FLOAT (Rank: 1, Dimensions: [nTimeChan]) {units=NX_TIME_OF_FLIGHT}

polar_angle: (required) NX_FLOAT (Rank: 1, Dimensions: [nDet]) {units=NX_ANGLE}

polar angle for each detector element

azimuthal_angle: (required) NX_FLOAT (Rank: 1, Dimensions: [nDet]) {units=NX_ANGLE}

azimuthal 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: (required) NX_INT (Rank: 1, Dimensions: [nTimeChan])

time_of_flight: (required) NX_FLOAT (Rank: 1, Dimensions: [nTimeChan]) {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

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/NXtofraw.nxdl.xml