3.3.3.7. NXsnshisto

Status:

contributed definition, extends NXobject

Description:

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

Symbols:

No symbol table
Groups cited:
NXaperture, NXattenuator, NXcollection, NXcrystal, NXdata, NXdetector, NXdisk_chopper, NXentry, NXfermi_chopper, 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: NXsnshisto

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

description: (required) NX_CHAR

duration: (required) NX_FLOAT

maximum_value: (required) NX_FLOAT

minimum_value: (required) NX_FLOAT

time[nvalue]: (required) NX_FLOAT

value[nvalue]: (required) NX_FLOAT

(positioner): (optional) NXpositioner

Motor logs from cvinfo file.

average_value: (required) NX_FLOAT

average_value_error: (required) NX_FLOAT

description: (required) NX_CHAR

duration: (required) NX_FLOAT

maximum_value: (required) NX_FLOAT

minimum_value: (required) NX_FLOAT

time[numvalue]: (required) NX_FLOAT

value[numvalue]: (required) NX_FLOAT

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 event2histo_nxl.

date: (required) NX_CHAR

description: (required) NX_CHAR

version: (required) NX_CHAR

(data): (required) NXdata

data –> /NXentry/NXinstrument/NXdetector/data

data_x_time_of_flight –> /NXentry/NXinstrument/NXdetector/data_x_time_of_flight

data_x_y –> /NXentry/NXinstrument/NXdetector/data_x_y

data_y_time_of_flight –> /NXentry/NXinstrument/NXdetector/data_y_time_of_flight

pixel_id –> /NXentry/NXinstrument/NXdetector/pixel_id

time_of_flight –> /NXentry/NXinstrument/NXdetector/time_of_flight

total_counts –> /NXentry/NXinstrument/NXdetector/total_counts

x_pixel_offset –> /NXentry/NXinstrument/NXdetector/x_pixel_offset

y_pixel_offset –> /NXentry/NXinstrument/NXdetector/y_pixel_offset

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[numx, numy]: (required) NX_FLOAT {units=NX_ANGLE}

data[numx, numy, numtof]: (required) NX_UINT

data_x_time_of_flight[numx, numtof]: (required) NX_UINT

data_x_y[numx, numy]: (required) NX_UINT

data_y_time_of_flight[numy, numtof]: (required) NX_UINT

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

pixel_id[numx, numy]: (required) NX_UINT

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

time_of_flight[numtof + 1]: (required) NX_FLOAT {units=NX_TIME_OF_FLIGHT}

total_counts: (required) NX_UINT

x_pixel_offset[numx]: (required) NX_FLOAT {units=NX_LENGTH}

y_pixel_offset[numy]: (required) NX_FLOAT {units=NX_LENGTH}

origin: (required) NXgeometry

orientation: (required) NXorientation

value[6]: (required) NX_FLOAT

Six out of nine rotation parameters.

shape: (required) NXshape

description: (required) NX_CHAR

shape: (required) NX_CHAR

size[3]: (required) NX_FLOAT {units=NX_LENGTH}

translation: (required) NXtranslation

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

(disk_chopper): (optional) NXdisk_chopper

Original specification called for NXchopper, which is not a valid NeXus base class. Select either NXdisk_chopper or NXfermi_chopper, as appropriate.

distance: (required) NX_FLOAT {units=NX_LENGTH}

(fermi_chopper): (optional) NXfermi_chopper

Original specification called for NXchopper, which is not a valid NeXus base class. Select either NXdisk_chopper or NXfermi_chopper, as appropriate.

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[6]: (required) NX_FLOAT

Six out of nine rotation parameters.

shape: (required) NXshape

description: (required) NX_CHAR

shape: (required) NX_CHAR

size[3]: (required) NX_FLOAT {units=NX_LENGTH}

translation: (required) NXtranslation

distance[3]: (required) NX_FLOAT {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[6]: (required) NX_FLOAT

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[3]: (required) NX_FLOAT {units=NX_LENGTH}

(monitor): (optional) NXmonitor

data[numtimechannels]: (required) NX_UINT

distance: (required) NX_FLOAT {units=NX_LENGTH}

mode: (required) NX_CHAR

time_of_flight[numtimechannels + 1]: (required) NX_FLOAT {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

NXDL Source:
https://github.com/nexusformat/definitions/blob/master/contributed_definitions/NXsnshisto.nxdl.xml