Skip to content

Axes

mlpyqtgraph axes module, with 2D and 3D Axis classes

Axis

General Axis class, creates either 2D or 3D axis

Source code in mlpyqtgraph/axes.py 
630
631
632
633
634
635
636
637
638
class Axis:
    """ General Axis class, creates either 2D or 3D axis """
    def __new__(cls, *args, **kwargs):
        axis_type = kwargs.pop('axis_type', '2D')
        if axis_type == '2D':
            return Axis2D(*args, **kwargs)
        if axis_type == '3D':
            return Axis3D(*args, **kwargs)
        raise InvalidAxis(f'Invalid Axis Type: {axis_type}. Should be either 2D or 3D')

Axis2D

Bases: PlotItem

Axis for plots in a given figure layout

Source code in mlpyqtgraph/axes.py 
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
class Axis2D(PlotItem):  # noqa: PLR0904
    """ Axis for plots in a given figure layout """
    pen_styles = {'-': QtCore.Qt.SolidLine,
                  '--': QtCore.Qt.DashLine,
                  ':': QtCore.Qt.DotLine,
                  '.-': QtCore.Qt.DashDotLine}

    def __init__(self, index, **kwargs):
        parent = kwargs.pop('parent', None)
        super().__init__(parent=parent, **kwargs)
        self.index = index
        self.colors_defs = colors.ColorDefinitions()
        self.line_colors = self.colors_defs.get_line_colors()
        self.scale_box_line_color = \
            self.colors_defs.get_scale_box_colors(part='line')
        self.scale_box_fill_color = \
            self.colors_defs.get_scale_box_colors(part='fill')
        self.setup()

    def setup(self, padding=0.01):
        """ Setup axes and grid """
        self.show_axis_border('right')
        self.show_axis_border('top')
        self.getViewBox().setDefaultPadding(padding=padding)
        self.getViewBox().rbScaleBox.setPen(fn.mkPen(self.scale_box_line_color, width=2))
        self.getViewBox().rbScaleBox.setBrush(fn.mkBrush(*self.scale_box_fill_color))
        for axis_key in self.axes:
            self.getAxis(axis_key).setZValue(-1) # force axis and corresponding ticks to background

    @property
    def x_axis(self):
        """ Returns the x-axis """
        return self.getAxis('bottom')

    @property
    def y_axis(self):
        """ Returns the y-axis """
        return self.getAxis('left')

    def show_axis_border(self, axis):
        """ Enables/shows an axis, wihtout values and ticks

        Parameters:
            axis: axis string designation, 'left', 'top', 'right' or 'bottom'
        """
        self.showAxis(axis, show=True)
        self.getAxis(axis).setStyle(showValues=False)
        self.getAxis(axis).setTicks([(),()])

    def get_line_color(self, index=None):
        """ Generate line color for given index """
        return self.line_colors[index % len(self.line_colors)]

    def default_line_color(self):
        """ Returns next available color, based on the number of plotted lines """
        return self.get_line_color(len(self.listDataItems()))

    @staticmethod
    def fix_line_artifacts(width, color):
        """
        Fall to conventional slower drawing method by settings alpha < 1

        pyqtgraph pull request #2011 introduced a new (experimental) line
        drawing mode for thick lines. This also leads to unwanted line artifacts
        if antialiasing is enabled. This method causes a fallback to the old
        (slower) drawing method.
        """
        if width > 1:
            if color in fn.Colors:
                qcolor = fn.Colors[color]
                color = (qcolor.red(), qcolor.green(), qcolor.blue())
            return color[:3] + (254,)
        return color

    def add(self, x_coord: np.ndarray, y_coord: np.ndarray, **kwargs):
        """Add a line to the Axes

        Arguments:
            x_coord:
                x coordinates
            y_coord:
                y coordinates

        Keyword arguments:
            color:
                line color, default value will determine using
                [`default_line_color`](./#mlpyqtgraph.axes.Axis2D.default_line_color)
            style:
                line style
            width:
                line width
            symbol:
                symbol type symbol_size: symbol size
            symbol_color:
                symbol color

        """
        color = kwargs.get('color', self.default_line_color())
        width = kwargs.get('width', 2.0)
        if options.get_option('no_segmented_line_mode'):
            color = self.fix_line_artifacts(width, color)
        style = kwargs.get('style', '-')
        symbol = kwargs.get('symbol')
        symbol_size = kwargs.get('symbol_size', 5)
        symbol_color = kwargs.get('symbol_color', 'k')

        line_pen = None
        if width > 0:
            line_pen = mkPen(color, width=width)
            if style:
                line_pen.setStyle(self.pen_styles[style])

        symbol_pen = None
        if symbol is not None:
            symbol_pen = mkPen(symbol_color, width=0)

        self.plot(x_coord, y_coord,
                  pen=line_pen, symbol=symbol, symbolSize=symbol_size,
                  symbolPen=symbol_pen, symbolBrush=symbol_color)

    @property
    def grid(self):
        """ Returns grid activation state """
        return self.ctrl.xGridCheck.isChecked() and self.ctrl.yGridCheck.isChecked()

    @grid.setter
    def grid(self, active=False):
        """ Set gris activation """
        self.showGrid(x=active, y=active, alpha=0.5)

    @property
    def xlim(self):
        """ Obtain xlimits """
        return self.x_axis.range

    @xlim.setter
    def xlim(self, limits):
        """ Change x limits """
        self.setLimits(xMin=limits[0], xMax=limits[1])
        self.setRange(xRange=limits)

    @property
    def ylim(self):
        """ Obtain ylimits """
        return self.y_axis.range

    @ylim.setter
    def ylim(self, limits):
        """ Change y limits """
        self.setLimits(yMin=limits[0], yMax=limits[1])
        self.setRange(yRange=limits)

    @property
    def xlabel(self):
        """ Obtain xlabel """
        return self.x_axis.label.toPlainText()

    @xlabel.setter
    def xlabel(self, label, units=None):
        """ Change x label """
        self.x_axis.setLabel(label, units=units)

    @property
    def ylabel(self):
        """ Obtain ylabel """
        return self.y_axis.label.toPlainText()

    @ylabel.setter
    def ylabel(self, label, units=None):
        """ Change y label """
        self.y_axis.setLabel(label, units=units)

    @property
    def xticks(self):
        """ Obtain x tick labels """
        return self.get_ticks(self.x_axis)

    @xticks.setter
    def xticks(self, major):
        """ Change x tick labels """
        self.set_xticks(major)

    @property
    def yticks(self):
        """ Obtain y tick labels """
        return self.get_ticks(self.y_axis)

    @yticks.setter
    def yticks(self, major):
        """ Sets major tick labels on y-axis  """
        self.set_yticks(major)

    def set_xticks(self, major, minor=None):
        """ Sets the major and minor ticks on the x-axis """
        self.set_ticks(self.x_axis, major, minor)

    def set_yticks(self, major, minor=None):
        """ Sets the major and minor ticks on the y-axis """
        self.set_ticks(self.y_axis, major, minor)

    @staticmethod
    def set_ticks(axis, major, minor=None):
        """ Sets the major and minor ticks on a given axis """
        if minor is None:
            minor = ()
        axis.setTicks([major, minor])

    def add_legend(self, *legend_labels, offset=(1,1)):
        """ Add legend labels """
        legend_brush = mkBrush(color=(255, 255, 255, 200))
        self.addLegend(brush=legend_brush, verSpacing=-5, offset=offset)
        plot_items = self.listDataItems()
        for label, item in zip(legend_labels, plot_items):
            self.legend.addItem(item, label)

    def get_axis_span(self, axis):
        """ Determine span of this axis """
        bounds = axis.mapRectFromParent(axis.geometry())
        if axis.orientation == 'left':
            return (bounds.topRight(), bounds.bottomRight())
        if axis.orientation == 'right':
            return (bounds.topLeft(), bounds.bottomLeft())
        if axis.orientation == 'top':
            return (bounds.bottomLeft(), bounds.bottomRight())
        if axis.orientation == 'bottom':
            return (bounds.topLeft(), bounds.topRight())
        return None

    def get_axis_size(self, axis):
        """ Determine size of this axis in pixels """
        axis_span = self.get_axis_span(axis)
        if axis_span is None:
            return None
        points = list(map(self.mapToDevice, axis_span))
        if None in points:
            return None
        length_px = Point(points[1] - points[0]).length()
        if length_px == 0:
            return None
        return length_px

    def get_ticks(self, axis):
        """ Obtain the tick values for a given axis """
        if axis._tickLevels is not None:
            return axis._tickLevels  # return manually set ticks
        length_px = self.get_axis_size(axis)
        if length_px is None:
            return []
        tick_values = axis.tickValues(axis.range[0], axis.range[1], length_px)
        ticks = list()
        for (_, values) in tick_values:
            ticks.extend(values)
        return sorted(ticks)

    def delete(self):
        """ Closes the axis """

