Debian Codegraph @

doc/features/index.rst

raw
1 Features
2 ========
3
4 .. meta::
5 :description: DataLab features
6 :keywords: DataLab, features, validation, signal processing, image processing
7
8 The following sections describe the features of DataLab, the open-source scientific
9 data analysis and visualization platform.
10
11 .. note::
12
13 Before jumping into the details of other parts of the documentation, it is
14 recommended to start with the :ref:`overview` page, which describes the
15 basic concepts of DataLab.
16
17 .. seealso::
18
19 For a synthetic overview of the features of DataLab, please refer to the
20 :ref:`key_features` page.
21
22 .. _validation:
23
24 Overview & Common features
25 --------------------------
26
27 .. figure:: /images/shots/i_blob_detection_flower.png
28
29 DataLab main window
30
31 .. toctree::
32 :maxdepth: 1
33 :caption: Overview & Common features:
34
35 common/overview
36 common/settings
37 common/h5browser
38
39 .. raw:: latex
40
41 \newpage
42
43 Signal processing
44 -----------------
45
46 This section describes the features specific to the signal processing panel. The
47 signal processing panel is the default panel when DataLab is started.
48
49 .. figure:: /images/shots/s_beautiful.png
50
51 DataLab main window: Signal processing view
52
53 .. toctree::
54 :maxdepth: 1
55 :caption: Signal processing:
56
57 signal/menu_file
58 signal/menu_create
59 signal/menu_edit
60 signal/menu_roi
61 signal/menu_operations
62 signal/menu_processing
63 signal/menu_analysis
64 signal/menu_view
65
66 .. raw:: latex
67
68 \newpage
69
70 Image processing
71 ----------------
72
73 This section describes the features specific to the image processing panel. The
74 image processing panel can be selected by clicking on the "Images" tab at the
75 bottom-right of the DataLab main window.
76
77 .. figure:: /images/shots/i_beautiful.png
78
79 DataLab main window: Image processing view
80
81 .. toctree::
82 :maxdepth: 1
83 :caption: Image processing:
84
85 image/menu_file
86 image/menu_create
87 image/menu_edit
88 image/menu_roi
89 image/menu_operations
90 image/menu_processing
91 image/menu_analysis
92 image/menu_view
93 image/2d_peak_detection
94 image/contour_detection
95
96 Validation
97 ----------
98
99 DataLab is a platform for scientific data analysis and visualization. It may be used
100 in a variety of scientific disciplines, including biology, physics, and astronomy. The
101 common ground for all these disciplines is the need to validate the results of
102 computational analysis against ground-truth data. This is a critical step in the
103 scientific method, and it is essential for reproducibility and trust in the results.
104 This is what we call **technical validation**.
105
106 DataLab is also used in industrial applications, where the validation of the results
107 is essential for guaranteeing the quality of the process but a wider range of validation
108 is required to ensure that a maximum of use cases are covered from a functional point
109 of view. This is what we call **functional validation**.
110
111 Thus, DataLab validation may be categorized into two types:
112
113 - **Technical validation**: ensures that the results of computational analysis
114 are accurate and reliable.
115
116 - **Functional validation**: checks that the software behaves as expected in a
117 variety of use cases (classic automated unit test suite).
118
119 .. toctree::
120 :maxdepth: 1
121 :caption: Validation:
122
123 validation/technical
124 validation/functional
125 validation/status
126
127 Advanced features
128 -----------------
129
130 This section describes the advanced features of DataLab.
131
132 .. toctree::
133 :maxdepth: 1
134 :caption: Advanced features:
135
136 advanced/plugins
137 advanced/migration_v020_to_v100
138 advanced/macros
139 advanced/webapi
140 advanced/remote
141 advanced/model
142 advanced/logviewer
143 advanced/instviewer
144 advanced/command
145 advanced/api