3.3.3.131. NXpeak

Status:

base class, extends NXobject

Description:

Description of peaks, their functional form or measured support.

Symbols:

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

n_support: Number of support points

Groups cited:

NXcollection

Structure:

label: (optional) NX_CHAR

Human-readable identifier to specify which concept/entity ...

Human-readable identifier to specify which concept/entity the peak represents/identifies.

peak_model: (optional) NX_CHAR

Is the peak described analytically via a functional form ...

Is the peak described analytically via a functional form or is it empirically defined via measured/reported intensity/counts as a function of an independent variable.

If the functional form is not empirical or gaussian, users should enter other for the peak_model and add relevant details in the NXcollection.

Any of these values: empirical | gaussian | lorentzian | other

position: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_support]) {units=NX_ANY}

In the case of an empirical description of the peak and its shoulders, ...

In the case of an empirical description of the peak and its shoulders, this array holds the position values for the independent variable.

intensity: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_support]) {units=NX_ANY}

In the case of an empirical description of the peak and its shoulders, ...

In the case of an empirical description of the peak and its shoulders, this array holds the intensity/count values at each position.

COLLECTION: (optional) NXcollection

In the case of an analytical description (or if peak_model is other) this ...

In the case of an analytical description (or if peak_model is other) this collection holds parameter of (and eventually) the functional form. For example in the case of Gaussians mu, sigma, cut-off values, and background intensity are relevant parameter.

Hypertext Anchors

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

NXDL Source:

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