grid property writable

Returns grid activation state

x_axis property

Returns the x-axis

xlabel property writable

Obtain xlabel

xlim property writable

Obtain xlimits

xticks property writable

Obtain x tick labels

y_axis property

Returns the y-axis

ylabel property writable

Obtain ylabel

ylim property writable

Obtain ylimits

yticks property writable

Obtain y tick labels

add(x_coord, y_coord, **kwargs)

Add a line to the Axes

Parameters:

Name Type Description Default
x_coord ndarray

x coordinates

 required
y_coord ndarray

y coordinates

 required

Other Parameters:

Name Type Description
color

line color, default value will determine using default_line_color
style

line style
width

line width
symbol

symbol type symbol_size: symbol size
symbol_color

symbol color
Source code in mlpyqtgraph/axes.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
def add(self, x_coord: np.ndarray, y_coord: np.ndarray, **kwargs):
    """Add a line to the Axes

    Arguments:
        x_coord:
            x coordinates
        y_coord:
            y coordinates

    Keyword arguments:
        color:
            line color, default value will determine using
            [`default_line_color`](./#mlpyqtgraph.axes.Axis2D.default_line_color)
        style:
            line style
        width:
            line width
        symbol:
            symbol type symbol_size: symbol size
        symbol_color:
            symbol color

    """
    color = kwargs.get('color', self.default_line_color())
    width = kwargs.get('width', 2.0)
    if options.get_option('no_segmented_line_mode'):
        color = self.fix_line_artifacts(width, color)
    style = kwargs.get('style', '-')
    symbol = kwargs.get('symbol')
    symbol_size = kwargs.get('symbol_size', 5)
    symbol_color = kwargs.get('symbol_color', 'k')

    line_pen = None
    if width > 0:
        line_pen = mkPen(color, width=width)
        if style:
            line_pen.setStyle(self.pen_styles[style])

    symbol_pen = None
    if symbol is not None:
        symbol_pen = mkPen(symbol_color, width=0)

    self.plot(x_coord, y_coord,
              pen=line_pen, symbol=symbol, symbolSize=symbol_size,
              symbolPen=symbol_pen, symbolBrush=symbol_color)

