3.3.3.51. NXsnsevent

Status:

application definition, extends NXobject

Description:

This is a definition for event data from Spallation Neutron Source (SNS) at ORNL.

Symbols:

No symbol table

Groups cited:

NXaperture, NXattenuator, NXcollection, NXcrystal, NXdata, NXdetector, NXdisk_chopper, NXentry, NXevent_data, NXgeometry, NXinstrument, NXlog, NXmoderator, NXmonitor, NXnote, NXorientation, NXpolarizer, NXpositioner, NXsample, NXshape, NXsource, NXtranslation, NXuser

Structure:

ENTRY: (required) NXentry

collection_identifier: (required) NX_CHAR

collection_title: (required) NX_CHAR

definition: (required) NX_CHAR

Official NXDL schema after this file goes to applications.

Obligatory value: NXsnsevent

duration: (required) NX_FLOAT {units=NX_TIME}

end_time: (required) NX_DATE_TIME

entry_identifier: (required) NX_CHAR

experiment_identifier: (required) NX_CHAR

notes: (required) NX_CHAR

proton_charge: (required) NX_FLOAT {units=NX_CHARGE}

raw_frames: (required) NX_INT

run_number: (required) NX_CHAR

start_time: (required) NX_DATE_TIME

title: (required) NX_CHAR

total_counts: (required) NX_UINT {units=NX_UNITLESS}

total_uncounted_counts: (required) NX_UINT {units=NX_UNITLESS}

DASlogs: (required) NXcollection

Details of all logs, both from cvinfo file and from HistoTool (frequency and proton_charge).

LOG: (required) NXlog

average_value: (required) NX_FLOAT

average_value_error: (optional) NX_FLOAT

average_value_errors: (required) NX_FLOAT

description: (required) NX_CHAR

duration: (required) NX_FLOAT

maximum_value: (required) NX_FLOAT

minimum_value: (required) NX_FLOAT

time: (required) NX_FLOAT (Rank: 1, Dimensions: [nvalue])

value: (required) NX_FLOAT (Rank: 1, Dimensions: [nvalue])

POSITIONER: (optional) NXpositioner

Motor logs from cvinfo file.

average_value: (required) NX_FLOAT

average_value_error: (optional) NX_FLOAT

average_value_errors: (required) NX_FLOAT

description: (required) NX_CHAR

duration: (required) NX_FLOAT

maximum_value: (required) NX_FLOAT

minimum_value: (required) NX_FLOAT

time: (required) NX_FLOAT (Rank: 1, Dimensions: [numvalue])

value: (required) NX_FLOAT (Rank: 1, Dimensions: [numvalue])

SNSHistoTool: (required) NXnote

SNSbanking_file_name: (required) NX_CHAR

SNSmapping_file_name: (required) NX_CHAR

author: (required) NX_CHAR

command1: (required) NX_CHAR

Command string for event2nxl.

date: (required) NX_CHAR

description: (required) NX_CHAR

version: (required) NX_CHAR

DATA: (required) NXdata

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

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

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

EVENT_DATA: (required) NXevent_data

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

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

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

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

instrument: (required) NXinstrument

SNSdetector_calibration_id: (required) NX_CHAR

Detector calibration id from DAS.

SNSgeometry_file_name: (required) NX_CHAR

SNStranslation_service: (required) NX_CHAR

beamline: (required) NX_CHAR

name: (required) NX_CHAR

SNS: (required) NXsource

frequency: (required) NX_FLOAT {units=NX_FREQUENCY}

name: (required) NX_CHAR

probe: (required) NX_CHAR

type: (required) NX_CHAR

DETECTOR: (required) NXdetector

azimuthal_angle: (required) NX_FLOAT (Rank: 2, Dimensions: [numx, numy]) {units=NX_ANGLE}

data_x_y: (required) NX_UINT (Rank: 2, Dimensions: [numx, numy])

expect signal=2 axes="x_pixel_offset,y_pixel_offset”

distance: (required) NX_FLOAT (Rank: 2, Dimensions: [numx, numy]) {units=NX_LENGTH}

event_index: (required) NX_UINT (Rank: 1, Dimensions: [numpulses])

event_pixel_id: (required) NX_UINT (Rank: 1, Dimensions: [numevents])

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

pixel_id: (required) NX_UINT (Rank: 2, Dimensions: [numx, numy])

polar_angle: (required) NX_FLOAT (Rank: 2, Dimensions: [numx, numy]) {units=NX_ANGLE}

pulse_time: (required) NX_FLOAT (Rank: 1, Dimensions: [numpulses]) {units=NX_TIME}

total_counts: (required) NX_UINT

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

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

origin: (required) NXgeometry

orientation: (required) NXorientation

value: (required) NX_FLOAT (Rank: 1, Dimensions: [6])

Six out of nine rotation parameters.

shape: (required) NXshape

description: (required) NX_CHAR

shape: (required) NX_CHAR

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

translation: (required) NXtranslation

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

DISK_CHOPPER: (optional) NXdisk_chopper

distance: (required) NX_FLOAT {units=NX_LENGTH}

moderator: (required) NXmoderator

coupling_material: (required) NX_CHAR

distance: (required) NX_FLOAT {units=NX_LENGTH}

temperature: (required) NX_FLOAT {units=NX_TEMPERATURE}

type: (required) NX_CHAR

APERTURE: (optional) NXaperture

x_pixel_offset: (required) NX_FLOAT {units=NX_LENGTH}

origin: (required) NXgeometry

orientation: (required) NXorientation

value: (required) NX_FLOAT (Rank: 1, Dimensions: [6])

Six out of nine rotation parameters.

shape: (required) NXshape

description: (required) NX_CHAR

shape: (required) NX_CHAR

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

translation: (required) NXtranslation

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

ATTENUATOR: (optional) NXattenuator

distance: (required) NX_FLOAT {units=NX_LENGTH}

POLARIZER: (optional) NXpolarizer

CRYSTAL: (optional) NXcrystal

type: (required) NX_CHAR

wavelength: (required) NX_FLOAT {units=NX_WAVELENGTH}

origin: (required) NXgeometry

description: (required) NX_CHAR

orientation: (required) NXorientation

value: (required) NX_FLOAT (Rank: 1, Dimensions: [6])

Six out of nine rotation parameters.

shape: (required) NXshape

description: (required) NX_CHAR

shape: (required) NX_CHAR

size: (required) NX_FLOAT {units=NX_LENGTH}

translation: (required) NXtranslation

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

MONITOR: (optional) NXmonitor

data: (required) NX_UINT (Rank: 1, Dimensions: [numtimechannels])

expect signal=1 axes="time_of_flight"

distance: (required) NX_FLOAT {units=NX_LENGTH}

mode: (required) NX_CHAR

time_of_flight: (required) NX_FLOAT (Rank: 1, Dimensions: [numtimechannels + 1]) {units=NX_TIME}

sample: (required) NXsample

changer_position: (required) NX_CHAR

holder: (required) NX_CHAR

identifier: (required) NX_CHAR

name: (required) NX_CHAR

Descriptive name of sample

nature: (required) NX_CHAR

USER: (required) NXuser

facility_user_id: (required) NX_CHAR

name: (required) NX_CHAR

role: (required) NX_CHAR

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