NXsas

Status:

application definition, extends NXobject

Description:

raw, monochromatic 2-D SAS data with an area detector

This is an application definition for raw data (not processed or reduced data) from a 2-D small angle scattering instrument collected with a monochromatic beam and an area detector. It is meant to be suitable both for neutron SANS and X-ray SAXS data.

It covers all raw data from any monochromatic SAS techniques that use an area detector: SAS, WSAS, grazing incidence, GISAS

It covers all raw data from any SAS techniques that use an area detector and a monochromatic beam.

Symbols:

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

nXPixel: nXPixel description

nYPixel: nYPixel description

Groups cited:

NXcollimator, NXdata, NXdetector, NXentry, NXgeometry, NXinstrument, NXmonitor, NXmonochromator, NXsample, NXshape, NXsource

Structure:

ENTRY: (required) NXentry

@entry: (required) NX_CHAR

NeXus convention is to use entry1, entry2, … for analysis software to locate each entry

title: (required) NX_CHAR

start_time: (required) NX_DATE_TIME

end_time: (required) NX_DATE_TIME

definition: (required) NX_CHAR

Official NeXus NXDL schema to which this file conforms

Obligatory value: NXsas

instrument: (required) NXinstrument

name: (required) NX_CHAR

Name of the instrument actually used to perform the experiment

source: (required) NXsource

type: (required) NX_CHAR

type of radiation source

name: (required) NX_CHAR

Name of the radiation source

probe: (required) NX_CHAR

Any of these values: neutron | x-ray

monochromator: (required) NXmonochromator

wavelength: (required) NX_FLOAT {units=NX_WAVELENGTH}

The wavelength of the radiation

wavelength_spread: (required) NX_FLOAT

delta_lambda/lambda (\(\Delta\lambda/\lambda\)): Important for resolution calculations

collimator: (required) NXcollimator

geometry: (required) NXgeometry

shape: (required) NXshape

shape: (required) NX_CHAR

Any of these values: nxcylinder | nxbox

size: (required) NX_FLOAT {units=NX_LENGTH}

The collimation length

detector: (required) NXdetector

data[nXPixel, nYPixel]: (required) NX_NUMBER

This is area detector data, of number of x-pixel versus number of y-pixels. Since the beam center is to be determined as a step of data reduction, it is not necessary to document or assume the position of the beam center in acquired data.

distance: (required) NX_FLOAT {units=NX_LENGTH}

The distance between detector and sample

x_pixel_size: (required) NX_FLOAT {units=NX_LENGTH}

Physical size of a pixel in x-direction

y_pixel_size: (required) NX_FLOAT {units=NX_LENGTH}

Size of a pixel in y direction

polar_angle: (required) NX_FLOAT {units=NX_ANGLE}

azimuthal_angle: (required) NX_FLOAT {units=NX_ANGLE}

rotation_angle: (required) NX_FLOAT {units=NX_ANGLE}

aequatorial_angle: (required) NX_FLOAT {units=NX_ANGLE}

beam_center_x: (required) NX_FLOAT {units=NX_LENGTH}

This is the x position where the direct beam would hit the detector. This is a length, not a pixel position, and can be outside of the actual detector.

beam_center_y: (required) NX_FLOAT {units=NX_LENGTH}

This is the y position where the direct beam would hit the detector. This is a length, not a pixel position, and can be outside of the actual detector.

sample: (required) NXsample

name: (required) NX_CHAR

Descriptive name of sample

aequatorial_angle: (required) NX_FLOAT {units=NX_ANGLE}

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

integral: (required) NX_FLOAT {units=NX_ANY}

Total integral monitor counts

data: (required) NXdata

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

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

/NXsas/ENTRY-group

#nxsas-entry-group

/NXsas/ENTRY/control-group

#nxsas-entry-control-group

/NXsas/ENTRY/control/integral-field

#nxsas-entry-control-integral-field

/NXsas/ENTRY/control/mode-field

