8.7. pymodaq_data package

• 8.7.1. pymodaq_data.h5modules package
  • 8.7.1.1. pymodaq_data.h5modules.exporters package
    • 8.7.1.1.1. pymodaq_data.h5modules.exporters.base module
      • H5h5Exporter
      • H5npyExporter
      • H5txtExporter
    • 8.7.1.1.2. pymodaq_data.h5modules.exporters.flimj module
      • H5asciiExporter
    • 8.7.1.1.3. pymodaq_data.h5modules.exporters.hyperspy module
  • 8.7.1.2. pymodaq_data.h5modules.backends module
    • InvalidDataDimension
    • InvalidDataType
    • InvalidExport
    • InvalidGroupDataType
    • InvalidGroupType
    • InvalidSave
    • InvalidScanType
    • NodeError
    • Attributes
      • Attributes.get()
      • Attributes.to_dict()
      • Attributes.attrs_name
      • Attributes.node
    • CARRAY
      • CARRAY.read()
      • CARRAY.array
    • EARRAY
      • EARRAY.append()
      • EARRAY.append_backend()
    • GROUP
      • GROUP.children()
      • GROUP.children_name()
      • GROUP.get_child()
      • GROUP.remove_children()
    • GroupType
      • GroupType.actuator
      • GroupType.ch
      • GroupType.data
      • GroupType.data_dim
      • GroupType.data_logger
      • GroupType.detector
      • GroupType.external_h5
      • GroupType.scan
    • H5Backend
      • H5Backend.add_group()
      • H5Backend.close_file()
      • H5Backend.create_carray()
      • H5Backend.create_earray()
      • H5Backend.create_vlarray()
      • H5Backend.define_compression()
      • H5Backend.enable_swmr()
      • H5Backend.finalize_swmr()
      • H5Backend.flush()
      • H5Backend.get_attr()
      • H5Backend.get_children()
      • H5Backend.get_group_by_title()
      • H5Backend.get_node()
      • H5Backend.get_node_name()
      • H5Backend.get_node_path()
      • H5Backend.get_parent_node()
      • H5Backend.get_set_group()
      • H5Backend.has_attr()
      • H5Backend.is_node_in_group()
      • H5Backend.isopen()
      • H5Backend.open_file()
      • H5Backend.read()
      • H5Backend.reconcile_swmr_attrs()
      • H5Backend.root()
      • H5Backend.save_file_as()
      • H5Backend.set_attr()
      • H5Backend.set_backend()
      • H5Backend.walk_groups()
      • H5Backend.walk_nodes()
      • H5Backend.filename
      • H5Backend.h5file
      • H5Backend.is_swmr_active
      • H5Backend.is_swmr_capable
      • H5Backend.is_swmr_compatible
      • H5Backend.swmr_mode
    • Node
      • Node.get_attr()
      • Node.set_attr()
      • Node.to_h5_backend()
      • Node.attrs
      • Node.h5file
      • Node.name
      • Node.node
      • Node.parent_node
      • Node.path
      • Node.title
    • SaveType
      • SaveType.actuator
      • SaveType.custom
      • SaveType.detector
      • SaveType.logger
      • SaveType.optimizer
      • SaveType.scan
    • StringARRAY
      • StringARRAY.append()
      • StringARRAY.array_to_string()
      • StringARRAY.read()
      • StringARRAY.string_to_array()
    • VLARRAY
      • VLARRAY.append()
      • VLARRAY.append_backend()
    • check_mandatory_attrs()
    • get_attr()
    • set_attr()
  • 8.7.1.3. pymodaq_data.h5modules.browsing module
    • H5BrowserUtil
      • H5BrowserUtil.export_data()
      • H5BrowserUtil.get_h5_attributes()
      • H5BrowserUtil.get_h5file_scans()
  • 8.7.1.4. pymodaq_data.h5modules.data_saving module
    • AxisError
    • AxisSaverLoader
      • AxisSaverLoader.add_axis()
      • AxisSaverLoader.get_axes()
      • AxisSaverLoader.load_axis()
      • AxisSaverLoader.data_type
    • BkgSaver
      • BkgSaver.data_type
    • DataBundle
      • DataBundle.axis_values
      • DataBundle.distribution
      • DataBundle.dte
      • DataBundle.indexes
      • DataBundle.node
      • DataBundle.save_index
      • DataBundle.settings
    • DataEnlargeableSaver
      • DataEnlargeableSaver.add_data()
      • DataEnlargeableSaver.data_type
    • DataExtendedSaver
      • DataExtendedSaver.add_data()
      • DataExtendedSaver.data_type
    • DataLoader
      • DataLoader.close_file()
      • DataLoader.get_nav_group()
      • DataLoader.get_node()
      • DataLoader.load_all()
      • DataLoader.load_data()
      • DataLoader.load_data_from_name_origin()
      • DataLoader.walk_nodes()
      • DataLoader.h5saver
      • DataLoader.raw_group
    • DataManagement
      • DataManagement.close()
      • DataManagement.close_file()
      • DataManagement.get_index_from_node_name()
      • DataManagement.get_last_node_name()
      • DataManagement.get_node_from_index()
      • DataManagement.data_type
      • DataManagement.raw_group
    • DataSaverLoader
      • DataSaverLoader.add_data()
      • DataSaverLoader.get_axes()
      • DataSaverLoader.get_bkg_nodes()
      • DataSaverLoader.get_data_arrays()
      • DataSaverLoader.isopen()
      • DataSaverLoader.load_data()
      • DataSaverLoader.data_type
    • DataToExportEnlargeableSaver
      • DataToExportEnlargeableSaver.add_data()
      • DataToExportEnlargeableSaver.add_data_bundle()
    • DataToExportExtendedSaver
      • DataToExportExtendedSaver.add_data()
      • DataToExportExtendedSaver.add_data_bundle()
      • DataToExportExtendedSaver.add_nav_axes()
    • DataToExportSaver
      • DataToExportSaver.channel_formatter()
      • DataToExportSaver.add_bkg()
      • DataToExportSaver.add_data()
      • DataToExportSaver.add_data_bundle()
      • DataToExportSaver.add_error()
      • DataToExportSaver.close()
      • DataToExportSaver.close_file()
      • DataToExportSaver.isopen()
      • DataToExportSaver.h5saver
    • DataToExportTimedSaver
      • DataToExportTimedSaver.add_data()
      • DataToExportTimedSaver.add_data_bundle()
    • ErrorSaverLoader
      • ErrorSaverLoader.data_type
  • 8.7.1.5. pymodaq_data.h5modules.exporter module
    • ExporterFactory
      • ExporterFactory.create_exporter()
      • ExporterFactory.get_file_filters()
      • ExporterFactory.register_exporter()
      • ExporterFactory.get_format_from_filter()
      • ExporterFactory.exporters_registry
      • ExporterFactory.file_filters
  • 8.7.1.6. pymodaq_data.h5modules.saving module
    • DataType
      • DataType.axis
      • DataType.bkg
      • DataType.data
      • DataType.data_enlargeable
      • DataType.error
      • DataType.external_h5
      • DataType.live_scan
      • DataType.strings
    • FileType
      • FileType.actuator
      • FileType.axis
      • FileType.detector
      • FileType.scan
    • H5SaverLowLevel
      • H5SaverLowLevel.from_file()
      • H5SaverLowLevel.add_act_group()
      • H5SaverLowLevel.add_array()
      • H5SaverLowLevel.add_ch_group()
      • H5SaverLowLevel.add_data_group()
      • H5SaverLowLevel.add_det_group()
      • H5SaverLowLevel.add_generic_group()
      • H5SaverLowLevel.add_incremental_group()
      • H5SaverLowLevel.add_log()
      • H5SaverLowLevel.add_move_group()
      • H5SaverLowLevel.add_scan_group()
      • H5SaverLowLevel.add_string_array()
      • H5SaverLowLevel.get_groups()
      • H5SaverLowLevel.get_last_group()
      • H5SaverLowLevel.get_node_from_attribute_match()
      • H5SaverLowLevel.get_node_from_title()
      • H5SaverLowLevel.get_set_group()
      • H5SaverLowLevel.get_set_logger()
      • H5SaverLowLevel.init_file()
      • H5SaverLowLevel.save_file()
      • H5SaverLowLevel.set_swmr_flush_interval()
      • H5SaverLowLevel.tick_flush()
      • H5SaverLowLevel.fill_value
      • H5SaverLowLevel.h5_file
      • H5SaverLowLevel.raw_group
  • 8.7.1.7. pymodaq_data.h5modules.swmr module
    • 8.7.1.7.1. Typical usage
    • collect_datasets()
    • refresh_cached()
    • refresh_datasets()
  • 8.7.1.8. pymodaq_data.h5modules.utils module
    • extract_axis()
    • find_scan_node()
    • get_h5_attributes()
    • get_h5_data_from_node()
    • register_exporter()
    • register_exporters()
    • verify_axis_data_uniformity()
  • is_file_swmr_active()
  • open_h5_file_for_reading()