add_legend(*legend_labels, offset=(1, 1))

Add legend labels

Source code in mlpyqtgraph/axes.py 
236
237
238
239
240
241
242
def add_legend(self, *legend_labels, offset=(1,1)):
    """ Add legend labels """
    legend_brush = mkBrush(color=(255, 255, 255, 200))
    self.addLegend(brush=legend_brush, verSpacing=-5, offset=offset)
    plot_items = self.listDataItems()
    for label, item in zip(legend_labels, plot_items):
        self.legend.addItem(item, label)

default_line_color()

Returns next available color, based on the number of plotted lines

Source code in mlpyqtgraph/axes.py 
82
83
84
def default_line_color(self):
    """ Returns next available color, based on the number of plotted lines """
    return self.get_line_color(len(self.listDataItems()))

delete()

Closes the axis

Source code in mlpyqtgraph/axes.py 
283
284
def delete(self):
    """ Closes the axis """

fix_line_artifacts(width, color) staticmethod

Fall to conventional slower drawing method by settings alpha < 1

pyqtgraph pull request #2011 introduced a new (experimental) line drawing mode for thick lines. This also leads to unwanted line artifacts if antialiasing is enabled. This method causes a fallback to the old (slower) drawing method.

Source code in mlpyqtgraph/axes.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
@staticmethod
def fix_line_artifacts(width, color):
    """
    Fall to conventional slower drawing method by settings alpha < 1

    pyqtgraph pull request #2011 introduced a new (experimental) line
    drawing mode for thick lines. This also leads to unwanted line artifacts
    if antialiasing is enabled. This method causes a fallback to the old
    (slower) drawing method.
    """
    if width > 1:
        if color in fn.Colors:
            qcolor = fn.Colors[color]
            color = (qcolor.red(), qcolor.green(), qcolor.blue())
        return color[:3] + (254,)
    return color

