File: edax.rst

package info (click to toggle)
python-rosettasciio 0.7.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 144,644 kB
  • sloc: python: 36,638; xml: 2,582; makefile: 20; ansic: 4
file content (41 lines) | stat: -rw-r--r-- 1,564 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
.. _edax-format:

EDAX TEAM/Genesis (SPC, SPD)
----------------------------

RosettaSciIO can read both ``.spd`` (spectrum image) and ``.spc`` (single spectra)
files from the EDAX TEAM software and its predecessor EDAX Genesis.
If reading an ``.spd`` file, the calibration of the
spectrum image is loaded from the corresponding ``.ipr`` and ``.spc`` files
stored in the same directory, or from specific files indicated by the user.
If these calibration files are not available, the data from the ``.spd``
file will still be loaded, but with no spatial or energy calibration.

When using `HyperSpy <https://hyperspy.org>`_, if elemental information has been
defined in the spectrum image, those elements will automatically be added to the
signal loaded by HyperSpy.

In HyperSpy, if an ``.spd`` file is loaded, the result will be a HyperSpy
``EDSSEMSpectrum`` map, and the calibration will be loaded from the appropriate
``.spc`` and ``.ipr`` files (if available). If an ``.spc`` file is loaded, the
result will be a single ``EDSSEMSpectrum`` with no other files needed for
calibration.

.. Note ::

    Currently, HyperSpy will load data as an ``EDSSEMSpectrum`` signal. If support
    for TEM EDS data is needed, please open an issue in the `issues tracker
    <https://github.com/hyperspy/rosettasciio/issues>`_ to alert the developers
    of the need.

For reference, :ref:`file specifications <edax-file_specification>` for the EDAX
file formats have been publicly available from EDAX.


API functions
^^^^^^^^^^^^^

.. automodule:: rsciio.edax
   :members: