Skip to content

matplotlib

Useful tkinter functions that use matplotlib

CustomToolbar

Bases: NavigationToolbar2Tk

Customised version of matplotlib toolbar with added popout and copy functions

Source code in mmg_toolbox/tkguis/misc/matplotlib.py 
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
class CustomToolbar(NavigationToolbar2Tk):
    """Customised version of matplotlib toolbar with added popout and copy functions"""

    def copy_button(self):
        """Copy figure to clipboard - doesn't currently work"""
        import io
        from PIL import Image
        # print(self.canvas.figure.canvas.tostring_rgb())
        image_buffer, (width, height) = self.canvas.figure.canvas.print_to_buffer()
        img = Image.frombytes("RGBA", (width, height), image_buffer)
        io_buffer = io.BytesIO()
        img.save(io_buffer, format='PNG')
        io_buffer.seek(0)
        self.master.clipboard_clear()
        self.master.clipboard_append(io_buffer.getvalue(), format="image/png")  # adds byte array to buffer but isn't interpreted

    def popout_figure(self):
        """Create a new tk window and display figure"""
        root = create_root('Figure', parent=self.master)
        fig, ax1, plot_list, toolbar = ini_plot(root, FIGURE_SIZE, FIGURE_DPI)

        for old_ax in self.canvas.figure.get_axes():
            ax1.set_title(old_ax.title.get_text())
            ax1.set_xlabel(old_ax.get_xlabel())
            ax1.set_ylabel(old_ax.get_ylabel())
            for line in old_ax.lines:
                ax1.plot(line.get_xdata(), line.get_ydata())

    def __init__(self, canvas_, parent_):
        # Add additional functions
        self.toolitems += (
            # (name, description, image, function)
            (None, None, None, None),  # seperator
            # ('copy', 'Copy Figure', 'filesave', 'copy_button'),
            ('popout', 'Popout Figure', 'qt4_editor_options', 'popout_figure'),
        )

        NavigationToolbar2Tk.__init__(self, canvas_, parent_)
        bg = get_style_background(parent_)
        self.config(background=bg)

copy_button()

Copy figure to clipboard - doesn't currently work

Source code in mmg_toolbox/tkguis/misc/matplotlib.py 
33
34
35
36
37
38
39
40
41
42
43
44
def copy_button(self):
    """Copy figure to clipboard - doesn't currently work"""
    import io
    from PIL import Image
    # print(self.canvas.figure.canvas.tostring_rgb())
    image_buffer, (width, height) = self.canvas.figure.canvas.print_to_buffer()
    img = Image.frombytes("RGBA", (width, height), image_buffer)
    io_buffer = io.BytesIO()
    img.save(io_buffer, format='PNG')
    io_buffer.seek(0)
    self.master.clipboard_clear()
    self.master.clipboard_append(io_buffer.getvalue(), format="image/png")  # adds byte array to buffer but isn't interpreted

popout_figure()

Create a new tk window and display figure

Source code in mmg_toolbox/tkguis/misc/matplotlib.py 
46
47
48
49
50
51
52
53
54
55
56
def popout_figure(self):
    """Create a new tk window and display figure"""
    root = create_root('Figure', parent=self.master)
    fig, ax1, plot_list, toolbar = ini_plot(root, FIGURE_SIZE, FIGURE_DPI)

    for old_ax in self.canvas.figure.get_axes():
        ax1.set_title(old_ax.title.get_text())
        ax1.set_xlabel(old_ax.get_xlabel())
        ax1.set_ylabel(old_ax.get_ylabel())
        for line in old_ax.lines:
            ax1.plot(line.get_xdata(), line.get_ydata())

add_colorbar_clim(canvas, fig, im, cbar, root, entry_height=25, pad=5)

Attach Tkinter Entry boxes for vmin/vmax above and below a Matplotlib colorbar.

Parameters

canvas : FigureCanvasTkAgg fig : matplotlib.figure.Figure im : AxesImage (from imshow) cbar : matplotlib.colorbar.Colorbar root : tk.Tk or tk.Frame (parent widget) entry_height : int (pixel height of entry boxes) pad : int (padding in pixels)