get_axis_size(axis)

Determine size of this axis in pixels

Source code in mlpyqtgraph/axes.py 
257
258
259
260
261
262
263
264
265
266
267
268
def get_axis_size(self, axis):
    """ Determine size of this axis in pixels """
    axis_span = self.get_axis_span(axis)
    if axis_span is None:
        return None
    points = list(map(self.mapToDevice, axis_span))
    if None in points:
        return None
    length_px = Point(points[1] - points[0]).length()
    if length_px == 0:
        return None
    return length_px

get_axis_span(axis)

Determine span of this axis

Source code in mlpyqtgraph/axes.py 
244
245
246
247
248
249
250
251
252
253
254
255
def get_axis_span(self, axis):
    """ Determine span of this axis """
    bounds = axis.mapRectFromParent(axis.geometry())
    if axis.orientation == 'left':
        return (bounds.topRight(), bounds.bottomRight())
    if axis.orientation == 'right':
        return (bounds.topLeft(), bounds.bottomLeft())
    if axis.orientation == 'top':
        return (bounds.bottomLeft(), bounds.bottomRight())
    if axis.orientation == 'bottom':
        return (bounds.topLeft(), bounds.topRight())
    return None

get_line_color(index=None)

Generate line color for given index

Source code in mlpyqtgraph/axes.py 
78
79
80
def get_line_color(self, index=None):
    """ Generate line color for given index """
    return self.line_colors[index % len(self.line_colors)]

get_ticks(axis)

Obtain the tick values for a given axis

Source code in mlpyqtgraph/axes.py 
270
271
272
273
274
275
276
277
278
279
280
281
def get_ticks(self, axis):
    """ Obtain the tick values for a given axis """
    if axis._tickLevels is not None:
        return axis._tickLevels  # return manually set ticks
    length_px = self.get_axis_size(axis)
    if length_px is None:
        return []
    tick_values = axis.tickValues(axis.range[0], axis.range[1], length_px)
    ticks = list()
    for (_, values) in tick_values:
        ticks.extend(values)
    return sorted(ticks)

set_ticks(axis, major, minor=None) staticmethod

Sets the major and minor ticks on a given axis

Source code in mlpyqtgraph/axes.py 
229
230
231
232
233
234
@staticmethod
def set_ticks(axis, major, minor=None):
    """ Sets the major and minor ticks on a given axis """
    if minor is None:
        minor = ()
    axis.setTicks([major, minor])

set_xticks(major, minor=None)

Sets the major and minor ticks on the x-axis

Source code in mlpyqtgraph/axes.py 
221
222
223
def set_xticks(self, major, minor=None):
    """ Sets the major and minor ticks on the x-axis """
    self.set_ticks(self.x_axis, major, minor)

set_yticks(major, minor=None)

Sets the major and minor ticks on the y-axis

