File: view.rst

package info (click to toggle)
silx 2.2.2-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 31,728 kB
  • sloc: python: 119,843; ansic: 5,062; lisp: 4,454; cpp: 883; sh: 286; makefile: 90; xml: 46
file content (131 lines) | stat: -rw-r--r-- 2,875 bytes parent folder | download | duplicates (4)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
.. _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

Custom plot selection
---------------------

.. grid :: 1 2 2 2

   .. grid-item-card::
      :columns: 12
      :text-align: center

      .. figure:: img/silx-view-plotSelection.png
         :align: center

      Plot custom curves from selected 1D datasets.

How to access
.............

.. grid :: 1 2 2 2

   .. grid-item-card::
      :columns: 12
      :text-align: center

      .. figure:: img/silx-view-plotMenu.png
         :align: center

      Open the 'Plot selection' window (View menu -> Plot selection)

      .. figure:: img/silx-view-dropPlot.png
         :align: center

      The "Plot selection" window opens: You can plot custom curves by dragging and dropping 1D datasets from "silx view" to "Plot selection" window's "X" and "Y" fields.

Command line
------------

.. code-block:: none

    silx view [-h] [--slices SLICES [SLICES ...]] [--debug] [--use-opengl-plot] [-f] [--hdf5-file-locking] [files ...]


Options
-------

.. code-block:: none

  -h, --help            show this help message and exit
  --slices SLICES [SLICES ...]
                        List of slice indices to open (Only for dataset)
  --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
--------

Open file(s)
............

.. code-block:: none

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


Open HDF5 dataset(s)
....................

Using the HDF5 path to the dataset:

.. code-block:: none

    silx view my_hdf5_file.h5::entry/instrument/detector/data

Using wildcard:

.. code-block:: none

   silx view my_hdf5_file.h5::entry/*/data


Open HDF5 dataset slices
........................

Open first and last slices of datasets:

.. code-block:: none

    silx view my_hdf5_file.h5::entry/*/data --slices 0 -1