.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXdispersion_function.nxdl.xml -- DO NOT EDIT .. index:: ! NXdispersion_function (base class) ! dispersion_function (base class) see: dispersion_function (base class); NXdispersion_function .. _NXdispersion_function: ===================== NXdispersion_function ===================== **Status**: base class, extends :ref:`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**: :ref:`NXdispersion_repeated_parameter`, :ref:`NXdispersion_single_parameter` .. index:: NXdispersion_single_parameter (base class); used in base class, NXdispersion_repeated_parameter (base class); used in base class **Structure**: .. _/NXdispersion_function/model_name-field: .. index:: model_name (field) **model_name**: (optional) :ref:`NX_CHAR ` The name of this dispersion model. .. _/NXdispersion_function/formula-field: .. index:: formula (field) **formula**: (optional) :ref:`NX_CHAR ` .. collapse:: 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. .. _/NXdispersion_function/convention-field: .. index:: convention (field) **convention**: (optional) :ref:`NX_CHAR ` .. collapse:: The sign convention being used (n + or - ik) ... The sign convention being used (n + or - ik) Any of these values: ``n + ik`` | ``n - ik`` .. _/NXdispersion_function/energy_identifier-field: .. index:: energy_identifier (field) **energy_identifier**: (optional) :ref:`NX_CHAR ` .. collapse:: The identifier used to represent energy ... The identifier used to represent energy in the formula. It is recommended to use `E`. .. _/NXdispersion_function/energy_min-field: .. index:: energy_min (field) **energy_min**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ENERGY `} The minimum energy value at which this formula is valid. .. _/NXdispersion_function/energy_max-field: .. index:: energy_max (field) **energy_max**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ENERGY `} The maximum energy value at which this formula is valid. .. _/NXdispersion_function/energy_unit-field: .. index:: energy_unit (field) **energy_unit**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ENERGY `} .. collapse:: 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. .. _/NXdispersion_function/wavelength_identifier-field: .. index:: wavelength_identifier (field) **wavelength_identifier**: (optional) :ref:`NX_CHAR ` .. collapse:: The identifier useed to represent wavelength ... The identifier useed to represent wavelength in the formula. It is recommended to use `lambda`. .. _/NXdispersion_function/wavelength_unit-field: .. index:: wavelength_unit (field) **wavelength_unit**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} .. collapse:: 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. .. _/NXdispersion_function/wavelength_min-field: .. index:: wavelength_min (field) **wavelength_min**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} The minimum wavelength value at which this formula is valid. .. _/NXdispersion_function/wavelength_max-field: .. index:: wavelength_max (field) **wavelength_max**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} The maximum wavelength value at which this formula is valid. .. _/NXdispersion_function/representation-field: .. index:: representation (field) **representation**: (optional) :ref:`NX_CHAR ` .. collapse:: 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`` .. _/NXdispersion_function/DISPERSION_SINGLE_PARAMETER-group: **DISPERSION_SINGLE_PARAMETER**: (optional) :ref:`NXdispersion_single_parameter` .. _/NXdispersion_function/DISPERSION_REPEATED_PARAMETER-group: **DISPERSION_REPEATED_PARAMETER**: (optional) :ref:`NXdispersion_repeated_parameter` .. _/NXdispersion_function/DISPERSION_REPEATED_PARAMETER/parameter_units-field: .. index:: parameter_units (field) **parameter_units**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [n_repetitions]) :ref:`⤆ ` .. _/NXdispersion_function/DISPERSION_REPEATED_PARAMETER/values-field: .. index:: values (field) **values**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_repetitions]) :ref:`⤆ ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXdispersion_function/convention-field ` * :ref:`/NXdispersion_function/DISPERSION_REPEATED_PARAMETER-group ` * :ref:`/NXdispersion_function/DISPERSION_REPEATED_PARAMETER/parameter_units-field ` * :ref:`/NXdispersion_function/DISPERSION_REPEATED_PARAMETER/values-field ` * :ref:`/NXdispersion_function/DISPERSION_SINGLE_PARAMETER-group ` * :ref:`/NXdispersion_function/energy_identifier-field ` * :ref:`/NXdispersion_function/energy_max-field ` * :ref:`/NXdispersion_function/energy_min-field ` * :ref:`/NXdispersion_function/energy_unit-field ` * :ref:`/NXdispersion_function/formula-field ` * :ref:`/NXdispersion_function/model_name-field ` * :ref:`/NXdispersion_function/representation-field ` * :ref:`/NXdispersion_function/wavelength_identifier-field ` * :ref:`/NXdispersion_function/wavelength_max-field ` * :ref:`/NXdispersion_function/wavelength_min-field ` * :ref:`/NXdispersion_function/wavelength_unit-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXdispersion_function.nxdl.xml