Source code in mlpyqtgraph/axes.py 
225
226
227
def set_yticks(self, major, minor=None):
    """ Sets the major and minor ticks on the y-axis """
    self.set_ticks(self.y_axis, major, minor)

setup(padding=0.01)

Setup axes and grid

Source code in mlpyqtgraph/axes.py 
48
49
50
51
52
53
54
55
56
def setup(self, padding=0.01):
    """ Setup axes and grid """
    self.show_axis_border('right')
    self.show_axis_border('top')
    self.getViewBox().setDefaultPadding(padding=padding)
    self.getViewBox().rbScaleBox.setPen(fn.mkPen(self.scale_box_line_color, width=2))
    self.getViewBox().rbScaleBox.setBrush(fn.mkBrush(*self.scale_box_fill_color))
    for axis_key in self.axes:
        self.getAxis(axis_key).setZValue(-1) # force axis and corresponding ticks to background

show_axis_border(axis)

Enables/shows an axis, wihtout values and ticks

Parameters:

Name Type Description Default
axis

axis string designation, 'left', 'top', 'right' or 'bottom'

 required
Source code in mlpyqtgraph/axes.py 
68
69
70
71
72
73
74
75
76
def show_axis_border(self, axis):
    """ Enables/shows an axis, wihtout values and ticks

    Parameters:
        axis: axis string designation, 'left', 'top', 'right' or 'bottom'
    """
    self.showAxis(axis, show=True)
    self.getAxis(axis).setStyle(showValues=False)
    self.getAxis(axis).setTicks([(),()])

Axis3D

Bases: GLGraphicsItem

3D axis

