mad_gui.start_gui#
- mad_gui.start_gui(data_dir=PosixPath('.'), plugins: ~typing.Sequence[~mad_gui.plugins.base.BasePlugin] | None = (<class 'mad_gui.plugins.example.ExampleImporter'>, <class 'mad_gui.plugins.example.StationaryMomentsDetector'>, <class 'mad_gui.plugins.example.EnergyCalculator'>, <class 'mad_gui.plugins.example.ExampleExporter'>), labels: ~typing.Sequence[~mad_gui.plot_tools.labels.base_label.BaseRegionLabel] | None = (<class 'mad_gui.plugins.example.ActivityLabel'>, <class 'mad_gui.plugins.example.Stride'>), events: ~typing.Sequence[~mad_gui.plot_tools.labels.base_label.BaseEventLabel] | None = (<class 'mad_gui.plugins.example.MyEvent'>, ), settings: ~typing.Type[~mad_gui.config.settings.BaseSettings] | None = <class 'mad_gui.config.settings.BaseSettings'>, theme: ~typing.Type[~mad_gui.config.theme.BaseTheme] | None = <class 'mad_gui.config.theme.BaseTheme'>, use_opengl: bool = True)[source]#
Use this function to start the GUI and pass your plugins, like importers and algorithms to it.
Please look at the See Also section below, to learn more about how to create objects of the classes you can pass to this function.
- Parameters:
- events
The event labels you want to use. They inherit from
BaseEventLabel.- data_dir
The base path where there user will be directed to when opening a file.
- plugins
Mostly you will adapt the GUI via this. The plugins must inherit from either of these:
BaseImporter,BaseExporter,BaseAlgorithm.- labels
The region labels you want to use. They inherit from
BaseRegionLabel.- settings
Change some settings like the snap range, if you set your label's snap_to_min or snap_to_max to True
- theme
Change the two main colors (light and dark) of the GUI using this
- use_opengl
If you want to use OpenGL for the plots, set this to True. On some operating systems, this makes zooming and scrolling much smoother. However, under Linux this can cause degraded performance, so you can set it to False there.