Skip to content

Configuration options

The configuration options module defines tools to acquire and change global configuration options

ConfigOptions

Holds global configuration options and offers the possibility to changes them

Source code in mlpyqtgraph/config.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class ConfigOptions:
    """
    Holds global configuration options and offers the possibility to changes
    them
    """
    config_options = {
        'line_color_profile': 'matlab',
        'colormap': 'viridis',
        'projection': 'perspective',
        'antialiasing': True,
        'segmentedLineMode': 'off',
        'no_segmented_line_mode': False,
        'black_on_white': True,
    }

    def __init__(self, **kwargs):
        self.set_options(**kwargs)

    def set_options(self, **kwargs):
        """ Change one or more global configuration options """
        self.config_options = dict(self.config_options, **kwargs)
        self.enable_pg_options()

    def enable_pg_options(self):
        """ Activate pyqtgraph options """
        pg.setConfigOption('background', 'k')
        pg.setConfigOption('foreground', 'w')
        if self.config_options['black_on_white']:
            pg.setConfigOption('background', 'w')
            pg.setConfigOption('foreground', 'k')
        pg.setConfigOptions(antialias=self.config_options['antialiasing'])
        self.config_options['no_segmented_line_mode'] = False
        try:
            pg.setConfigOption('segmentedLineMode',
                               self.config_options['segmentedLineMode'])
        except KeyError:
            self.config_options['no_segmented_line_mode'] = True

    def get_option(self, option):
        """ Obtain or more global configuration options """
        return self.config_options[option]

enable_pg_options()

Activate pyqtgraph options

Source code in mlpyqtgraph/config.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def enable_pg_options(self):
    """ Activate pyqtgraph options """
    pg.setConfigOption('background', 'k')
    pg.setConfigOption('foreground', 'w')
    if self.config_options['black_on_white']:
        pg.setConfigOption('background', 'w')
        pg.setConfigOption('foreground', 'k')
    pg.setConfigOptions(antialias=self.config_options['antialiasing'])
    self.config_options['no_segmented_line_mode'] = False
    try:
        pg.setConfigOption('segmentedLineMode',
                           self.config_options['segmentedLineMode'])
    except KeyError:
        self.config_options['no_segmented_line_mode'] = True

get_option(option)

Obtain or more global configuration options

Source code in mlpyqtgraph/config.py 
47
48
49
def get_option(self, option):
    """ Obtain or more global configuration options """
    return self.config_options[option]

set_options(**kwargs)

Change one or more global configuration options

Source code in mlpyqtgraph/config.py 
27
28
29
30
def set_options(self, **kwargs):
    """ Change one or more global configuration options """
    self.config_options = dict(self.config_options, **kwargs)
    self.enable_pg_options()