Source code in mlpyqtgraph/axes.py 
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
class Axis3D(GLGraphicsItem):
    """ 3D axis """

    aspect_ratios = {
        'auto': (1.0, 1.0, 0.8),
        'flat': (1.0, 1.0, 0.6),
        'cube': (1.0, 1.0, 1.0),
    }

    def __init__(self, index, parentItem=None, **kwargs):
        super().__init__(parentItem=parentItem)
        antialiasing = options.get_option('antialiasing')
        self.index = index
        self.grid_axes = GLGridAxisItem(parentItem=self, line_antialias=antialiasing)
        self.default_surface_options = {
            'color': (0, 0, 0, 1),
            'showGrid': True,
            'lineAntialias': antialiasing,
            'colormap': options.get_option('colormap'),
        }
        self.default_line_options = {
            'color': (0, 0, 0, 1),
            'antialias': antialiasing,
            'width': 1,
        }
        self.default_points_options = {
            'color': (0, 0, 0, 1),
            'size': 5.0,
        }
        self._items: List[Axis3DItem] = []
        self._aspect_ratio = 'auto'
        self._projection_method = options.get_option('projection')
        self._label_fmt = '.2g'
        self._lim = { c: [] for c in 'xyz' }
        self._max_no_ticks = { c: 6 for c in 'xyz' }

    def surf(self, *args, **kwargs):
        """ Adds a 3D surface plot item to the view widget  """
        kwargs = dict(self.default_surface_options, **kwargs)
        surface = GLSurfacePlotItem(**kwargs)
        self._add_item(surface, *args, **kwargs)
        self.update()

    def line(self, *args, **kwargs):
        """ Plots a single grid line for given coordinates """
        kwargs = dict(self.default_line_options, **kwargs)
        line = GLLinePlotItem(**kwargs)
        self._add_item(line, *args, **kwargs)
        self.update()

    def points(self, *args, **kwargs):
        """ Plots a set of points for given coordinates """
        kwargs = dict(self.default_points_options, **kwargs)
        points = GLPointsItem(**kwargs)
        self._add_item(points, *args, **kwargs)
        self.update()

    def update(self):
        if not self._items:
            super().update()
            return
        aggregated_limits = self._aggregate_limits()
        shared_limits = self._resolve_limits(aggregated_limits)
        coords = coords_labels = limits = None
        for item in self._items:
            plot_item = item.instance
            coord_kwargs = dict(zip('xyz', item.data))
            coords, coords_labels, limits = self._transform_coordinates(
                coord_kwargs, limits=shared_limits
            )
            if isinstance(plot_item, GLSurfacePlotItem):
                plot_item.setData(**coord_kwargs)
                if colormap := item.options.get('colormap'):
                    self._set_colormap(plot_item, colormap_type=colormap)
            elif isinstance(plot_item, GLLinePlotItem):
                points = np.column_stack(list(coord_kwargs.values()))
                plot_item.setData(pos=points)
            elif isinstance(plot_item, GLPointsItem):
                points = np.column_stack(list(coord_kwargs.values()))
                plot_item.setData(pos=points)
        if coords is not None:
            # Set FOV based on projection method, distance will be set by best_camera()
            field_of_view = 60 if self._projection_method == 'perspective' else 1
            self._get_view().setCameraParams(fov=field_of_view)
            self.grid_axes.setData(coords=coords, coords_labels=coords_labels, limits=limits)
            self._get_view().setCameraPosition(
                **self.grid_axes.best_camera(method=self._projection_method)
            )
        super().update()

    def _aggregate_limits(self) -> dict | None:
        """Aggregate min/max limits for each axis across all items."""
        if not self._items:
            return None
        mins: dict[str, float | None] = {key: None for key in 'xyz'}
        maxs: dict[str, float | None] = {key: None for key in 'xyz'}
        for item in self._items:
            coord_kwargs = dict(zip('xyz', item.data))
            for key, values in coord_kwargs.items():
                values = np.asarray(values)
                if values.size == 0:
                    continue
                min_val = float(values.min())
                max_val = float(values.max())
                mins[key] = min_val if mins[key] is None else min(mins[key], min_val)
                maxs[key] = max_val if maxs[key] is None else max(maxs[key], max_val)
        return {key: [mins[key], maxs[key]] for key in 'xyz'}

    def _resolve_limits(self, aggregated_limits: dict | None) -> dict:
        """Resolve final limits from custom limits and aggregated data bounds."""
        if aggregated_limits is None:
            return self._lim
        resolved = {}
        for key in 'xyz':
            user_limits = self._lim.get(key, [])
            agg_min, agg_max = aggregated_limits[key]
            min_limit = user_limits[0] if len(user_limits) > 0 else None
            max_limit = user_limits[1] if len(user_limits) > 1 else None
            if min_limit is None:
                min_limit = agg_min
            if max_limit is None:
                max_limit = agg_max
            resolved[key] = [min_limit, max_limit]
        return resolved

    def _get_view(self) -> GLViewWidget:
        if view := self.view():
            return view
        raise ViewNotDefinedError('Axis3D doesn\'t have a view!')

    def _add_item(self, item: GLSurfacePlotItem | GLLinePlotItem | GLPointsItem, *data, **options):
        self._items.append(Axis3DItem(item, data, options))
        self._get_view().addItem(item)

    def _aspect_coords(self):
        """ Returns the aspect ratio coordinates """
        if self._aspect_ratio == 'equal':
            return False
        elif isinstance(self._aspect_ratio, str):
            ratios = self.aspect_ratios.get(self._aspect_ratio, (1.0, 1.0, 0.8))
        elif isinstance(self._aspect_ratio, tuple | list):
            ratios = self.aspect_ratio
        else:
            raise ValueError()
        return {label: (0.0, ratio) for label, ratio in zip('xyz', ratios)}

    def _transform_coordinates(self, coord_kwargs, limits=None):
        """ Transforms the given coordinates according to fixed coords """
        coords_labels = dict(coord_generator(
            coord_kwargs,
            max_no_ticks=self._max_no_ticks,
            limits=limits if limits is not None else self._lim
        ))
        if aspect_coords := self._aspect_coords():
            coords = {}
            for key, transformer in coord_transformers(coords_labels, aspect_coords):
                coord_kwargs[key] = transformer(coord_kwargs[key])
                coords[key] = transformer(coords_labels[key])
        else:
            coords = coords_labels
        limits = dict(limit_generator(limit_ratio=0.05, **coords))
        coords_str_labels = dict(self._gen_str_labels(coords_labels))
        return coords, coords_str_labels, limits

    def _gen_str_labels(self, coords):
        for key, value in coords.items():
            yield key, [f'{x:{self._label_fmt}}' for x in value]

    @staticmethod
    def _set_colormap(surface, colormap_type='CET-L10'):
        """ Assign colormap to surface using surface height """
        heights = surface._z
        normalized_heights = (heights - heights.min())/np.ptp(heights)
        if current_colormap := colormap.get(colormap_type):
            colors = current_colormap.map(normalized_heights, mode=ColorMap.FLOAT)
            surface._meshdata.setFaceColors(colors)

    @property
    def azimuth(self):
        """ Azimuth view angle """
        return self._get_view().cameraParams()['azimuth']

    @azimuth.setter
    def azimuth(self, value):
        self._get_view().setCameraParams(azimuth=value)

    @property
    def elevation(self):
        """ Elevation view angle """
        return self._get_view().cameraParams()['elevation']

    @elevation.setter
    def elevation(self, value):
        self._get_view().setCameraParams(elevation=value)

    @property
    def distance(self):
        """ View distance """
        return self._get_view().cameraParams()['distance']

    @distance.setter
    def distance(self, value):
        self._get_view().setCameraParams(distance=value)

    @property
    def aspect_ratio(self):
        """ Axes and data scaling aspect ratio

        Either a string or a tuple/list.

        - `'auto'`: `(1.0, 1.0, 0.8)`
        - `'flat'`: `(1.0, 1.0, 0.6)`
        - `'cube'`: `(1.0, 1.0, 1.0)`
        - `'equal'`: No scaling, respect data aspect ratio
        - `tuple` with three floats
        """
        return self._aspect_ratio

    @aspect_ratio.setter
    def aspect_ratio(self, ratio='auto'):
        """ Set aspect ratio of the 3D axis """
        self._aspect_ratio = ratio
        self.update()

    @property
    def projection(self):
        """ Projection method, can be either 'perspective' or 'orthographic' """
        return self._projection_method

    @projection.setter
    def projection(self, projection_method='perspective'):
        self._projection_method = projection_method
        self.update()

    @property
    def label_fmt(self):
        """ Number format of the labels, default: '.1f' """
        return self._label_fmt

    @label_fmt.setter
    def label_fmt(self, fmt: str):
        self._label_fmt = fmt
        self.update()

    @property
    def xlim(self):
        """Custom x-axis limits"""
        return self._lim['x']

    @xlim.setter
    def xlim(self, xlim: list):
        self._lim['x'] = xlim
        self.update()

    @property
    def ylim(self):
        """Custom y-axis limits"""
        return self._lim['y']

    @ylim.setter
    def ylim(self, ylim: list):
        self._lim['y'] = ylim
        self.update()

    @property
    def zlim(self):
        """Custom z-axis limits"""
        return self._lim['z']

    @zlim.setter
    def zlim(self, zlim: list):
        self._lim['z'] = zlim
        self.update()

    @staticmethod
    def _check_ticks(no_ticks):
        if no_ticks > 1:
            return no_ticks
        raise InvalidTicks(
            f'No. of ticks should be larger than 1, received: {no_ticks}'
        )

    @property
    def xticks(self):
        """ Approximate number of x-axis ticks

        Should be 2 or larger.
        """
        return self._max_no_ticks['x']

    @xticks.setter
    def xticks(self, no_ticks: int):
        self._max_no_ticks['x'] = self._check_ticks(no_ticks)
        self.update()

    @property
    def yticks(self):
        """ Approximate number of y-axis ticks

        Should be 2 or larger.
        """
        return self._max_no_ticks['y']

    @yticks.setter
    def yticks(self, no_ticks: int):
        self._max_no_ticks['y'] = self._check_ticks(no_ticks)
        self.update()

    @property
    def zticks(self):
        """ Approximate number of z-axis ticks

        Should be 2 or larger.
        """
        return self._max_no_ticks['z']

    @zticks.setter
    def zticks(self, no_ticks: int):
        self._max_no_ticks['z'] = self._check_ticks(no_ticks)
        self.update()

    def export(self, filename):
        """ Exports the current view to an image file """
        self._get_view().grabFramebuffer().save(filename)

    def delete(self):
        """ Closes the axis """

