.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXspectrum_set_em_eels.nxdl.xml .. index:: ! NXspectrum_set_em_eels (base class) ! spectrum_set_em_eels (base class) see: spectrum_set_em_eels (base class); NXspectrum_set_em_eels .. _NXspectrum_set_em_eels: ====================== NXspectrum_set_em_eels ====================== **Status**: base class, extends :ref:`NXobject` **Description**: Container for reporting a set of electron energy loss (EELS) spectra. Virtually the most important case is that spectra are collected in a scanning microscope (SEM or STEM) for a collection of points. The majority of cases use simple d-dimensional regular scan pattern, such as single point, line profiles, or (rectangular) surface mappings. The latter pattern is the most frequently used. For now the base class provides for scans for which the settings, binning, and energy resolution is the same for each scan point. **Symbols**: **n_y**: Number of pixel per EELS mapping in the slow direction. **n_x**: Number of pixel per EELS mapping in the fast direction. **n_energy_loss**: Number of electron energy loss bins. **Groups cited**: :ref:`NXdata`, :ref:`NXprocess` .. index:: NXprocess (base class); used in base class, NXdata (base class); used in base class **Structure**: .. _/NXspectrum_set_em_eels/PROCESS-group: **PROCESS**: (optional) :ref:`NXprocess` Details how EELS spectra were processed from the detector readings. .. _/NXspectrum_set_em_eels/PROCESS/source-field: .. index:: source (field) **source**: (optional) :ref:`NX_CHAR ` Typically the name of the input, (vendor) file from which all the NXdata instances in this NXspectrum_set_em_eels were loaded during parsing to represent them in e.g. databases. .. _/NXspectrum_set_em_eels/PROCESS/source@version-attribute: .. index:: version (field attribute) **@version**: (optional) :ref:`NX_CHAR ` An at least as strong as SHA256 hashvalue of the dataset/file which represents the source digitally to support provenance tracking. .. _/NXspectrum_set_em_eels/PROCESS/program-field: .. index:: program (field) **program**: (optional) :ref:`NX_CHAR ` Commercial or otherwise given name to the program which was used to process detector data into the EELS spectra stack and summary. .. _/NXspectrum_set_em_eels/PROCESS/program@version-attribute: .. index:: version (field attribute) **@version**: (optional) :ref:`NX_CHAR ` Program version plus build number, commit hash, or description of an ever persistent resource where the source code of the program and build instructions can be found so that the program can be configured in such a manner that the result file is ideally recreatable yielding the same results. .. _/NXspectrum_set_em_eels/stack-group: **stack**: (optional) :ref:`NXdata` Collected EELS spectra for all pixels of a rectangular region-of-interest. This representation supports rectangular scan pattern. .. _/NXspectrum_set_em_eels/stack@long_name-attribute: .. index:: long_name (group attribute) **@long_name**: (optional) :ref:`NX_CHAR ` EELS counts .. _/NXspectrum_set_em_eels/stack/counts-field: .. index:: counts (field) **counts**: (optional) :ref:`NX_NUMBER ` (Rank: 3, Dimensions: [n_y, n_x, n_energy_loss]) {units=\ :ref:`NX_UNITLESS `} .. _/NXspectrum_set_em_eels/stack/ypos-field: .. index:: ypos (field) **ypos**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH `} Pixel center of mass position y-coordinates. .. _/NXspectrum_set_em_eels/stack/ypos@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the y axis. .. _/NXspectrum_set_em_eels/stack/xpos-field: .. index:: xpos (field) **xpos**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH `} Pixel center of mass position x-coordinates. .. _/NXspectrum_set_em_eels/stack/xpos@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the x axis. .. _/NXspectrum_set_em_eels/stack/energy_loss-field: .. index:: energy_loss (field) **energy_loss**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy_loss]) {units=\ :ref:`NX_ENERGY `} Pixel center of mass energy loss bins. .. _/NXspectrum_set_em_eels/stack/energy_loss@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the energy loss axis. .. _/NXspectrum_set_em_eels/summary-group: **summary**: (optional) :ref:`NXdata` Accumulated EELS spectrum over all pixels of a rectangular region-of-interest. This representation supports rectangular scan pattern. .. _/NXspectrum_set_em_eels/summary@long_name-attribute: .. index:: long_name (group attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Counts electrons with an energy loss within binned range. .. _/NXspectrum_set_em_eels/summary/counts-field: .. index:: counts (field) **counts**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy_loss]) {units=\ :ref:`NX_UNITLESS `} Counts for specific energy losses. .. _/NXspectrum_set_em_eels/summary/energy_loss-field: .. index:: energy_loss (field) **energy_loss**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy_loss]) {units=\ :ref:`NX_ENERGY `} Pixel center of mass energy loss bins. .. _/NXspectrum_set_em_eels/summary/energy_loss@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Energy loss Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXspectrum_set_em_eels/PROCESS-group ` * :ref:`/NXspectrum_set_em_eels/PROCESS/program-field ` * :ref:`/NXspectrum_set_em_eels/PROCESS/program@version-attribute ` * :ref:`/NXspectrum_set_em_eels/PROCESS/source-field ` * :ref:`/NXspectrum_set_em_eels/PROCESS/source@version-attribute ` * :ref:`/NXspectrum_set_em_eels/stack-group ` * :ref:`/NXspectrum_set_em_eels/stack/counts-field ` * :ref:`/NXspectrum_set_em_eels/stack/energy_loss-field ` * :ref:`/NXspectrum_set_em_eels/stack/energy_loss@long_name-attribute ` * :ref:`/NXspectrum_set_em_eels/stack/xpos-field ` * :ref:`/NXspectrum_set_em_eels/stack/xpos@long_name-attribute ` * :ref:`/NXspectrum_set_em_eels/stack/ypos-field ` * :ref:`/NXspectrum_set_em_eels/stack/ypos@long_name-attribute ` * :ref:`/NXspectrum_set_em_eels/stack@long_name-attribute ` * :ref:`/NXspectrum_set_em_eels/summary-group ` * :ref:`/NXspectrum_set_em_eels/summary/counts-field ` * :ref:`/NXspectrum_set_em_eels/summary/energy_loss-field ` * :ref:`/NXspectrum_set_em_eels/summary/energy_loss@long_name-attribute ` * :ref:`/NXspectrum_set_em_eels/summary@long_name-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXspectrum_set_em_eels.nxdl.xml