• 8.7.2. pymodaq_data.plotting package
  • 8.7.2.1. pymodaq_data.plotting.utils module
    • PlotColors
      • PlotColors.check_color()
      • PlotColors.check_colors()
      • PlotColors.copy()
      • PlotColors.remove()
• 8.7.3. pymodaq_data.post_treatment package
  • 8.7.3.1. pymodaq_data.post_treatment.process_to_scalar module
    • ArgMaxProcessor
      • ArgMaxProcessor.operate()
      • ArgMaxProcessor.apply_to
    • ArgMeanProcessor
      • ArgMeanProcessor.operate()
      • ArgMeanProcessor.apply_to
    • ArgMinProcessor
      • ArgMinProcessor.operate()
      • ArgMinProcessor.apply_to
    • ArgStdProcessor
      • ArgStdProcessor.operate()
      • ArgStdProcessor.apply_to
    • DataProcessorBase
      • DataProcessorBase.apply_to
      • DataProcessorBase.flatten_signal_dim()
      • DataProcessorBase.operate()
      • DataProcessorBase.process()
    • DataProcessorFactory
      • DataProcessorFactory.functions_filtered()
      • DataProcessorFactory.get()
      • DataProcessorFactory.functions
    • MaxProcessor
      • MaxProcessor.operate()
      • MaxProcessor.apply_to
    • MeanProcessor
      • MeanProcessor.operate()
      • MeanProcessor.apply_to
    • MinProcessor
      • MinProcessor.operate()
      • MinProcessor.apply_to
    • StdProcessor
      • StdProcessor.operate()
      • StdProcessor.apply_to
    • SumProcessor
      • SumProcessor.operate()
      • SumProcessor.apply_to
