Repository navigation
Immutable
release. Only release title and notes can be modified.
DataLab Version 1.4.1
Requirements
- Runtime requirements are unchanged since version 1.4.0.
- Third-party:
- PyYAML is now part of the
testoptional dependencies: the test suite needs it to check the projects created by the plugin generator.
- PyYAML is now part of the
🛠️ Bug Fixes since version 1.4.0
- Tutorial examples and metadata: The custom denoising example no longer produces undefined values on constant image regions, and the Spyder tutorial no longer produces undefined values on grids containing the first peak position. The metadata paste dialog now explains that annotations are copied and pasted separately (fixes Issue #567).
- Scientific processing (
⚠️ results change): With Sigima 1.4.1 or later, X–Y mode uses only the signals' common interval instead of extending one signal beyond its data, while retaining the interpolation confirmation; disjoint domains are refused. The enclosing circle now contains the selected pixel centers in physical coordinates, quadratic interpolation passes through the samples, pulse offsets retain their sign, and flat-field correction refuses zero denominators on corrected pixels. Previously recorded calls of these operations are refused at replay rather than silently giving different results; existing stored data is unchanged (fixes Issue #565 and Sigima Issue #130). - Integer images and X–Y mode (
⚠️ results change): with Sigima 1.4.1 or later, on signed integer images whose range of values exceeds the capacity of their type (e.g.int16values from -30000 to +30000), Analysis > Minimum enclosing circle center no longer gives a much too large circle, Analysis > Contour detection finds the contours, and Analysis > 2D peak detection no longer reports spurious peaks. Flat-field correction of an integer image now gives a floating-point image instead of wrapping the values exceeding the range of the image type. With a region of interest on the first signal, X-Y mode and Replace X by other signal's Y now keep only the points within this region, instead of mixing the original coordinates of the other points into the result. X-Y mode results now take the titles and units of the Y axes of the two signals, signals with different X units are refused, and signals sharing the same X grid are paired without interpolation. Previously recorded calls of the changed operations are refused at replay (fixes Issue #571 and Sigima Issue #136). - Plugin installation: installing a plugin whose required packages are missing now names these packages and tells how to provide them, instead of reporting an unexplained "Dependency wheelhouse not found" error with a temporary folder.
- Brightness and contrast: the Minimum and Maximum fields of Processing > Exposure > Brightness and contrast (in its dialog and in the Processing tab of the properties panel) showed numbers with 17 significant digits in fields too narrow for them, so that their beginning was cut off, e.g.
835736228608e-43instead of6.5127532828723551e-44. These fields now show the complete value, with a precision matching that of the sliders (e.g.0and1.7557), and the exact value in their tooltip; a value which is not modified is kept exactly (fixes Issue #510). - Processing parameters: moving the slider of a numeric parameter gave values such as
0.30000000000000004or1.2000000000000002instead of0.3or1.2, which were then used and recorded as processing parameters, e.g. with Sigmoid correction and Adaptive histogram equalization (Processing > Exposure), the Butterworth filter (Processing > Frequency filters) or the signal Peak detection (Analysis). Slider values are now free of these spurious digits (fixes Issue #510). - Image coordinates: since DataLab 1.2.0, Set uniform coordinates was missing from Processing > Axis transformation in the Image panel, so this feature could no longer be run from the menus. It is available again, next to Polynomial calibration (fixes Issue #515).
- Web API: starting the Web API server through the remote control (XML-RPC), e.g. with
RemoteProxy.start_webapi_server(), used port 8080 instead of the automatic port (18080, or the next free one), so that DataLab-Kernel could not find the server automatically. Unless a port is given, the server now uses the automatic port, as when it is started from File > Web API (fixes Issue #516). - AI Assistant: the Enable AI Assistant option of the settings had no effect: the assistant remained available, although the documentation stated that no request was sent when it was disabled. This option is removed: the assistant contacts its provider only when you send a message or click Test connection, as the documentation now states. A new Settings... button of the AI Assistant panel opens the AI Assistant tab of the settings, and the messages of the panel point to File > Settings instead of a nonexistent Edit > Preferences menu (fixes Issue #571).
- Visualization settings: the Downsampling max points field could remain editable when the settings dialog opened with Use auto downsampling unchecked, e.g. after checking this option and cancelling the dialog. It now follows the checkbox as soon as the dialog opens (fixes Issue #571).
- Stability analysis: Overlapping Allan variance was missing from Processing > Stability analysis in the Signal panel, so it could only be computed with the other methods, through All stability features.... It is now listed with the other variances (fixes Issue #518).
- Gaussian bandpass filter: the Inverse FFT result parameter of Processing > Frequency filters > Gaussian bandpass had no effect: Absolute value gave the same image as Real part, although the parameter was recorded in the provenance as if it had been applied. With Sigima 1.4.1 or later, Absolute value gives the modulus of the inverse FFT, and the title of the result shows the chosen option; Real part, the default, gives the same result as before. Steps of this filter recorded with an earlier version are refused when they are verified or replayed, instead of giving another result (fixes Sigima Issue #123).
- Cardinal sine signal: the cardinal sine of Create > Cardinal sine, described as
y = y0 + A sinc(2π f x + φ), used the normalized definitionsinc(u) = sin(πu)/(πu): with a frequency of 1 Hz, its first zeros were at about ±0.159 instead of ±0.5. With Sigima 1.4.1 or later, it uses the definitionsinc(u) = sin(u)/u(withsinc(0) = 1), as the 2D sinc image, which is unchanged; the creation dialogs of both now show this definition. For the same parameters, a cardinal sine signal created, edited or recomputed from the History panel is now different; signals already created, e.g. in a saved workspace, keep their data (fixes Sigima Issue #60). - Web API: when required components could not be imported, the menu and remote control suggested installing a nonexistent extra. They now name the required dependencies and explain how to check or repair the installation using its original method or package manager; pip users can run
python -m pip checkto check dependency requirements (fixes Issue #525). - Web API: each object added through the Web API, e.g. from DataLab-Kernel or a Jupyter notebook, showed "Remote request failed: Object '...' not found" in the status bar, although the object was added. Checking that an object name is free is no longer reported as a failed request (fixes Issue #528).
- Web API: when replacing an existing workspace object, a failed addition of the replacement could delete the original object. The original object now remains available if the replacement cannot be added (fixes Issue #561).
- Deleting objects: deleting many objects at once, or clearing the workspace, froze DataLab for a long time when many curves were displayed (e.g. about 20 seconds for 600 signals). It now takes about one second (fixes Issue #528).
- Plugins: after running a processing feature of a plugin whose computation functions are not in the module of its plugin class, such as the plugins created with
datalab-plugin create --project, saving the workspace to an HDF5 file failed with "cannot serialize None value in dict". These results are now saved, with the name and version of their plugin (fixes Issue #543). - Applications panel: when application plugins were installed, docking the floating Applications panel back into the main window could crash DataLab. The panel can now be docked and undocked safely (fixes Issue #527).
- Plugin testing: scripts and tests using
datalab_test_app_context, e.g. to test a plugin, sometimes crashed when the Python interpreter exited, after their checks had passed. Their main windows are now destroyed before the Qt application, when the interpreter exits (fixes Issue #556). - Development tooling: the VS Code tasks of the source repository reported success even when their command failed (e.g. a failed test, a linting error or a documentation build error), and the tasks chained after them still ran, e.g. updating the translation catalogs after a failed documentation build. These tasks now fail with their command; Coverage full still produces the coverage report when tests fail (fixes Issue #552).
📖 Documentation since version 1.4.0
- Corrected installation and remote-control instructions, descriptions of History and plugins, and tutorial screenshots so they reflect the current application (fixes Issue #569).
- Corrected the description of the pulse amplitude, which never falls back on the peak-to-peak amplitude, and documented the bias of the default FWHM method on smooth peaks, the unit of the phase of periodic signals (degrees in the dialogs), the effect of hot pixels on the enclosing circle, of near-zero values on the flat-field correction, how the Web API replaces an object, and the cases where DataLab and DataLab-Web results can be compared. The laser beam tutorial now gives the centroid row used by its screenshots (fixes Issue #571).
- Updated the Fabry-Pérot, spectrum and blob-detection tutorial screenshots, the startup page, settings and History panel to match the current interface. Maintainers can regenerate these figures with a single Qt-based script, without manual desktop captures or changes to personal preferences (fixes Issue #520).
- Translated card titles in the French documentation now show the same icons as their English counterparts, on the home page and the main section pages (fixes Issue #536).
- The DataLab plugin catalog is now presented on the home page, in the navigation bar and in the pages describing the platform, its key features and how to contribute
- The plugin documentation is reorganized into an overview page and dedicated pages for installing and managing plugins, deploying them in an organization, developing them, application plugins and the public API; the development page starts with a quick start, "Your first plugin in five minutes", and presents the plugins of the catalog as examples
- New tutorial, "From an idea to the plugin catalog": create a plugin in a single Python file, try it, then publish it in the DataLab plugin catalog, without any PyPI account
- New use case pages present the characterization of scientific cameras, the analysis of transient and pulsed signals, and instrument control and data acquisition, with the Camera & Detector Characterization, Pulse & Transient Characterization and TANGO Instruments plugins of the DataLab plugin catalog; the non-destructive testing page now presents the X-ray Radiography & NDT plugin, also cited as an example in the plugin documentation (Issue #542)
- The roadmap is updated: the plugin template is delivered, data acquisition has started, and the milestones of versions 1.1 to 1.4 are listed
- The documentation is corrected where it no longer matched the application (Issue #519): menu paths and labels of the tutorials and feature pages, settings and their default values, formulas and results of several processing and analysis features, supported file formats, annotations (stored apart from metadata), the Web API, whose token is not required for local requests by default, the remote control, limited to the local machine, plugins targeting DataLab-Web, macros, installation commands (the conda-forge package is
datalab;[qt]and[opencv]extras), and several examples that no longer worked - On the home page and the Getting started page, the logos of the funders and the icons of the three operating modes are shown again at their intended size, without a white background in the dark theme, and the logos of CEA, CODRA and NLnet link again to their websites instead of opening the image (fixes Issue #521)
- The Web API documentation and the tooltip of the Web API localhost bypass setting now warn that, while the Web API server is running with this setting enabled (default), any web page open in the browser, and not only local applications, can access the workspace without a token (Issue #522)
🔧 Improvements since version 1.4.0
- Plugin generator: the release workflow of a generated plugin project (
.github/workflows/release.yml) now checks that the tag matches the version of bothpyproject.tomland the package, runs the tests before building the wheel, and publishes the wheel with its SHA-256 checksum and its build provenance attestation, which users can check withgh attestation verify. A tag such asv0.2.0-rc1publishes a release candidate as a GitHub pre-release, without plugin catalog entry. The generated test no longer compares the plugin version with a fixed value, so it no longer fails when the version changes. Existing plugin projects are not affected. - Plugin catalog: a plugin may now require packages that users install themselves in DataLab's Python environment, such as PyTango for the TANGO Instruments plugin. The Catalog tab shows these packages and offers to install the plugin only once they are installed; in the standalone application, such plugins are shown as not available.
- Welcome page: the Applications section is now shown even when no application is installed: it then invites you to discover plugins, and "Discover plugins..." opens the Catalog tab of the plugin configuration dialog, to find and install the plugins of the DataLab plugin catalog; once applications are installed, a "Discover plugins..." button of the section keeps this access. The online documentation and the release notes are now links at the bottom of the page, so that the Walkthroughs column only holds the AI assistant, the guided tour and the demo.
- Welcome page: application tiles no longer grow with their description, which made the page crowded once several application plugins were installed (each with a tile for its examples). Tiles now all have the same height and share the width of the page, from the left of Quick actions to the right of Walkthroughs, with as many tiles per row as the width allows: the title stands next to the icon, the description follows it directly, and both are limited (two lines for the title, three for the description), ending with "…" when they are longer, the full text being shown in a tooltip (closes Issue #545).
- Plugin instruments: the window of a plugin instrument, e.g. the camera, oscilloscope or radiography simulators, has a new Restore defaults button, which sets the settings of the instrument back to their default values and refreshes the view (closes Issue #545).
- Plugin tools: a plugin may declare a tool with
menu=Falseto place it in one of its own submenus: DataLab then lists it in the Applications panel only, instead of also adding it at the end of the plugin's submenu (closes Issue #545).