Source code in mmg_toolbox/tkguis/misc/matplotlib.py 
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
def add_colorbar_clim(canvas, fig, im, cbar, root, entry_height=25, pad=5):
    """
    Attach Tkinter Entry boxes for vmin/vmax above and below a Matplotlib colorbar.

    Parameters
    ----------
    canvas : FigureCanvasTkAgg
    fig : matplotlib.figure.Figure
    im : AxesImage (from imshow)
    cbar : matplotlib.colorbar.Colorbar
    root : tk.Tk or tk.Frame (parent widget)
    entry_height : int (pixel height of entry boxes)
    pad : int (padding in pixels)
    """

    canvas_widget = canvas.get_tk_widget()

    # Create Entry widgets
    entry_vmin = tk.Entry(root, width=20, justify="center")
    entry_vmax = tk.Entry(root, width=20, justify="center")

    # Initialize values
    vmin, vmax = im.get_clim()
    entry_vmin.insert(0, f"{vmin:.3g}")
    entry_vmax.insert(0, f"{vmax:.3g}")

    def update_clim(event=None):
        try:
            vmin = float(entry_vmin.get())
            vmax = float(entry_vmax.get())
            if vmin < vmax:
                im.set_clim(vmin, vmax)
                canvas.draw_idle()
        except ValueError:
            pass

    entry_vmin.bind("<Return>", update_clim)
    entry_vmax.bind("<Return>", update_clim)

    def reposition(event=None):
        fig.canvas.draw()
        renderer = fig.canvas.get_renderer()

        bbox = cbar.ax.get_window_extent(renderer=renderer)

        x0, y0 = bbox.x0, bbox.y0
        x1, y1 = bbox.x1, bbox.y1

        width = x1 - x0
        height = y1 - y0

        # --- Expand width slightly (colorbar axes are often too tight)
        width *= 10
        x0 -= (width - (x1 - x0)) / 2

        entry_vmax.place(x=x0, y=y0 - entry_height - pad,
                         width=width, height=entry_height)

        entry_vmin.place(x=x0, y=y1 + pad,
                         width=width, height=entry_height)

    # Initial placement
    root.update()
    reposition()

    # Reposition on resize
    canvas_widget.bind("<Configure>", reposition)

    return entry_vmin, entry_vmax

add_rectangle(ax, left, bottom, width, height)

Add rectangle to axes

Source code in mmg_toolbox/tkguis/misc/matplotlib.py 
197
198
199
200
201
def add_rectangle(ax: Axes, left: float, bottom: float, width: float, height: float) -> Rectangle:
    """Add rectangle to axes"""
    rect = Rectangle((left, bottom), width, height, fill=False, edgecolor='black', facecolor='white', zorder=2)
    ax.add_patch(rect)
    return rect

ini_image(frame, figure_size=None, figure_dpi=None)

Create an empty image plot on a tk canvas with toolbar

fig, ax, plot_list, image, cbar, toolbar = ini_image(frame, figure_size, figure_dpi)
image.remove()
image = ax.pcolormesh(image_array, shading='auto')
colorbar.update_normal(image)
toolbar.update()
fig.canvas.draw()

Parameters:

Name Type Description Default
frame Misc

parent frame within which the figure will be placed.

 required
figure_size tuple[int, int] | None

size of the figure in inches [horiz, vert], passed to matplotlib.Figure()

 None
figure_dpi int | None

figure DPI, passed to matplotlib.Figure()

 None

Returns:

Type Description
tuple[Figure, Axes, list[Line2D], QuadMesh, Colorbar, CustomToolbar]

tuple[Figure, Axes, list[Line2D], Toolbar]
Source code in mmg_toolbox/tkguis/misc/matplotlib.py 
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
def ini_image(frame: tk.Misc, figure_size: tuple[int, int] | None = None,
              figure_dpi: int | None = None) -> tuple[Figure, Axes, list[Line2D], QuadMesh, Colorbar, CustomToolbar]:
    """
    Create an empty image plot on a tk canvas with toolbar

        fig, ax, plot_list, image, cbar, toolbar = ini_image(frame, figure_size, figure_dpi)
        image.remove()
        image = ax.pcolormesh(image_array, shading='auto')
        colorbar.update_normal(image)
        toolbar.update()
        fig.canvas.draw()

    :param frame: parent frame within which the figure will be placed.
    :param figure_size: size of the figure in inches [horiz, vert], passed to matplotlib.Figure()
    :param figure_dpi: figure DPI, passed to matplotlib.Figure()
    :returns: tuple[Figure, Axes, list[Line2D], Toolbar]
    """
    if figure_size is None:
        figure_size = IMAGE_SIZE
    if figure_dpi is None:
        figure_dpi = FIGURE_DPI

    # get the current background
    bg = get_style_background(frame)

    fig = Figure(figsize=figure_size, dpi=figure_dpi)
    try:
        fig.patch.set_facecolor(bg)
    except ValueError:
        print(f"Cannot set background color of {bg}")
        bg = '#dcdad5'

    ax1 = fig.add_subplot(111)
    # zeros = np.array([[0 for n in range(10)] for m in range(10)])
    xvals = np.arange(100)
    yvals = np.arange(100)
    default = np.random.rand(100, 100)
    ax1_image = ax1.pcolormesh(xvals, yvals, default, shading='auto', cmap=DEFAULT_COLORMAP)
    ax1.set_xlabel(u'Axis 0')
    ax1.set_ylabel(u'Axis 1')
    ax1.set_xlim([0, 100])
    ax1.set_ylim([0, 100])
    cb1 = fig.colorbar(ax1_image, ax=ax1)
    ax1.axis('image')
    plot_list: list[plt.Line2D] = []

    frm = ttk.Frame(frame)
    frm.pack(expand=tk.YES, fill=tk.BOTH, pady=2, padx=5)
    # frm.configure(bg=bg)
    canvas = FigureCanvasTkAgg(fig, frm)
    # canvas.get_tk_widget().configure(bg=bg)
    canvas.draw()
    canvas.get_tk_widget().pack(side=tk.TOP, fill=tk.BOTH, expand=tk.YES, padx=5, pady=2)

    # Colorbar
    # add_colorbar_clim(canvas, fig, ax1_image, cb1, frame)

    # Toolbar
    frm2 = ttk.Frame(frm)
    frm2.pack(side=tk.TOP, expand=tk.NO, fill=tk.X, padx=5, pady=2)
    # toolbar = NavigationToolbar2Tk(canvas, frm)
    toolbar = CustomToolbar(canvas, frm2)
    toolbar.config(background=bg)
    toolbar.update()
    toolbar.pack(fill=tk.X, expand=tk.YES)
    return fig, ax1, plot_list, ax1_image, cb1, toolbar

