summaryrefslogtreecommitdiff
path: root/doc/source/applications/view.rst
blob: 747a121ae533510dddd5e4026824e06d8eb278af (plain)
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
.. _silx view:

silx view
=========

.. figure:: http://www.silx.org/doc/silx/img/silx-view-v1-0.gif
   :align: center

Purpose
-------

The *silx view* command is provided to open data files
in a graphical user interface. It allows to select a particular
piece of data or a particular header in structured data formats,
and to view this data in plot widgets or in simple table views.


.. |imgViewImg| image:: img/silx-view-image.png
   :height: 300px
   :align: middle

.. |imgViewTable| image:: img/silx-view-table.png
   :height: 300px
   :align: middle

.. |imgViewHdf5| image:: img/silx-view-hdf5.png
   :height: 300px
   :align: middle

.. list-table::
   :widths: 1 2

   * - |imgViewImg|
     - Image view
   * - |imgViewTable|
     - Viewing raw data as values in a table
   * - |imgViewHdf5|
     - Viewing metadata and HDF5 attributes


Usage
-----

::

    silx view [-h] [--debug] [--use-opengl-plot] [files [files ...]]


Options
-------

  -h, --help           Show this help message and exit
  --debug              Set logging system in debug mode
  --use-opengl-plot    Use OpenGL for plots (instead of matplotlib)
  -f, --fresh          Start the application using new fresh user preferences
  --hdf5-file-locking  Start the application with HDF5 file locking enabled (it is disabled by default)

Examples of usage
-----------------

::

    silx view 31oct98.dat
    silx view *.edf
    silx view myfile.h5