File: empad.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 (31 lines) | stat: -rw-r--r-- 1,135 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
.. _empad-format:

EMPAD format (XML & RAW)
------------------------

This is the file format used by the Electron Microscope Pixel Array
Detector (EMPAD). It is used to store a series of diffraction patterns from
scanning transmission electron diffraction measurements, with a limited set of
metadata. Similarly, to the :ref:`ripple format <ripple-format>`, the raw data
and metadata are saved in two different files and for the EMPAD reader, these
are saved in the ``.raw`` and ``.xml`` files, respectively. To read EMPAD data,
use the ``.xml`` file, which will automatically read the raw data from the ``.raw``
file too. The filename of the ``.raw`` file is defined in the ``.xml`` file, which
implies changing the file name of the ``.raw`` file will break reading the file.

.. Note::

    When using `HyperSpy <https://hyperspy.org>`_, you need to specify the correct
    ``reader`` plugin, as different ``.xml`` formats are supported:

    .. code-block:: python

        >>> import hyperspy.api as hs
        >>> sig = hs.load("file.xml", reader="EMPAD")


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

.. automodule:: rsciio.empad
   :members: