2.3.3.3.199. NXspectrum_set

Status:

base class, extends NXobject

Description:

Base class container for reporting a set of spectra. ...

Base class container for reporting a set of spectra.

The mostly commonly used scanning methods are supported. That is one-, two-, three-dimensional regularly sampled ROIs.

For randomly or dissimilarly spaced scan points use collection instead.

Symbols:

n_p: Number of scan points (slowest dimension).

n_z: Number of pixel in the slow direction.

n_y: Number of pixel in the fast direction.

n_x: Number of pixel in the fastest direction.

n_energy: Number of energy bins.

Groups cited:

NXdata, NXprocess, NXprogram, NXserialized

Structure:

PROCESS: (optional) NXprocess

Details how spectra were processed from the detector readings.

mode: (optional) NX_CHAR

Imaging (data collection) mode of the instrument during acquisition ...

Imaging (data collection) mode of the instrument during acquisition of the data in this NXspectrum_set instance.

detector_identifier: (optional) NX_CHAR

Link or name of an :ref:`NXdetector` instance with which the data were ...

Link or name of an NXdetector instance with which the data were collected.

source: (optional) NXserialized

Resolvable data artifact (e.g. filename) from which all values in the :ref:` ...

Resolvable data artifact (e.g. filename) from which all values in the NXdata instances in this NXspectrum_set were loaded during parsing.

Possibility to document from which specific other serialized resource as the source pieces of information were processed when using NeXus as a semantic file format to serialize that information differently.

The group in combination with an added field absolute_path therein adds context.

absolute_path: (optional) NX_CHAR

Reference to a location inside the artifact that points to the specific gr ...

Reference to a location inside the artifact that points to the specific group of values that were processed if the artifacts contains several groups of values and thus further resolving of ambiguities is required.

PROGRAM: (optional) NXprogram

spectrum_zerod: (optional) NXdata

One spectrum for one pixel in a ROI aka spot measurement.

intensity: (optional) NX_NUMBER (Rank: 2, Dimensions: [n_x, n_energy]) {units=NX_UNITLESS} ⤆

Counts

@long_name: (optional) NX_CHAR ⤆

Counts

axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY} ⤆

Energy axis

@long_name: (optional) NX_CHAR ⤆

Energy

spectrum_oned: (optional) NXdata

One spectrum for each pixel of an equidistantly ...

One spectrum for each pixel of an equidistantly sampled one-dimensional ROI.

intensity: (optional) NX_NUMBER (Rank: 2, Dimensions: [n_x, n_energy]) {units=NX_UNITLESS} ⤆

Counts

@long_name: (optional) NX_CHAR ⤆

Counts

axis_x: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_x]) {units=NX_LENGTH} ⤆

Coordinate along x direction.

@long_name: (optional) NX_CHAR ⤆

Pixel coordinate along x direction

axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY} ⤆

Energy axis

@long_name: (optional) NX_CHAR ⤆

Energy

spectrum_twod: (optional) NXdata

One spectrum for each pixel of an equidistantly ...

One spectrum for each pixel of an equidistantly sampled two-dimensional ROI.

intensity: (optional) NX_NUMBER (Rank: 3, Dimensions: [n_y, n_x, n_energy]) {units=NX_UNITLESS} ⤆

Counts

@long_name: (optional) NX_CHAR ⤆

Counts

axis_y: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_y]) {units=NX_LENGTH} ⤆

Coordinate along y direction.

@long_name: (optional) NX_CHAR ⤆

Pixel coordinate along y direction

axis_x: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_x]) {units=NX_LENGTH} ⤆

Coordinate along x direction.

@long_name: (optional) NX_CHAR ⤆

Pixel coordinate along x direction

axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY} ⤆

Energy axis

@long_name: (optional) NX_CHAR ⤆

Energy

spectrum_threed: (optional) NXdata

One spectrum for each voxel of an equidistantly ...

One spectrum for each voxel of an equidistantly sampled three-dimensional ROI.

intensity: (optional) NX_NUMBER (Rank: 4, Dimensions: [n_z, n_y, n_x, n_energy]) {units=NX_UNITLESS} ⤆

Counts

@long_name: (optional) NX_CHAR ⤆

Counts

axis_z: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_z]) {units=NX_LENGTH} ⤆

Coordinate along z direction.

@long_name: (optional) NX_CHAR ⤆

Pixel coordinate along z direction

axis_y: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_y]) {units=NX_LENGTH} ⤆

Coordinate along y direction.

@long_name: (optional) NX_CHAR ⤆

Pixel coordinate along y direction

axis_x: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_x]) {units=NX_LENGTH} ⤆

Coordinate along x direction.

@long_name: (optional) NX_CHAR ⤆

Pixel coordinate along x direction

axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY} ⤆

Energy axis

@long_name: (optional) NX_CHAR ⤆

Energy

collection: (optional) NXdata

One spectrum for each scan point. This representation supports ...

One spectrum for each scan point. This representation supports equidistant energy bins. For rectangular sampling use respective one-, two-, and three-dimensional variants instead.

intensity: (optional) NX_NUMBER (Rank: 2, Dimensions: [n_p, n_energy]) {units=NX_UNITLESS} ⤆

Counts

@long_name: (optional) NX_CHAR ⤆

Counts

axis_scan_point_id: (optional) NX_INT (Rank: 1, Dimensions: [n_p]) {units=NX_UNITLESS}

Scan point identifier

@long_name: (optional) NX_CHAR

Scan point identifier

axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY} ⤆

Energy axis

@long_name: (optional) NX_CHAR ⤆

Energy

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXspectrum_set.nxdl.xml