.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXmpes_liquid.nxdl.xml -- DO NOT EDIT .. index:: ! NXmpes_liquid (application definition) ! mpes_liquid (application definition) see: mpes_liquid (application definition); NXmpes_liquid .. _NXmpes_liquid: ============= NXmpes_liquid ============= **Status**: *application definition* (contribution), extends :ref:`NXmpes` **Description**: .. collapse:: This is the application definition for multidimensional photoelectron spectrosco ... 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. **Symbols**: No symbol table **Groups cited**: :ref:`NXcoordinate_system`, :ref:`NXentry`, :ref:`NXenvironment`, :ref:`NXsample_component`, :ref:`NXsample`, :ref:`NXtransformations` .. index:: NXentry (base class); used in application definition, NXcoordinate_system (base class); used in application definition, NXtransformations (base class); used in application definition, NXsample (base class); used in application definition, NXenvironment (base class); used in application definition, NXsample_component (base class); used in application definition **Structure**: .. _/NXmpes_liquid/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ ` .. _/NXmpes_liquid/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``NXmpes_liquid`` .. _/NXmpes_liquid/ENTRY/definition@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmpes_liquid/ENTRY/jet_coordinate_system-group: **jet_coordinate_system**: (recommended) :ref:`NXcoordinate_system` :ref:`⤆ ` .. collapse:: Orientation of the liquid jet with respect to the beam. The major flow direc ... Orientation of the liquid jet with respect to the beam. The major flow direction of the jet is defined as pointing in the -y direction. In case of flatjets this is the propagation direction of the jet after the leafs are merged completely. The surface normal is defined as pointing in the +z direction. For flat jets, normal vector of the first leaf in the half-plane oriented towards the electron detector. A 180 degree rotation around the y axis exposes the back surface of the first leaf. The z axis should be pre-rotated to coincide with the z-direction of analyzer coordinate system. For cylindrical jets the surface normal is defined to always align with the analyzer coordinate system independent of any applied rotations. .. _/NXmpes_liquid/ENTRY/jet_coordinate_system/origin-field: .. index:: origin (field) **origin**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``center of interaction`` .. _/NXmpes_liquid/ENTRY/jet_coordinate_system/y_direction-field: .. index:: y_direction (field) **y_direction**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``major propagation direction of the liquid jet`` .. _/NXmpes_liquid/ENTRY/jet_coordinate_system/z_direction-field: .. index:: z_direction (field) **z_direction**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``liquid surface normal (of first leaf for flatjets)`` .. _/NXmpes_liquid/ENTRY/jet_coordinate_system/x-field: .. index:: x (field) **x**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[-1, 0, 0]`` .. _/NXmpes_liquid/ENTRY/jet_coordinate_system/y-field: .. index:: y (field) **y**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, 1, 0]`` .. _/NXmpes_liquid/ENTRY/jet_coordinate_system/z-field: .. index:: z (field) **z**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, 0, 1]`` .. _/NXmpes_liquid/ENTRY/jet_coordinate_system/depends_on-field: .. index:: depends_on (field) **depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Link to transformations defining the base jet coordinate system, which is ... Link to transformations defining the base jet coordinate system, which is defined such that the positive z-axis points along the liquid surface normal, and the y-axis points along the major jet propagation direction. .. _/NXmpes_liquid/ENTRY/jet_coordinate_system/TRANSFORMATIONS-group: :bolditalic:`TRANSFORMATIONS`: (optional) :ref:`NXtransformations` :ref:`⤆ ` .. collapse:: Set of transformations, describing the orientation of the jet coordinate s ... Set of transformations, describing the orientation of the jet coordinate system with respect to the beam coordinate system (.). .. _/NXmpes_liquid/ENTRY/SAMPLE-group: :bolditalic:`SAMPLE`: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXmpes_liquid/ENTRY/SAMPLE/thickness-field: .. index:: thickness (field) **thickness**: (recommended) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. collapse:: Thickness of the sample in normal direction to the surface that is probed, ... Thickness of the sample in normal direction to the surface that is probed, e.g., diameter of capillary (round jets) or thickness of the leaf (flat jets). .. _/NXmpes_liquid/ENTRY/SAMPLE/flow_rate-field: .. index:: flow_rate (field) **flow_rate**: (recommended) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. collapse:: Flow rate of the liquid into the chamber, i.e., ... Flow rate of the liquid into the chamber, i.e., through the microjet capillary (or in case of a flat jet: both capillaries). Unit should be NX_VOLUME / NX_TIME. .. _/NXmpes_liquid/ENTRY/SAMPLE/shape-field: .. index:: shape (field) **shape**: (required) :ref:`NX_CHAR ` Any of these values: ``round`` | ``flat`` .. _/NXmpes_liquid/ENTRY/SAMPLE/nozzle_material-field: .. index:: nozzle_material (field) **nozzle_material**: (recommended) :ref:`NX_CHAR ` .. collapse:: Material the microjet nozzle is made of ... Material the microjet nozzle is made of (users are encouraged to expand on that in group history/sample_preparation). .. _/NXmpes_liquid/ENTRY/SAMPLE/depends_on-field: .. index:: depends_on (field) **depends_on**: (recommended) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Reference to the transformation describing the orientation of the jet ... Reference to the transformation describing the orientation of the jet relative to a defined coordinate system. .. _/NXmpes_liquid/ENTRY/SAMPLE/temperature_env-group: **temperature_env**: (optional) :ref:`NXenvironment` :ref:`⤆ ` .. collapse:: The temperature set for the liquid jet or the injection assembly. ... The temperature set for the liquid jet or the injection assembly. Details may be added through instances of NXsensor/NXactuator on how this temperature value is obtained (whether a chiller unit was used, point of cooling, temperature reading etc.) and where this value would be expected (estimate for the jet assembly, the liquid prior to injection, or at the interaction point taking into account evaporative cooling etc.). .. _/NXmpes_liquid/ENTRY/SAMPLE/gas_pressure_env-group: **gas_pressure_env**: (optional) :ref:`NXenvironment` :ref:`⤆ ` .. collapse:: Pressure in the interaction chamber under operation conditions and actuato ... Pressure in the interaction chamber under operation conditions and actuators/sensors controlling/measuring it. .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations-group: **transformations**: (recommended) :ref:`NXtransformations` :ref:`⤆ ` .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_rotation-field: .. index:: jet_surface_rotation (field) **jet_surface_rotation**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` Rotation of the liquid surface normal around the major propagation direction. .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_rotation@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_rotation@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[0, 1, 0]`` .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_rotation@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``jet_surface_tilt`` .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_tilt-field: .. index:: jet_surface_tilt (field) **jet_surface_tilt**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: Tilt of the liquid surface normal around the axis perpendicular to the m ... Tilt of the liquid surface normal around the axis perpendicular to the major propagation direction. .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_tilt@transformation_type-attribute: .. index:: transformation_type (field attribute) **@transformation_type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``rotation`` .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_tilt@vector-attribute: .. index:: vector (field attribute) **@vector**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` Obligatory value: ``[1, 0, 0]`` .. _/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_tilt@depends_on-attribute: .. index:: depends_on (field attribute) **@depends_on**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: This should point to the coordinate system defined in ... This should point to the coordinate system defined in /entry/jet_coordinate_system. .. _/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT-group: **solvent**\ :bolditalic:`SOLVENT`: (required) :ref:`NXsample_component` :ref:`⤆ ` .. collapse:: Solvent substance of the liquid jet. ... Solvent substance of the liquid jet. 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). .. _/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/description-field: .. index:: description (field) **description**: (recommended) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/chemical_formula-field: .. index:: chemical_formula (field) **chemical_formula**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Molecular or structural formula of the solvent. .. _/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/chem_id_cas-field: .. index:: chem_id_cas (field) **chem_id_cas**: (recommended) :ref:`NX_CHAR ` .. _/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/ph_value-field: .. index:: ph_value (field) **ph_value**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_UNITLESS `} Measured pH value of the solution. .. _/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/ph_adjustment-field: .. index:: ph_adjustment (field) **ph_adjustment**: (optional) :ref:`NX_BOOLEAN ` .. collapse:: Whether or not agents for pH adjustment were added to the solution. ... Whether or not agents for pH adjustment were added to the solution. In this case, users are encouraged to expand on that in the ``history`` group or add a corresponding solute group. .. _/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/mol_fraction-field: .. index:: mol_fraction (field) **mol_fraction**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. collapse:: Molarity of the solvent in the solution. ... Molarity of the solvent in the solution. Unit should be 1 / NX_VOLUME. .. _/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE-group: **solute**\ :bolditalic:`SOLUTE`: (required) :ref:`NXsample_component` :ref:`⤆ ` .. collapse:: Solute substance solved in a given solvent. ... Solute substance solved in a given solvent. This also accounts for multiple solutes if more than one is given. .. _/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/description-field: .. index:: description (field) **description**: (recommended) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/chemical_formula-field: .. index:: chemical_formula (field) **chemical_formula**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Molecular or structural formula of the solute. .. _/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/chem_id_cas-field: .. index:: chem_id_cas (field) **chem_id_cas**: (recommended) :ref:`NX_CHAR ` .. _/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/mol_fraction-field: .. index:: mol_fraction (field) **mol_fraction**: (recommended) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} .. collapse:: Molarity of the solute in the solution. ... Molarity of the solute in the solution. Unit should be 1 / NX_VOLUME .. _/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/solvent-field: .. index:: solvent (field) **solvent**: (required) :ref:`NX_CHAR ` Specifies the parent solvent entry of the solution. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXmpes_liquid/ENTRY-group ` * :ref:`/NXmpes_liquid/ENTRY/definition-field ` * :ref:`/NXmpes_liquid/ENTRY/definition@version-attribute ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system-group ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system/depends_on-field ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system/origin-field ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system/TRANSFORMATIONS-group ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system/x-field ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system/y-field ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system/y_direction-field ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system/z-field ` * :ref:`/NXmpes_liquid/ENTRY/jet_coordinate_system/z_direction-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE-group ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/depends_on-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/flow_rate-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/gas_pressure_env-group ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/nozzle_material-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/shape-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE-group ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/chem_id_cas-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/chemical_formula-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/description-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/mol_fraction-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/name-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/soluteSOLUTE/solvent-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT-group ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/chem_id_cas-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/chemical_formula-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/description-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/mol_fraction-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/name-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/ph_adjustment-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/solventSOLVENT/ph_value-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/temperature_env-group ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/thickness-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations-group ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_rotation-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_rotation@depends_on-attribute ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_rotation@transformation_type-attribute ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_rotation@vector-attribute ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_tilt-field ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_tilt@depends_on-attribute ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_tilt@transformation_type-attribute ` * :ref:`/NXmpes_liquid/ENTRY/SAMPLE/transformations/jet_surface_tilt@vector-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXmpes_liquid.nxdl.xml