File: dens.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 (49 lines) | stat: -rw-r--r-- 1,484 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
42
43
44
45
46
47
48
49
.. _dens-format:

DENSsolutions formats
---------------------
RosettaSciIO can read any logfile from DENSsolutions' new Impulse software as well
as the legacy heating software DigiHeater.

.. _dens_impulse-format:

DENSsolutions Impulse logfile
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Impulse logfiles are stored in ``.csv`` format. All metadata linked to the experiment
is stored in a separate ``metadata.log`` file. This metadata file contains crucial
information about the experiment and should be included in the same folder with
the ``.csv`` file when reading data using RosettaSciIO.

.. Note::
    To read Impulse logfiles in `HyperSpy <https://hyperspy.org>`_, use the
    ``reader`` argument to define the correct file plugin as the ``.csv``
    extension is not unique to this reader:

    .. code-block:: python

        >>> import hyperspy.api as hs
        >>> hs.load("filename.csv", reader="impulse")

API functions
"""""""""""""

.. automodule:: rsciio.impulse
   :members:


.. _dens_heater-format:

DENSsolutions DigiHeater logfile
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

RosettaSciIO can read the heater log format from the DENSsolutions’ DigiHeater software.
The format stores all the captured data for each timestamp, together with a small
header in a plain-text format. The reader extracts the measured temperature along
the time axis, as well as the date and calibration constants stored in the header.

API functions
"""""""""""""

.. automodule:: rsciio.dens
   :members: