.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXspectrum_set_em_xray.nxdl.xml .. index:: ! NXspectrum_set_em_xray (base class) ! spectrum_set_em_xray (base class) see: spectrum_set_em_xray (base class); NXspectrum_set_em_xray .. _NXspectrum_set_em_xray: ====================== NXspectrum_set_em_xray ====================== **Status**: base class, extends :ref:`NXobject` **Description**: Container for reporting a set of energy-dispersive X-ray 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. `IUPAC instead of Siegbahn notation `_ should be used. **Symbols**: **n_y**: Number of pixel per X-ray mapping in the slow direction **n_x**: Number of pixel per X-ray mapping in the fast direction **n_photon_energy**: Number of X-ray photon energy (bins) **n_elements**: Number of identified elements **n_peaks**: Number of peaks **Groups cited**: :ref:`NXdata`, :ref:`NXion`, :ref:`NXpeak`, :ref:`NXprocess` .. index:: NXprocess (base class); used in base class, NXdata (base class); used in base class, NXpeak (base class); used in base class, NXion (base class); used in base class **Structure**: .. _/NXspectrum_set_em_xray/PROCESS-group: **PROCESS**: (optional) :ref:`NXprocess` Details how X-ray spectra were processed from the detector readings. .. _/NXspectrum_set_em_xray/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_xray were loaded during parsing to represent them in e.g. databases. .. _/NXspectrum_set_em_xray/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_xray/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 X-ray spectra stack and summary. .. _/NXspectrum_set_em_xray/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_xray/stack-group: **stack**: (optional) :ref:`NXdata` Collected X-ray spectra for all pixels of a rectangular region-of-interest. This representation supports rectangular scan pattern. .. _/NXspectrum_set_em_xray/stack@long_name-attribute: .. index:: long_name (group attribute) **@long_name**: (optional) :ref:`NX_CHAR ` X-ray photon counts .. _/NXspectrum_set_em_xray/stack/counts-field: .. index:: counts (field) **counts**: (optional) :ref:`NX_UINT ` (Rank: 3, Dimensions: [n_y, n_x, n_photon_energy]) {units=\ :ref:`NX_UNITLESS `} .. _/NXspectrum_set_em_xray/stack/ypos-field: .. index:: ypos (field) **ypos**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH `} .. _/NXspectrum_set_em_xray/stack/ypos@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the y axis .. _/NXspectrum_set_em_xray/stack/xpos-field: .. index:: xpos (field) **xpos**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH `} .. _/NXspectrum_set_em_xray/stack/xpos@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the x axis .. _/NXspectrum_set_em_xray/stack/photon_energy-field: .. index:: photon_energy (field) **photon_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_photon_energy]) {units=\ :ref:`NX_ENERGY `} .. _/NXspectrum_set_em_xray/stack/photon_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` X-ray energy .. _/NXspectrum_set_em_xray/summary-group: **summary**: (optional) :ref:`NXdata` Accumulated X-ray spectrum over all pixels of a rectangular region-of-interest. This representation supports rectangular scan pattern. .. _/NXspectrum_set_em_xray/summary@long_name-attribute: .. index:: long_name (group attribute) **@long_name**: (optional) :ref:`NX_CHAR ` X-ray photon counts .. _/NXspectrum_set_em_xray/summary/counts-field: .. index:: counts (field) **counts**: (optional) :ref:`NX_UINT ` (Rank: 1, Dimensions: [n_photon_energy]) {units=\ :ref:`NX_UNITLESS `} .. _/NXspectrum_set_em_xray/summary/photon_energy-field: .. index:: photon_energy (field) **photon_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_photon_energy]) {units=\ :ref:`NX_ENERGY `} .. _/NXspectrum_set_em_xray/summary/photon_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` X-ray energy .. _/NXspectrum_set_em_xray/indexing-group: **indexing**: (optional) :ref:`NXprocess` Details about computational steps how peaks were indexed as elements. .. _/NXspectrum_set_em_xray/indexing/program-field: .. index:: program (field) **program**: (optional) :ref:`NX_CHAR ` Given name of the program that was used to perform this computation. .. _/NXspectrum_set_em_xray/indexing/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_xray/indexing/element_names-field: .. index:: element_names (field) **element_names**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [n_elements]) List of the names of identified elements. .. _/NXspectrum_set_em_xray/indexing/PEAK-group: **PEAK**: (optional) :ref:`NXpeak` Name and location of each X-ray line which was indexed as a known ion. For each ion an NXion instance should be created which specifies the origin of the signal. For each ion also the relevant IUPAC notation X-ray lines should be specified. .. _/NXspectrum_set_em_xray/indexing/PEAK/ION-group: **ION**: (optional) :ref:`NXion` .. _/NXspectrum_set_em_xray/indexing/PEAK/ION/iupac_line_names-field: .. index:: iupac_line_names (field) **iupac_line_names**: (optional) :ref:`NX_CHAR ` IUPAC notation identifier of the line which the peak represents. This can be a list of IUPAC notations for (the seldom) case that multiple lines are group with the same peak. .. _/NXspectrum_set_em_xray/indexing/composition_map-group: **composition_map**: (optional) :ref:`NXprocess` Individual element-specific EDX/EDS/EDXS/SXES mapping A composition map is an image whose intensities for each pixel are the accumulated X-ray quanta *under the curve(s)* of a set of peaks. .. _/NXspectrum_set_em_xray/indexing/composition_map/program-field: .. index:: program (field) **program**: (optional) :ref:`NX_CHAR ` Given name of the program that was used to perform this computation. .. _/NXspectrum_set_em_xray/indexing/composition_map/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_xray/indexing/composition_map/peaks-field: .. index:: peaks (field) **peaks**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [n_peaks]) A list of strings of named instances of NXpeak from indexing whose X-ray quanta where accumulated for each pixel. .. _/NXspectrum_set_em_xray/indexing/composition_map/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Human-readable, given name to the image. .. _/NXspectrum_set_em_xray/indexing/composition_map/DATA-group: **DATA**: (optional) :ref:`NXdata` Individual element-specific maps. Individual maps should each be a group and be named according to element_names. .. _/NXspectrum_set_em_xray/indexing/composition_map/DATA@long_name-attribute: .. index:: long_name (group attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Accumulated X-ray photon counts .. _/NXspectrum_set_em_xray/indexing/composition_map/DATA/counts-field: .. index:: counts (field) **counts**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [n_y, n_x]) {units=\ :ref:`NX_UNITLESS `} .. _/NXspectrum_set_em_xray/indexing/composition_map/DATA/ypos-field: .. index:: ypos (field) **ypos**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH `} .. _/NXspectrum_set_em_xray/indexing/composition_map/DATA/ypos@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the y axis .. _/NXspectrum_set_em_xray/indexing/composition_map/DATA/xpos-field: .. index:: xpos (field) **xpos**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH `} .. _/NXspectrum_set_em_xray/indexing/composition_map/DATA/xpos@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Label for the x axis Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXspectrum_set_em_xray/indexing-group ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map-group ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/DATA-group ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/DATA/counts-field ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/DATA/xpos-field ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/DATA/xpos@long_name-attribute ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/DATA/ypos-field ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/DATA/ypos@long_name-attribute ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/DATA@long_name-attribute ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/name-field ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/peaks-field ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/program-field ` * :ref:`/NXspectrum_set_em_xray/indexing/composition_map/program@version-attribute ` * :ref:`/NXspectrum_set_em_xray/indexing/element_names-field ` * :ref:`/NXspectrum_set_em_xray/indexing/PEAK-group ` * :ref:`/NXspectrum_set_em_xray/indexing/PEAK/ION-group ` * :ref:`/NXspectrum_set_em_xray/indexing/PEAK/ION/iupac_line_names-field ` * :ref:`/NXspectrum_set_em_xray/indexing/program-field ` * :ref:`/NXspectrum_set_em_xray/indexing/program@version-attribute ` * :ref:`/NXspectrum_set_em_xray/PROCESS-group ` * :ref:`/NXspectrum_set_em_xray/PROCESS/program-field ` * :ref:`/NXspectrum_set_em_xray/PROCESS/program@version-attribute ` * :ref:`/NXspectrum_set_em_xray/PROCESS/source-field ` * :ref:`/NXspectrum_set_em_xray/PROCESS/source@version-attribute ` * :ref:`/NXspectrum_set_em_xray/stack-group ` * :ref:`/NXspectrum_set_em_xray/stack/counts-field ` * :ref:`/NXspectrum_set_em_xray/stack/photon_energy-field ` * :ref:`/NXspectrum_set_em_xray/stack/photon_energy@long_name-attribute ` * :ref:`/NXspectrum_set_em_xray/stack/xpos-field ` * :ref:`/NXspectrum_set_em_xray/stack/xpos@long_name-attribute ` * :ref:`/NXspectrum_set_em_xray/stack/ypos-field ` * :ref:`/NXspectrum_set_em_xray/stack/ypos@long_name-attribute ` * :ref:`/NXspectrum_set_em_xray/stack@long_name-attribute ` * :ref:`/NXspectrum_set_em_xray/summary-group ` * :ref:`/NXspectrum_set_em_xray/summary/counts-field ` * :ref:`/NXspectrum_set_em_xray/summary/photon_energy-field ` * :ref:`/NXspectrum_set_em_xray/summary/photon_energy@long_name-attribute ` * :ref:`/NXspectrum_set_em_xray/summary@long_name-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXspectrum_set_em_xray.nxdl.xml