2.3.3.3.168. 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 multidimensional/multivariate fit.)

Groups cited:

NXdata, NXfit_function

Structure:

@default: (optional) NX_CHAR

Declares which child group contains a path leading ...

Declares which child group contains a path leading to a NXdata group.

It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion.

label: (optional) NX_CHAR

Human-readable label which specifies which concept/entity ...

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

total_area: (optional) NX_NUMBER {units=NX_ANY}

Total area under the curve.

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, ...

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

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/NXpeak.nxdl.xml