#nxsas-entry-control-mode-field

/NXsas/ENTRY/control/preset-field

#nxsas-entry-control-preset-field

/NXsas/ENTRY/data-group

#nxsas-entry-data-group

/NXsas/ENTRY/data/data-link

#nxsas-entry-data-data-link

/NXsas/ENTRY/definition-field

#nxsas-entry-definition-field

/NXsas/ENTRY/end_time-field

#nxsas-entry-end-time-field

/NXsas/ENTRY/instrument-group

#nxsas-entry-instrument-group

/NXsas/ENTRY/instrument/collimator-group

#nxsas-entry-instrument-collimator-group

/NXsas/ENTRY/instrument/collimator/geometry-group

#nxsas-entry-instrument-collimator-geometry-group

/NXsas/ENTRY/instrument/collimator/geometry/shape-group

#nxsas-entry-instrument-collimator-geometry-shape-group

/NXsas/ENTRY/instrument/collimator/geometry/shape/shape-field

#nxsas-entry-instrument-collimator-geometry-shape-shape-field

/NXsas/ENTRY/instrument/collimator/geometry/shape/size-field

#nxsas-entry-instrument-collimator-geometry-shape-size-field

/NXsas/ENTRY/instrument/detector-group

#nxsas-entry-instrument-detector-group

/NXsas/ENTRY/instrument/detector/aequatorial_angle-field

#nxsas-entry-instrument-detector-aequatorial-angle-field

/NXsas/ENTRY/instrument/detector/azimuthal_angle-field

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

/NXsas/ENTRY/instrument/detector/beam_center_x-field

#nxsas-entry-instrument-detector-beam-center-x-field

/NXsas/ENTRY/instrument/detector/beam_center_y-field

#nxsas-entry-instrument-detector-beam-center-y-field

/NXsas/ENTRY/instrument/detector/data-field

#nxsas-entry-instrument-detector-data-field

/NXsas/ENTRY/instrument/detector/distance-field

#nxsas-entry-instrument-detector-distance-field

/NXsas/ENTRY/instrument/detector/polar_angle-field

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

/NXsas/ENTRY/instrument/detector/rotation_angle-field

#nxsas-entry-instrument-detector-rotation-angle-field

/NXsas/ENTRY/instrument/detector/x_pixel_size-field

#nxsas-entry-instrument-detector-x-pixel-size-field

/NXsas/ENTRY/instrument/detector/y_pixel_size-field

#nxsas-entry-instrument-detector-y-pixel-size-field

/NXsas/ENTRY/instrument/monochromator-group

#nxsas-entry-instrument-monochromator-group

/NXsas/ENTRY/instrument/monochromator/wavelength-field

#nxsas-entry-instrument-monochromator-wavelength-field

/NXsas/ENTRY/instrument/monochromator/wavelength_spread-field

#nxsas-entry-instrument-monochromator-wavelength-spread-field

/NXsas/ENTRY/instrument/name-field

#nxsas-entry-instrument-name-field

/NXsas/ENTRY/instrument/source-group

#nxsas-entry-instrument-source-group

/NXsas/ENTRY/instrument/source/name-field

#nxsas-entry-instrument-source-name-field

/NXsas/ENTRY/instrument/source/probe-field

#nxsas-entry-instrument-source-probe-field

/NXsas/ENTRY/instrument/source/type-field

#nxsas-entry-instrument-source-type-field

/NXsas/ENTRY/sample-group

#nxsas-entry-sample-group

/NXsas/ENTRY/sample/aequatorial_angle-field

#nxsas-entry-sample-aequatorial-angle-field

/NXsas/ENTRY/sample/name-field

#nxsas-entry-sample-name-field

/NXsas/ENTRY/start_time-field

#nxsas-entry-start-time-field

/NXsas/ENTRY/title-field

#nxsas-entry-title-field

/NXsas/ENTRY@entry-attribute

#nxsas-entry-entry-attribute

NXDL Source:

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