aspect_ratio property writable

Axes and data scaling aspect ratio

Either a string or a tuple/list.

  • 'auto': (1.0, 1.0, 0.8)
  • 'flat': (1.0, 1.0, 0.6)
  • 'cube': (1.0, 1.0, 1.0)
  • 'equal': No scaling, respect data aspect ratio
  • tuple with three floats

azimuth property writable

Azimuth view angle

distance property writable

View distance

elevation property writable

Elevation view angle

label_fmt property writable

Number format of the labels, default: '.1f'

projection property writable

Projection method, can be either 'perspective' or 'orthographic'

xlim property writable

Custom x-axis limits

xticks property writable

Approximate number of x-axis ticks

Should be 2 or larger.

ylim property writable

Custom y-axis limits

yticks property writable

Approximate number of y-axis ticks

Should be 2 or larger.

zlim property writable

Custom z-axis limits

zticks property writable

Approximate number of z-axis ticks

Should be 2 or larger.

delete()

Closes the axis

Source code in mlpyqtgraph/axes.py 
626
627
def delete(self):
    """ Closes the axis """

export(filename)

Exports the current view to an image file

Source code in mlpyqtgraph/axes.py 
622
623
624
def export(self, filename):
    """ Exports the current view to an image file """
    self._get_view().grabFramebuffer().save(filename)

