diff --git a/contributed_definitions/NXmpes_liquid.nxdl.xml b/contributed_definitions/NXmpes_liquid.nxdl.xml index 922167cf01..1695c8d252 100644 --- a/contributed_definitions/NXmpes_liquid.nxdl.xml +++ b/contributed_definitions/NXmpes_liquid.nxdl.xml @@ -23,8 +23,9 @@ --> - This is the application definition for multidimensional photoelectron - spectroscopy on liquids. + This is the application definition for multidimensional photoelectron spectroscopy on liquids. + It extends the NXmpes application definition by metadata for characterizing liquidjet composition + and geometry. @@ -34,44 +35,40 @@ - - + + + Transformations describing base geometry in the experiment. + Usually defaults to the beam in z direction and gravity in -y direction. + + - Transformations describing base geometry in the experiment. - Usually defaults to the beam in z direction and gravity in -y direction. + The coordinate system frame of the analyzer. + If no direction attribute is specified, + the optical axis of the analyzer follows the positive z-direction. - + - The optical axis of the analyzer + Direction of gravity in the analyzer coordinate system. - - - Direction of gravity in the analyzer coordinate system. - - - - - Direction of the photon beam in the analyzer coordinate system. - - - - + + + + Direction of the photon beam in the analyzer coordinate system. + + + + + The direction of the analyzer optical axis. + If this is not specified the optical axis points + in the positive jet direction. + It is recommended to always specify the axis + direction explicitly (even for the default case). + + + - - - In the case of a fixed temperature measurement this is the scalar temperature of the sample. - In the case of an experiment in which the temperature is changed and recoded, - this is an array of length m of temperatures. - - - - - Electric field applied to the sample with respect to - ground / the system, e.g., via biasing. - - Thickness of the sample in normal direction to the surface that is probed, @@ -81,7 +78,7 @@ Flow rate of the liquid into the chamber, i.e., - throught the microjet capillary (or in case of a flat jet: both capillaries). + through the microjet capillary (or in case of a flat jet: both capillaries). Unit should be NX_VOLUME / NX_TIME. @@ -106,8 +103,8 @@ Transformations describing the transformation chain of the liquid jet flow direction and optionally the flat jet normal. The vector of the major flow direction of the - liquid jet from the injection into the chamber. - Along the cylinder axis for single, cylidrical jets, and parallel to the leaf plane for flatjets. + liquid jet from the point of injection into the chamber. + Along the cylinder axis for single, cylindrical jets, and parallel to the leaf plane for flatjets. @@ -177,7 +174,10 @@ Solvent substance of the liquid jet. - This also accounts for multiple jets if more than one solvent is given. + For flat jets, this group may appear more than once. + If a mixture of solvents is used, + the one with the highest mol fraction should be designated solvent, + and the other(s) solute(s) (see solute group). @@ -195,7 +195,8 @@ Whether or not agents for pH adjustment were added to the solution. - In this case, users are encouraged to expand on that in preparation_description. + In this case, users are encouraged to expand on that in preparation_description + or add a corresponding solute group. @@ -231,17 +232,5 @@ - - - - - - - - - Data containing the energy axis. - - - diff --git a/contributed_definitions/nyaml/NXmpes_liquid.yaml b/contributed_definitions/nyaml/NXmpes_liquid.yaml index 4264125128..485eda3598 100644 --- a/contributed_definitions/nyaml/NXmpes_liquid.yaml +++ b/contributed_definitions/nyaml/NXmpes_liquid.yaml @@ -1,5 +1,7 @@ doc: | This is the application definition for multidimensional photoelectron spectroscopy on liquids. + It extends the NXmpes application definition by metadata for characterizing liquidjet composition + and geometry. category: application NXmpes_liquid(NXmpes): (NXentry): @@ -7,35 +9,31 @@ NXmpes_liquid(NXmpes): \@version: enumeration: ["NXmpes_liquid"] (NXinstrument): - (NXelectronanalyser): - instrument_orientation(NXtransformations): + instrument_orientation(NXtransformations): + doc: | + Transformations describing base geometry in the experiment. + Usually defaults to the beam in z direction and gravity in -y direction. + exists: optional + analyzer_optical_axis(NX_NUMBER): + exists: recommended doc: | - Transformations describing base geometry in the experiment. - Usually defaults to the beam in z direction and gravity in -y direction. - exists: optional - analyzer_optical_axis(NX_NUMBER): - exists: recommended + The coordinate system frame of the analyzer. + If no direction attribute is specified, + the optical axis of the analyzer follows the positive z-direction. + \@gravity: + doc: | + Direction of gravity in the analyzer coordinate system. + \@beam_direction: + doc: | + Direction of the photon beam in the analyzer coordinate system. + \@direction: doc: | - The optical axis of the analyzer - \@gravity: - doc: | - Direction of gravity in the analyzer coordinate system. - \@beam_direction: - doc: | - Direction of the photon beam in the analyzer coordinate system. + The direction of the analyzer optical axis. + If this is not specified the optical axis points + in the positive jet direction. + It is recommended to always specify the axis + direction explicitly (even for the default case). (NXsample): - chemical_formula: - exists: optional - doc: | - In the case of a fixed temperature measurement this is the scalar temperature of the sample. - In the case of an experiment in which the temperature is changed and recoded, - this is an array of length m of temperatures. - electric_field(NX_FLOAT): - exists: recommended - unit: NX_VOLTAGE - doc: | - Electric field applied to the sample with respect to - ground / the system, e.g., via biasing. thickness(NX_FLOAT): exists: recommended unit: NX_LENGTH @@ -47,7 +45,7 @@ NXmpes_liquid(NXmpes): unit: NX_ANY doc: | Flow rate of the liquid into the chamber, i.e., - throught the microjet capillary (or in case of a flat jet: both capillaries). + through the microjet capillary (or in case of a flat jet: both capillaries). Unit should be NX_VOLUME / NX_TIME. shape(NX_CHAR): enumeration: ["round", "flat"] @@ -64,8 +62,8 @@ NXmpes_liquid(NXmpes): doc: | Transformations describing the transformation chain of the liquid jet flow direction and optionally the flat jet normal. The vector of the major flow direction of the - liquid jet from the injection into the chamber. - Along the cylinder axis for single, cylidrical jets, and parallel to the leaf plane for flatjets. + liquid jet from the point of injection into the chamber. + Along the cylinder axis for single, cylindrical jets, and parallel to the leaf plane for flatjets. jet_direction(NX_NUMBER): doc: | The coordinate system frame of the liquid jet direction. @@ -122,7 +120,10 @@ NXmpes_liquid(NXmpes): solventSOLVENT(NXsample_component): doc: | Solvent substance of the liquid jet. - This also accounts for multiple jets if more than one solvent is given. + For flat jets, this group may appear more than once. + If a mixture of solvents is used, + the one with the highest mol fraction should be designated solvent, + and the other(s) solute(s) (see solute group). description(NX_CHAR): exists: recommended name(NX_CHAR): @@ -140,7 +141,8 @@ NXmpes_liquid(NXmpes): exists: optional doc: | Whether or not agents for pH adjustment were added to the solution. - In this case, users are encouraged to expand on that in preparation_description. + In this case, users are encouraged to expand on that in preparation_description + or add a corresponding solute group. mol_fraction(NX_FLOAT): exists: optional unit: NX_ANY @@ -167,11 +169,4 @@ NXmpes_liquid(NXmpes): Unit should be 1 / NX_VOLUME solvent(NX_CHAR): doc: | - Specifies the parent solvent entry of the solution. - (NXdata): - \@axes(NX_CHAR): - enumeration: ["energy"] - energy(NX_NUMBER): - unit: NX_ENERGY - doc: | - Data containing the energy axis. \ No newline at end of file + Specifies the parent solvent entry of the solution. \ No newline at end of file