ini_plot(frame, figure_size=None, figure_dpi=None)

Create a lineplot on a tk canvas with toolbar

fig, ax, line_list, toolbar = ini_plot(frame, figure_size, figure_dpi)
line_list.extend(ax.plot(x, y))
fig.canvas.draw()
toolbar.update()

Parameters:

Name Type Description Default
frame Misc

parent frame within which the figure will be placed.

 required
figure_size tuple[int, int] | None

size of the figure in inches [horiz, vert], passed to matplotlib.Figure()

 None
figure_dpi int | None

figure DPI, passed to matplotlib.Figure()

 None

Returns:

Type Description
tuple[Figure, Axes, list[Line2D], NavigationToolbar2Tk]

tuple[Figure, Axes, list[Line2D], Toolbar]
Source code in mmg_toolbox/tkguis/misc/matplotlib.py 
 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
def ini_plot(frame: tk.Misc, figure_size: tuple[int, int] | None = None,
             figure_dpi: int | None = None) -> tuple[Figure, Axes, list[Line2D], NavigationToolbar2Tk]:
    """
    Create a lineplot on a tk canvas with toolbar

        fig, ax, line_list, toolbar = ini_plot(frame, figure_size, figure_dpi)
        line_list.extend(ax.plot(x, y))
        fig.canvas.draw()
        toolbar.update()

    :param frame: parent frame within which the figure will be placed.
    :param figure_size: size of the figure in inches [horiz, vert], passed to matplotlib.Figure()
    :param figure_dpi: figure DPI, passed to matplotlib.Figure()
    :returns: tuple[Figure, Axes, list[Line2D], Toolbar]
    """
    if figure_size is None:
        figure_size = FIGURE_SIZE
    if figure_dpi is None:
        figure_dpi = FIGURE_DPI

    # get the current background
    bg = get_style_background(frame)

    fig = Figure(figsize=figure_size, dpi=figure_dpi)
    try:
        fig.patch.set_facecolor(bg)
    except ValueError:
        print(f"Cannot set background color of {bg}")
        bg = '#dcdad5'
    # fig.subplots_adjust(left=0.2, bottom=0.2)
    # Amplitude
    ax1 = fig.add_subplot(111)
    ax1.set_autoscaley_on(True)
    ax1.set_autoscalex_on(True)
    ax1.set_xlabel(u'Axis 0')
    ax1.set_ylabel(u'Axis 1')
    ax1.set_title('filename')
    plot_list: list[plt.Line2D] = []

    frm = ttk.Frame(frame)
    frm.pack(side=tk.LEFT, expand=tk.YES, fill=tk.BOTH, pady=2, padx=5)
    canvas = FigureCanvasTkAgg(fig, frm)
    canvas.get_tk_widget().configure(bg='black')
    canvas.draw()
    canvas.get_tk_widget().pack(side=tk.TOP, fill=tk.BOTH, expand=tk.YES, padx=5, pady=2)

    # Toolbar
    frm2 = ttk.Frame(frm)
    frm2.pack(side=tk.TOP, expand=tk.YES, fill=tk.BOTH, padx=5, pady=2)
    # toolbar = NavigationToolbar2Tk(canvas, frm)
    toolbar = CustomToolbar(canvas, frm2)
    toolbar.config(background=bg)
    toolbar.update()
    toolbar.pack(fill=tk.X)#, expand=tk.YES)
    return fig, ax1, plot_list, toolbar