Debian Codegraph @

doc/intro/introduction.rst

raw
1 Use cases, main features and key strengths
2 ==========================================
3
4 .. meta::
5 :description: Use cases, main features and key strengths of DataLab, the open-source platform for data processing and visualization
6 :keywords: DataLab, use cases, main features, key strengths, data processing, data visualization, scientific data, technical data, signals, images, data formats, plugin system, interoperability, automation, maintainability, testability
7
8 DataLab is a platform for data processing and visualization (signals or images)
9 that includes many functions. Developed in Python, it benefits from the
10 richness of the associated ecosystem in terms of scientific and
11 technical libraries.
12
13 What are the applications for DataLab?
14 --------------------------------------
15
16 Real world examples
17 ^^^^^^^^^^^^^^^^^^^
18
19 A few concrete and specific examples illustrate the nature of the work
20 that can be carried out with DataLab:
21
22 - Processing of experimental data (signals and images) acquired on a scientific facility
23 in the nuclear field
24 - Processing of data acquired by a sensor in an industrial context
25 - Processing of images acquired by a camera in a medical context
26 - Automatic detection of defects on a surface, in the context of quality control
27 - Automatic detection of laser spots on a target, in the context of laser alignment
28 - Instrument alignment through image processing
29 - Automatic pattern detection on images and geometric correction of the images, in
30 the context of non destructive testing
31
32 .. _usage_modes:
33
34 Usage modes
35 ^^^^^^^^^^^
36
37 Depending on the application, DataLab can be used in three different modes:
38
39 - |appmode| **Stand-alone mode**: DataLab is a full-fledged processing application that
40 can be adapted to the client's needs through the addition of
41 industry-specific plugins.
42 - |libmode| **Embedded mode**: DataLab is integrated into your application to provide
43 the necessary processing and visualization features.
44 - |remotemode| **Remote-controlled mode**: DataLab communicates with your application,
45 allowing it to benefit from its functionality without disrupting
46 the user experience.
47
48 .. |appmode| image:: ../../resources/DataLab-app.svg
49 :width: 24px
50 :height: 24px
51 :class: dark-light no-scaled-link
52
53 .. |libmode| image:: ../../resources/DataLab-lib.svg
54 :width: 24px
55 :height: 24px
56 :class: dark-light no-scaled-link
57
58 .. |remotemode| image:: ../../resources/DataLab-remote.svg
59 :width: 24px
60 :height: 24px
61 :class: dark-light no-scaled-link
62
63 .. _use_cases:
64
65 Use cases
66 ^^^^^^^^^
67
68 .. seealso::
69
70 For practical examples of use cases, see the :ref:`tutorials` section:
71
72 - Most of the tutorials are describing concrete examples of use of DataLab
73 in a scientific or technical context.
74
75 - Regarding the use of DataLab with an IDE (Integrated Development Environment)
76 such as Visual Studio Code or Spyder, see the tutorial :ref:`tutorial_spyder`.
77
78 - As for the use of DataLab with Jupyter notebooks, that is one of the topics
79 covered in the tutorial :ref:`tutorial_extensibility`.
80
81 DataLab is a versatile tool that can be used in different contexts:
82
83 Data processing
84 DataLab is a powerful tool for processing signals and images. It can be used
85 to develop complex algorithms, or to quickly prototype a processing chain.
86
87 :octicon:`book;1em;sd-text-info` See our :bdg-ref-success-line:`Tutorials <tutorials>`
88 for practical examples of use in data processing.
89
90 Companion tool for scientific/technical work
91 DataLab can be used as a companion tool for scientific/technical work. It
92 allows you to visualize and process data, and to share your results with your
93 colleagues. It can easily be adapted to your needs through the addition of
94 plugins, and it may even be used together with your every day tools (e.g.,
95 Visual Studio Code, Spyder... or Jupyter notebooks).
96
97 :octicon:`book;1em;sd-text-info` See our :bdg-ref-success-line:`Tutorials <tutorials>`
98 for practical examples of use in a scientific/technical context.
99
100 Prototyping a data processing application
101 DataLab can be used to quickly prototype a data processing application. It can
102 then be used as a basis for the development of a full-fledged application.
103
104 :octicon:`book;1em;sd-text-info` See the tutorial :ref:`tutorial_custom_func`
105 for a concrete example.
106
107 Debugging a data processing application
108 DataLab can be used as an advanced debugging tool for your data processing
109 applications, independently from the development environment or the language
110 used (Python, C#, C++, etc.). All you need is to be able to communicate with
111 DataLab via its remote control interface (standard XML-RPC protocol). This
112 allows you to send data to DataLab (signals, images or even geometric shapes),
113 visualize the data at each step of the processing chain, manipulate them to
114 better understand the behavior of your algorithms, and even modify them to
115 test the robustness of your code.
116
117 :octicon:`bug;1em;sd-text-warning` See the tutorial :ref:`debug_spyder`
118 for a quick overview of this feature.
119
120 .. note::
121
122 DataLab can also be controlled from your familiar development environment
123 (e.g., Visual Studio Code, Spyder...) or from a Jupyter notebook, in order
124 to perform calculations using your processing functions while leveraging the
125 advanced features of DataLab. :octicon:`book;1em;sd-text-info`
126 See the tutorials :ref:`tutorial_custom_func` or :ref:`tutorial_spyder`
127 for examples of use.
128
129 With its user-friendly experience and versatile usage modes, DataLab enables
130 efficient development of your data processing and visualization applications
131 while benefiting from an industrial-grade technological platform.
132
133 .. _main_features:
134
135 Main features
136 -------------
137
138 The main technical features of DataLab include:
139
140 - Support for numerous standard and proprietary data formats
141 - Opening an arbitrary number of objects (signals or images) for batch
142 processing, with the possibility of defining groups of objects
143 - Simultaneous viewing of multiple objects with annotation support
144 - Standard operations and processing on signals and images
145 - Advanced image processing (restoration, morphology, edge detection, etc.)
146 - Management of multiple regions of interest (calculations, extractions)
147 - Macro-command editor
148 - Remote-controllable API
149 - Embedded interactive Python console
150
151 .. _key_strengths:
152
153 Key strengths
154 -------------
155
156 To summarize, the four key strengths of DataLab are:
157
158 Extensibility
159 The DataLab plugin system makes it easy to code new features (specific
160 processing, specific file formats, custom graphical interfaces). It can also
161 be used as a customizable platform.
162
163 Interoperability
164 DataLab can also be embedded in your own application. For example, within data
165 processing software, machine-level control systems, or test bench
166 applications.
167
168 Automation
169 A high-level public API allows for full remote control of DataLab to open and
170 process data.
171
172 Maintainability and testability
173 DataLab is an industrial-grade scientific and technical processing software.
174 The built-in automated tests in DataLab cover 90% of its features, which is
175 significant for software with graphical interfaces and helps mitigate
176 regression risks. Moreover, the test suite includes validation tests based either
177 on ground truth data or analytical solutions.
178
179 .. seealso:: See section :ref:`validation` for more information on DataLab's validation strategy.