line(*args, **kwargs)

Plots a single grid line for given coordinates

Source code in mlpyqtgraph/axes.py 
344
345
346
347
348
349
def line(self, *args, **kwargs):
    """ Plots a single grid line for given coordinates """
    kwargs = dict(self.default_line_options, **kwargs)
    line = GLLinePlotItem(**kwargs)
    self._add_item(line, *args, **kwargs)
    self.update()

points(*args, **kwargs)

Plots a set of points for given coordinates

Source code in mlpyqtgraph/axes.py 
351
352
353
354
355
356
def points(self, *args, **kwargs):
    """ Plots a set of points for given coordinates """
    kwargs = dict(self.default_points_options, **kwargs)
    points = GLPointsItem(**kwargs)
    self._add_item(points, *args, **kwargs)
    self.update()

surf(*args, **kwargs)

Adds a 3D surface plot item to the view widget

Source code in mlpyqtgraph/axes.py 
337
338
339
340
341
342
def surf(self, *args, **kwargs):
    """ Adds a 3D surface plot item to the view widget  """
    kwargs = dict(self.default_surface_options, **kwargs)
    surface = GLSurfacePlotItem(**kwargs)
    self._add_item(surface, *args, **kwargs)
    self.update()

InvalidAxis

Bases: RootException

Exception raised for invalid axes

Source code in mlpyqtgraph/axes.py 
25
26
class InvalidAxis(RootException):
    """ Exception raised for invalid axes """

InvalidTicks

Bases: Exception

Raised for invalid no. of ticks entries

Source code in mlpyqtgraph/axes.py 
297
298
class InvalidTicks(Exception):
    """ Raised for invalid no. of ticks entries """

RootException

Bases: Exception

Root Exception of the windows module

Source code in mlpyqtgraph/axes.py 
21
22
class RootException(Exception):
    """ Root Exception of the windows module """

ViewNotDefinedError

Bases: Exception

Raised if view is not defined yet

Source code in mlpyqtgraph/axes.py 
293
294
class ViewNotDefinedError(Exception):
    """ Raised if view is not defined yet """