2.3.3.3.98. NXdispersion_function

Status:

base class, extends NXobject

Description:

This describes a dispersion function for a material or layer

Symbols:

n_repetitions: The number of repetitions for the repeated parameters

Groups cited:

NXdispersion_repeated_parameter, NXdispersion_single_parameter

Structure:

model_name: (optional) NX_CHAR

The name of this dispersion model.

formula: (optional) NX_CHAR

This should be a python parsable function. ...

This should be a python parsable function. Here we should provide which keywords are available and a BNF of valid grammar.

convention: (optional) NX_CHAR

The sign convention being used (n + or - ik) ...

The sign convention being used (n + or - ik)

Any of these values: n + ik | n - ik

energy_identifier: (optional) NX_CHAR

The identifier used to represent energy ...

The identifier used to represent energy in the formula. It is recommended to use E.

energy_min: (optional) NX_NUMBER {units=NX_ENERGY}

The minimum energy value at which this formula is valid.

energy_max: (optional) NX_NUMBER {units=NX_ENERGY}

The maximum energy value at which this formula is valid.

energy_unit: (optional) NX_NUMBER {units=NX_ENERGY}

The energy unit used in the formula. ...

The energy unit used in the formula. The field value is a scaling factor for the units attribute. It is recommeded to set the field value to 1 and carry all the unit scaling information in the units attribute.

wavelength_identifier: (optional) NX_CHAR

The identifier useed to represent wavelength ...

The identifier useed to represent wavelength in the formula. It is recommended to use lambda.

wavelength_unit: (optional) NX_NUMBER {units=NX_LENGTH}

The wavelength unit used in the formula. ...

The wavelength unit used in the formula. The field value is a scaling factor for the units attribute. It is recommeded to set the field value to 1 and carry all the unit scaling information in the units attribute.

wavelength_min: (optional) NX_NUMBER {units=NX_LENGTH}

The minimum wavelength value at which this formula is valid.

wavelength_max: (optional) NX_NUMBER {units=NX_LENGTH}

The maximum wavelength value at which this formula is valid.

representation: (optional) NX_CHAR

Which representation does the formula evaluate to. ...

Which representation does the formula evaluate to. This may either be n for refractive index or eps for dielectric function. The appropriate token is then to be used inside the formula.

Any of these values: n | eps

DISPERSION_SINGLE_PARAMETER: (optional) NXdispersion_single_parameter

DISPERSION_REPEATED_PARAMETER: (optional) NXdispersion_repeated_parameter

parameter_units: (optional) NX_CHAR (Rank: 1, Dimensions: [n_repetitions])

values: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_repetitions])

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