3.3.1.125. NXpeak

Status:

base class, extends NXobject

Description:

Base class for describing a peak, its functional form, and support values …

Base class for describing a peak, its functional form, and support values i.e., the discretization points at which the function has been evaluated.

Symbols:

The symbols used in the schema to specify e.g. dimensions of arrays.

dimRank: Rank of the dependent and independent data arrays (for multivariate scalar-valued fit).

Groups cited:

NXdata, NXfit_function

Structure:

@NX_class: (required) NX_CHAR

Type of the NeXus group: the name of its class. …

Type of the NeXus group: the name of its class.

Obligatory value: NXpeak

label: (optional) NX_CHAR

Human-readable label which specifies which concept/entity …

Human-readable label which specifies which concept/entity the peak represents/identifies.

data: (optional) NXdata ⤆

position: (optional) NX_NUMBER (Rank: dimRank) {units=NX_ANY}

Position values along one or more data dimensions (to hold the …

Position values along one or more data dimensions (to hold the values for the independent variable).

intensity: (optional) NX_NUMBER (Rank: dimRank) {units=NX_ANY}

This array holds the intensity/count values of the fitted peak at each position.

function: (optional) NXfit_function

The functional form of the peak. This could be a Gaussian, Lorentzian, Voigt, …

The functional form of the peak. This could be a Gaussian, Lorentzian, Voigt, etc.

total_area: (optional) NX_NUMBER {units=NX_ANY}

Total area under the curve.

Hypertext Anchors

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

NXDL Source:

https://github.com/nexusformat/definitions/blob/main/base_classes/NXpeak.nxdl.xml