.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXspe.nxdl.xml .. index:: ! NXspe (application definition) ! spe (application definition) see: spe (application definition); NXspe .. _NXspe: ===== NXspe ===== **Status**: application definition, extends :ref:`NXobject` **Description**: NXSPE Inelastic Format. Application definition for NXSPE file format. **Symbols**: No symbol table **Groups cited**: :ref:`NXcollection`, :ref:`NXdata`, :ref:`NXentry`, :ref:`NXfermi_chopper`, :ref:`NXinstrument`, :ref:`NXsample` .. index:: NXentry (base class); used in application definition, NXcollection (base class); used in application definition, NXdata (base class); used in application definition, NXinstrument (base class); used in application definition, NXfermi_chopper (base class); used in application definition, NXsample (base class); used in application definition **Structure**: .. _/NXspe/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXspe/ENTRY/program_name-field: .. index:: program_name (field) **program_name**: (required) :ref:`NX_CHAR ` .. _/NXspe/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` Official NeXus NXDL schema to which this file conforms. Any of these values: ``NXSPE`` | ``NXspe`` .. _/NXspe/ENTRY/definition@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXspe/ENTRY/NXSPE_info-group: **NXSPE_info**: (required) :ref:`NXcollection` .. _/NXspe/ENTRY/NXSPE_info/fixed_energy-field: .. index:: fixed_energy (field) **fixed_energy**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} The fixed energy used for this file. .. _/NXspe/ENTRY/NXSPE_info/ki_over_kf_scaling-field: .. index:: ki_over_kf_scaling (field) **ki_over_kf_scaling**: (required) :ref:`NX_BOOLEAN ` Indicates whether ki/kf scaling has been applied or not. .. _/NXspe/ENTRY/NXSPE_info/psi-field: .. index:: psi (field) **psi**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Orientation angle as expected in DCS-MSlice .. _/NXspe/ENTRY/data-group: **data**: (required) :ref:`NXdata` .. _/NXspe/ENTRY/data/azimuthal-field: .. index:: azimuthal (field) **azimuthal**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXspe/ENTRY/data/azimuthal_width-field: .. index:: azimuthal_width (field) **azimuthal_width**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXspe/ENTRY/data/polar-field: .. index:: polar (field) **polar**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXspe/ENTRY/data/polar_width-field: .. index:: polar_width (field) **polar_width**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXspe/ENTRY/data/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. _/NXspe/ENTRY/data/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` .. _/NXspe/ENTRY/data/error-field: .. index:: error (field) **error**: (required) :ref:`NX_NUMBER ` .. _/NXspe/ENTRY/data/energy-field: .. index:: energy (field) **energy**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} .. _/NXspe/ENTRY/INSTRUMENT-group: **INSTRUMENT**: (required) :ref:`NXinstrument` .. _/NXspe/ENTRY/INSTRUMENT/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` .. _/NXspe/ENTRY/INSTRUMENT/FERMI_CHOPPER-group: **FERMI_CHOPPER**: (required) :ref:`NXfermi_chopper` .. _/NXspe/ENTRY/INSTRUMENT/FERMI_CHOPPER/energy-field: .. index:: energy (field) **energy**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ENERGY `} .. _/NXspe/ENTRY/SAMPLE-group: **SAMPLE**: (required) :ref:`NXsample` .. _/NXspe/ENTRY/SAMPLE/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} .. _/NXspe/ENTRY/SAMPLE/seblock-field: .. index:: seblock (field) **seblock**: (required) :ref:`NX_CHAR ` .. _/NXspe/ENTRY/SAMPLE/temperature-field: .. index:: temperature (field) **temperature**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TEMPERATURE `} Hypertext Anchors ----------------- Table of hypertext anchors for all groups, fields, attributes, and links defined in this class. ============================================================================================================== ============================================================================================================== documentation (reST source) anchor web page (HTML) anchor ============================================================================================================== ============================================================================================================== :ref:`/NXspe/ENTRY-group ` :ref:`#nxspe-entry-group ` :ref:`/NXspe/ENTRY/data-group ` :ref:`#nxspe-entry-data-group ` :ref:`/NXspe/ENTRY/data/azimuthal-field ` :ref:`#nxspe-entry-data-azimuthal-field ` :ref:`/NXspe/ENTRY/data/azimuthal_width-field ` :ref:`#nxspe-entry-data-azimuthal-width-field ` :ref:`/NXspe/ENTRY/data/data-field ` :ref:`#nxspe-entry-data-data-field ` :ref:`/NXspe/ENTRY/data/distance-field ` :ref:`#nxspe-entry-data-distance-field ` :ref:`/NXspe/ENTRY/data/energy-field ` :ref:`#nxspe-entry-data-energy-field ` :ref:`/NXspe/ENTRY/data/error-field ` :ref:`#nxspe-entry-data-error-field ` :ref:`/NXspe/ENTRY/data/polar-field ` :ref:`#nxspe-entry-data-polar-field ` :ref:`/NXspe/ENTRY/data/polar_width-field ` :ref:`#nxspe-entry-data-polar-width-field ` :ref:`/NXspe/ENTRY/definition-field ` :ref:`#nxspe-entry-definition-field ` :ref:`/NXspe/ENTRY/definition@version-attribute ` :ref:`#nxspe-entry-definition-version-attribute ` :ref:`/NXspe/ENTRY/INSTRUMENT-group ` :ref:`#nxspe-entry-instrument-group ` :ref:`/NXspe/ENTRY/INSTRUMENT/FERMI_CHOPPER-group ` :ref:`#nxspe-entry-instrument-fermi-chopper-group ` :ref:`/NXspe/ENTRY/INSTRUMENT/FERMI_CHOPPER/energy-field ` :ref:`#nxspe-entry-instrument-fermi-chopper-energy-field ` :ref:`/NXspe/ENTRY/INSTRUMENT/name-field ` :ref:`#nxspe-entry-instrument-name-field ` :ref:`/NXspe/ENTRY/NXSPE_info-group ` :ref:`#nxspe-entry-nxspe-info-group ` :ref:`/NXspe/ENTRY/NXSPE_info/fixed_energy-field ` :ref:`#nxspe-entry-nxspe-info-fixed-energy-field ` :ref:`/NXspe/ENTRY/NXSPE_info/ki_over_kf_scaling-field ` :ref:`#nxspe-entry-nxspe-info-ki-over-kf-scaling-field ` :ref:`/NXspe/ENTRY/NXSPE_info/psi-field ` :ref:`#nxspe-entry-nxspe-info-psi-field ` :ref:`/NXspe/ENTRY/program_name-field ` :ref:`#nxspe-entry-program-name-field ` :ref:`/NXspe/ENTRY/SAMPLE-group ` :ref:`#nxspe-entry-sample-group ` :ref:`/NXspe/ENTRY/SAMPLE/rotation_angle-field ` :ref:`#nxspe-entry-sample-rotation-angle-field ` :ref:`/NXspe/ENTRY/SAMPLE/seblock-field ` :ref:`#nxspe-entry-sample-seblock-field ` :ref:`/NXspe/ENTRY/SAMPLE/temperature-field ` :ref:`#nxspe-entry-sample-temperature-field ` ============================================================================================================== ============================================================================================================== **NXDL Source**: https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/applications/NXspe.nxdl.xml