pymodaq_data 5.3.10__tar.gz → 5.3.11__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/PKG-INFO +1 -1
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/data_saving.py +63 -38
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/.gitignore +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/LICENSE +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/README.rst +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/pyproject.toml +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/__init__.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/config.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/data.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/__init__.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/backends.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/browsing.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/exporter.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/exporters/__init__.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/exporters/base.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/exporters/flimj.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/exporters/hyperspy.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/migration.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/saving.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/swmr.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/utils.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/icon.ico +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/numpy_func.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/plotting/__init__.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/plotting/plotter/plotter.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/plotting/plotter/plotters/__init__.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/plotting/plotter/plotters/matplotlib_plotters.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/plotting/utils.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/post_treatment/__init__.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/post_treatment/process_to_scalar.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/py.typed +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/resources/__init__.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/resources/config_template.toml +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/slicing.py +0 -0
- {pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/splash.png +0 -0
|
@@ -16,6 +16,7 @@ import numpy as np
|
|
|
16
16
|
|
|
17
17
|
from pymodaq_utils.abstract import ABCMeta, abstract_attribute
|
|
18
18
|
from pymodaq_utils.enums import enum_checker
|
|
19
|
+
from pymodaq_utils.warnings import deprecation_msg
|
|
19
20
|
from pymodaq_data.data import (Axis, DataDim, DataWithAxes, DataToExport, DataDistribution,
|
|
20
21
|
DataDimError, squeeze)
|
|
21
22
|
from .saving import DataType, H5SaverLowLevel
|
|
@@ -36,7 +37,7 @@ class DataBundle:
|
|
|
36
37
|
"""Convenience class to hold data to be saved or plotted"""
|
|
37
38
|
dte: DataToExport
|
|
38
39
|
node: str = None
|
|
39
|
-
settings: str = ''
|
|
40
|
+
settings: str = '' # deprecated and ignored: settings are written when the group is created
|
|
40
41
|
indexes: list[int] = None # indexes within an eventual Extended array (see DAQ_Scan)
|
|
41
42
|
axis_values: list[float | np.ndarray] = None # axis values within an eventual Enlargeable array (see Optimizers)
|
|
42
43
|
distribution: DataDistribution = field(
|
|
@@ -337,6 +338,31 @@ class DataSaverLoader(DataManagement):
|
|
|
337
338
|
""" Get the opened status of the underlying hdf5 file"""
|
|
338
339
|
return self._h5saver.isopen()
|
|
339
340
|
|
|
341
|
+
@staticmethod
|
|
342
|
+
def _get_data_metadata(data: DataWithAxes, ind_data: int, **metadata) -> dict:
|
|
343
|
+
"""Metadata saved as attributes of the h5 array holding the ind_data-th array of a DataWithAxes
|
|
344
|
+
|
|
345
|
+
Common to all the savers so that they all write the same attributes: the ones listed below, the
|
|
346
|
+
``units`` of the data and the values of its ``extra_attributes`` (see
|
|
347
|
+
:meth:`DataWithAxes.add_extra_attribute`).
|
|
348
|
+
|
|
349
|
+
Parameters
|
|
350
|
+
----------
|
|
351
|
+
data: DataWithAxes
|
|
352
|
+
ind_data: int
|
|
353
|
+
index of the array within the data
|
|
354
|
+
metadata: dict
|
|
355
|
+
specific entries (``nav_indexes``, ``distribution``...), they take precedence over the defaults
|
|
356
|
+
"""
|
|
357
|
+
meta = dict(timestamp=data.timestamp, label=data.labels[ind_data],
|
|
358
|
+
source=data.source.name, distribution=data.distribution.name,
|
|
359
|
+
origin=data.origin, units=data.units,
|
|
360
|
+
nav_indexes=tuple(data.nav_indexes) if data.nav_indexes is not None else None)
|
|
361
|
+
meta.update(metadata)
|
|
362
|
+
for name in data.extra_attributes:
|
|
363
|
+
meta[name] = getattr(data, name)
|
|
364
|
+
return meta
|
|
365
|
+
|
|
340
366
|
def add_data(self, where: Union[Node, str], data: DataWithAxes, save_axes=True, **kwargs):
|
|
341
367
|
"""Adds Array nodes to a given location adding eventually axes as others nodes and metadata
|
|
342
368
|
|
|
@@ -349,15 +375,7 @@ class DataSaverLoader(DataManagement):
|
|
|
349
375
|
"""
|
|
350
376
|
|
|
351
377
|
for ind_data in range(len(data)):
|
|
352
|
-
metadata =
|
|
353
|
-
source=data.source.name, distribution=data.distribution.name,
|
|
354
|
-
origin=data.origin,
|
|
355
|
-
units=data.units,
|
|
356
|
-
nav_indexes=tuple(data.nav_indexes)
|
|
357
|
-
if data.nav_indexes is not None else None)
|
|
358
|
-
metadata.update(kwargs)
|
|
359
|
-
for name in data.extra_attributes:
|
|
360
|
-
metadata[name] = getattr(data, name)
|
|
378
|
+
metadata = self._get_data_metadata(data, ind_data, **kwargs)
|
|
361
379
|
self._h5saver.add_array(where, self._get_next_node_name(where), self.data_type,
|
|
362
380
|
title=data.name, array_to_save=data[ind_data],
|
|
363
381
|
data_dimension=data.dim.name, metadata=metadata)
|
|
@@ -628,12 +646,9 @@ class DataEnlargeableSaver(DataSaverLoader):
|
|
|
628
646
|
array_type=data[ind_data].dtype,
|
|
629
647
|
enlargeable=True,
|
|
630
648
|
data_dimension=data.dim.name,
|
|
631
|
-
metadata=
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
distribution='spread',
|
|
635
|
-
origin=data.origin,
|
|
636
|
-
nav_indexes=tuple(nav_indexes)))
|
|
649
|
+
metadata=self._get_data_metadata(data, ind_data,
|
|
650
|
+
distribution='spread',
|
|
651
|
+
nav_indexes=tuple(nav_indexes)))
|
|
637
652
|
if data.errors is not None:
|
|
638
653
|
error_dwa = data.errors_as_dwa()
|
|
639
654
|
self._h5saver.add_array(where,
|
|
@@ -645,12 +660,9 @@ class DataEnlargeableSaver(DataSaverLoader):
|
|
|
645
660
|
array_type=error_dwa[ind_data].dtype,
|
|
646
661
|
enlargeable=True,
|
|
647
662
|
data_dimension=error_dwa.dim.name,
|
|
648
|
-
metadata=
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
distribution='spread',
|
|
652
|
-
origin=error_dwa.origin,
|
|
653
|
-
nav_indexes=tuple(nav_indexes)))
|
|
663
|
+
metadata=self._get_data_metadata(error_dwa, ind_data,
|
|
664
|
+
distribution='spread',
|
|
665
|
+
nav_indexes=tuple(nav_indexes)))
|
|
654
666
|
|
|
655
667
|
if add_enl_axes:
|
|
656
668
|
for ind_enl_axis in range(self._n_enl_axes):
|
|
@@ -781,10 +793,9 @@ class DataExtendedSaver(DataSaverLoader):
|
|
|
781
793
|
scan_shape=self.extended_shape,
|
|
782
794
|
add_scan_dim=True,
|
|
783
795
|
data_dimension=data.dim.name,
|
|
784
|
-
metadata=
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
nav_indexes=tuple(nav_indexes)))
|
|
796
|
+
metadata=self._get_data_metadata(data, ind_data,
|
|
797
|
+
distribution=distribution.name,
|
|
798
|
+
nav_indexes=tuple(nav_indexes)))
|
|
788
799
|
|
|
789
800
|
if data.errors is not None:
|
|
790
801
|
error_dwa = data.errors_as_dwa()
|
|
@@ -798,10 +809,9 @@ class DataExtendedSaver(DataSaverLoader):
|
|
|
798
809
|
scan_shape=self.extended_shape,
|
|
799
810
|
add_scan_dim=True,
|
|
800
811
|
data_dimension=error_dwa.dim.name,
|
|
801
|
-
metadata=
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
nav_indexes=tuple(nav_indexes)))
|
|
812
|
+
metadata=self._get_data_metadata(error_dwa, ind_data,
|
|
813
|
+
distribution=distribution.name,
|
|
814
|
+
nav_indexes=tuple(nav_indexes)))
|
|
805
815
|
|
|
806
816
|
|
|
807
817
|
if save_axes:
|
|
@@ -908,6 +918,21 @@ class DataToExportSaver:
|
|
|
908
918
|
def add_data_bundle(self, data: DataBundle):
|
|
909
919
|
self.add_data(data.node, data.dte, data.settings)
|
|
910
920
|
|
|
921
|
+
@staticmethod
|
|
922
|
+
def _warn_settings_deprecated(settings_as_xml=''):
|
|
923
|
+
"""Warn if settings are given to ``add_data``: they are ignored
|
|
924
|
+
|
|
925
|
+
The settings of a module, a scan or an extension are written as the ``settings`` attribute
|
|
926
|
+
of its group when this group is created (``add_det_group``, ``add_act_group``,
|
|
927
|
+
``add_scan_group``, ``add_incremental_group``...), not when data is added.
|
|
928
|
+
"""
|
|
929
|
+
if settings_as_xml not in ('', b'', None):
|
|
930
|
+
deprecation_msg('The settings_as_xml argument of DataToExportSaver.add_data (and '
|
|
931
|
+
'DataBundle.settings) is deprecated and ignored: give the settings '
|
|
932
|
+
'when creating the group, with the settings_as_xml argument of '
|
|
933
|
+
'H5SaverLowLevel.add_incremental_group (add_det_group, add_act_group, '
|
|
934
|
+
'add_scan_group...)', stacklevel=4)
|
|
935
|
+
|
|
911
936
|
def add_data(self, where: Union[Node, str], data: DataToExport, settings_as_xml='', **kwargs):
|
|
912
937
|
"""
|
|
913
938
|
|
|
@@ -917,15 +942,14 @@ class DataToExportSaver:
|
|
|
917
942
|
the path of a given node or the node itself
|
|
918
943
|
data: DataToExport
|
|
919
944
|
settings_as_xml: str
|
|
920
|
-
|
|
945
|
+
deprecated and ignored, settings are written when the group is created
|
|
921
946
|
Keyword Arguments:
|
|
922
|
-
all extra metadata to be saved
|
|
947
|
+
all extra metadata to be saved as attributes of each data array
|
|
923
948
|
|
|
924
949
|
"""
|
|
925
950
|
|
|
951
|
+
self._warn_settings_deprecated(settings_as_xml)
|
|
926
952
|
dims = data.get_dim_presents()
|
|
927
|
-
if settings_as_xml != '' and 'settings' not in kwargs:
|
|
928
|
-
kwargs['settings]'] = settings_as_xml
|
|
929
953
|
for dim in dims:
|
|
930
954
|
dim_group = self._h5saver.get_set_group(where, dim)
|
|
931
955
|
for ind, dwa in enumerate(data.get_data_from_dim(dim)):
|
|
@@ -1041,9 +1065,9 @@ class DataToExportEnlargeableSaver(DataToExportSaver):
|
|
|
1041
1065
|
axis_value: float or np.ndarray #deprecated in 4.2.0, use axis_values
|
|
1042
1066
|
The next value (or values) of the enlarged axis
|
|
1043
1067
|
settings_as_xml: str
|
|
1044
|
-
|
|
1068
|
+
deprecated and ignored, settings are written when the group is created
|
|
1045
1069
|
Keyword Arguments:
|
|
1046
|
-
all extra metadata to be saved
|
|
1070
|
+
all extra metadata to be saved as attributes of each data array
|
|
1047
1071
|
"""
|
|
1048
1072
|
|
|
1049
1073
|
if axis_values is None and axis_value is not None:
|
|
@@ -1145,11 +1169,12 @@ class DataToExportExtendedSaver(DataToExportSaver):
|
|
|
1145
1169
|
indexes where to save data in the init h5array (should have the same length as
|
|
1146
1170
|
extended_shape and with values coherent with this shape
|
|
1147
1171
|
settings_as_xml: str
|
|
1148
|
-
|
|
1172
|
+
deprecated and ignored, settings are written when the group is created
|
|
1149
1173
|
Keyword Arguments:
|
|
1150
|
-
|
|
1174
|
+
not used by this saver
|
|
1151
1175
|
|
|
1152
1176
|
"""
|
|
1177
|
+
self._warn_settings_deprecated(settings_as_xml)
|
|
1153
1178
|
dims = data.get_dim_presents()
|
|
1154
1179
|
for dim in dims:
|
|
1155
1180
|
dim_group = self._h5saver.get_set_group(where, dim)
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/exporters/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/h5modules/exporters/hyperspy.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/plotting/plotter/plotters/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{pymodaq_data-5.3.10 → pymodaq_data-5.3.11}/src/pymodaq_data/post_treatment/process_to_scalar.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|