3.3.29. NXmonitor

Status:

base class, extends NXobject, version 1.0

Description:

Template of monitor data. It is similar to the NXdata groups containing monitor data and its associated dimension scale, e.g. time_of_flight or wavelength in pulsed neutron instruments. However, it may also include integrals, or scalar monitor counts, which are often used in both in both pulsed and steady-state instrumentation.

Symbols:

No symbol table

Groups cited:

NXgeometry, NXlog

Structure:

mode: NX_CHAR

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

Any of these values: monitor | timer

start_time: NX_DATE_TIME

Starting time of measurement

end_time: NX_DATE_TIME

Ending time of measurement

preset: NX_NUMBER {units=NX_ANY}

preset value for time or monitor

distance: NX_FLOAT {units=NX_LENGTH}

Distance of monitor from sample

range[2]: NX_FLOAT {units=NX_ANY}

Range (X-axis, Time-of-flight, etc.) over which the integral was calculated

integral: NX_NUMBER {units=NX_ANY}

Total integral monitor counts

type: NX_CHAR

Any of these values: Fission Chamber | Scintillator

time_of_flight[ref(efficiency)]: NX_FLOAT {units=NX_TIME_OF_FLIGHT}

Time-of-flight

efficiency[ref(i)]: NX_NUMBER {units=NX_DIMENSIONLESS}

Monitor efficiency

data[n]: NX_NUMBER {units=NX_ANY}

Monitor data

The signal and axes attributes take the same definitions as in NXdata:

signal:signal=1 means this is the plottable data axes:axes="names" where names are defined as a colon-delimited string within this attribute in the C-order of the data array

@signal: NX_POSINT

as defined for NXdata

@axes: NX_CHAR

as defined for NXdata

sampled_fraction: NX_FLOAT {units=NX_DIMENSIONLESS}

Proportion of incident beam sampled by the monitor (0<x<1)

count_time: NX_FLOAT {units=NX_TIME}

Elapsed actual counting time, can be an array of size np when scanning. This is not the difference of the calendar time but the time the instrument was really counting, without pauses or times lost due beam unavailability

integral_log: NXlog

Time variation of monitor counts

(geometry): NXgeometry

Geometry of the monitor

Source:

Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXmonitor.nxdl.xml