• 8.7.4. pymodaq_data.resources package

• 8.7.5. pymodaq_data.config module
  • Config
    • Config.config_name
    • Config.config_template_path
• 8.7.6. pymodaq_data.data module
  • DataDimError
  • DataDimWarning
  • DataIndexWarning
  • DataLengthError
  • DataShapeError
  • DataSizeWarning
  • DataTypeWarning
  • DataUnitError
  • warning
  • Averaging
    • Averaging.AVERAGED
    • Averaging.N_AVERAGED
  • AxesManagerBase
    • AxesManagerBase.append_axis()
    • AxesManagerBase.compute_shape_from_axes()
    • AxesManagerBase.compute_sig_indexes()
    • AxesManagerBase.get_axes_index()
    • AxesManagerBase.get_axis_from_index()
    • AxesManagerBase.get_axis_from_index_spread()
    • AxesManagerBase.get_nav_axes()
    • AxesManagerBase.get_shape_from_index()
    • AxesManagerBase.get_signal_axes()
    • AxesManagerBase.get_sorted_index()
    • AxesManagerBase.is_axis_navigation()
    • AxesManagerBase.is_axis_signal()
    • AxesManagerBase.axes
    • AxesManagerBase.nav_axes
    • AxesManagerBase.nav_indexes
    • AxesManagerBase.nav_shape
    • AxesManagerBase.shape
    • AxesManagerBase.sig_indexes
    • AxesManagerBase.sig_shape
  • AxesManagerSpread
    • AxesManagerSpread.compute_shape_from_axes()
    • AxesManagerSpread.get_axis_from_index()
    • AxesManagerSpread.get_axis_from_index_spread()
    • AxesManagerSpread.get_shape_from_index()
    • AxesManagerSpread.get_sorted_index()
  • AxesManagerUniform
    • AxesManagerUniform.compute_shape_from_axes()
    • AxesManagerUniform.get_axis_from_index()
    • AxesManagerUniform.get_axis_from_index_spread()
    • AxesManagerUniform.get_shape_from_index()
    • AxesManagerUniform.get_sorted_index()
  • Axis
    • Axis.create_simple_linear_data()
    • Axis.deserialize()
    • Axis.from_quantity()
    • Axis.serialize()
    • Axis.as_dwa()
    • Axis.copy()
    • Axis.create_linear_data()
    • Axis.find_index()
    • Axis.find_indexes()
    • Axis.flip()
    • Axis.force_units()
    • Axis.get_data()
    • Axis.get_data_at()
    • Axis.get_quantity()
    • Axis.get_scale_offset_from_data()
    • Axis.is_axis_linear()
    • Axis.max()
    • Axis.mean()
    • Axis.min()
    • Axis.to_base_units()
    • Axis.to_reduced_units()
    • Axis.units_as()
    • Axis.axis_width
    • Axis.base_type
    • Axis.data
    • Axis.iaxis
    • Axis.index
    • Axis.label
    • Axis.offset
    • Axis.scaling
    • Axis.size
    • Axis.units
    • Axis.vaxis
  • DataBase
    • DataBase.get_origin_name_from_full_name()
    • DataBase.abs()
    • DataBase.add_extra_attribute()
    • DataBase.angle()
    • DataBase.append()
    • DataBase.as_dte()
    • DataBase.average()
    • DataBase.check_shape_from_data()
    • DataBase.deepcopy()
    • DataBase.equal_to()
    • DataBase.fliplr()
    • DataBase.flipud()
    • DataBase.force_units()
    • DataBase.get_data_index()
    • DataBase.get_dim_from_data()
    • DataBase.get_full_name()
    • DataBase.imag()
    • DataBase.pop()
    • DataBase.real()
    • DataBase.set_dim()
    • DataBase.split_as_dte()
    • DataBase.stack_as_array()
    • DataBase.to_base_units()
    • DataBase.to_dB()
    • DataBase.to_dict()
    • DataBase.units_as()
    • DataBase.unwrap()
    • DataBase.value()
    • DataBase.values()
    • DataBase.averaged
    • DataBase.base_type
    • DataBase.data
    • DataBase.dim
    • DataBase.distribution
    • DataBase.labels
    • DataBase.length
    • DataBase.n_averaged
    • DataBase.quantities
    • DataBase.shape
    • DataBase.size
    • DataBase.source
    • DataBase.units
  • DataCalculated
  • DataDim
    • DataDim.from_data_array()
    • DataDim.Data0D
    • DataDim.Data1D
    • DataDim.Data2D
    • DataDim.DataND
    • DataDim.dim_index
  • DataDistribution
    • DataDistribution.spread
    • DataDistribution.uniform
  • DataFromRoi
  • DataLowLevel
    • DataLowLevel.name
    • DataLowLevel.timestamp
  • DataRaw
  • DataSource
    • DataSource.calculated
    • DataSource.raw
  • DataToExport
    • DataToExport.deserialize()
    • DataToExport.from_xarray()
    • DataToExport.serialize()
    • DataToExport.add_extra_attribute()
    • DataToExport.affect_name_to_origin_if_none()
    • DataToExport.average()
    • DataToExport.deepcopy()
    • DataToExport.get_data_from_Naxes()
    • DataToExport.get_data_from_attribute()
    • DataToExport.get_data_from_dim()
    • DataToExport.get_data_from_dims()
    • DataToExport.get_data_from_full_name()
    • DataToExport.get_data_from_full_names()
    • DataToExport.get_data_from_missing_attribute()
    • DataToExport.get_data_from_name()
    • DataToExport.get_data_from_name_origin()
    • DataToExport.get_data_from_names()
    • DataToExport.get_data_from_origins()
    • DataToExport.get_data_from_sig_axes()
    • DataToExport.get_data_from_source()
    • DataToExport.get_data_with_naxes_lower_than()
    • DataToExport.get_dim_presents()
    • DataToExport.get_full_names()
    • DataToExport.get_names()
    • DataToExport.get_origins()
    • DataToExport.index()
    • DataToExport.index_from_name_origin()
    • DataToExport.merge_as_dwa()
    • DataToExport.plot()
    • DataToExport.pop()
    • DataToExport.remove()
    • DataToExport.to_xarray()
    • DataToExport.append
    • DataToExport.data
  • DataWithAxes
    • DataWithAxes.deserialize()
    • DataWithAxes.from_xarray()
    • DataWithAxes.serialize()
    • DataWithAxes.axes_limits()
    • DataWithAxes.check_axes_linear()
    • DataWithAxes.check_squeeze()
    • DataWithAxes.create_missing_axes()
    • DataWithAxes.crop_at_along()
    • DataWithAxes.deepcopy_with_new_data()
    • DataWithAxes.errors_as_dwa()
    • DataWithAxes.find_peaks()
    • DataWithAxes.fit()
    • DataWithAxes.ft()
    • DataWithAxes.get_axes_sizes()
    • DataWithAxes.get_axis_from_index()
    • DataWithAxes.get_axis_from_index_spread()
    • DataWithAxes.get_axis_from_label()
    • DataWithAxes.get_axis_indexes()
    • DataWithAxes.get_data_as_dwa()
    • DataWithAxes.get_data_dimension()
    • DataWithAxes.get_dim_from_data_axes()
    • DataWithAxes.get_error()
    • DataWithAxes.get_nav_axes()
    • DataWithAxes.get_nav_axes_with_data()
    • DataWithAxes.get_sig_index()
    • DataWithAxes.ift()
    • DataWithAxes.interp()
    • DataWithAxes.mean()
    • DataWithAxes.moment()
    • DataWithAxes.pad()
    • DataWithAxes.plot()
    • DataWithAxes.rot90()
    • DataWithAxes.set_axes_manager()
    • DataWithAxes.sort_data()
    • DataWithAxes.sum()
    • DataWithAxes.to_xarray()
    • DataWithAxes.transpose()
    • DataWithAxes.axes
    • DataWithAxes.errors
    • DataWithAxes.n_axes
    • DataWithAxes.nav_indexes
    • DataWithAxes.sig_indexes
  • DwaType
    • DwaType.DataActuator
    • DwaType.DataCalculated
    • DwaType.DataFromPlugins
    • DwaType.DataRaw
    • DwaType.DataWithAxes
  • NavAxis
    • NavAxis.iaxis
    • NavAxis.vaxis
  • check_units()
  • dimensionless_aware_reduce_units()
  • parse_quantity()
  • squeeze()
• 8.7.7. pymodaq_data.numpy_func module
  • implements()
  • process_arguments_for_ufuncs()
  • process_with_reduced_dimensions()
• 8.7.8. pymodaq_data.slicing module
  • SpecialSlicers
  • SpecialSlicersData