Skip to content

image_slider

a tkinter frame with an image with slider

ImageViewer

HDF Image Viewer - display a 3+D dataset as a series of images Usage: HDFViewer("hdf_file.hdf") Select a dataset address (one will be choosen by default) Use the displayed slider and options to view the data

Parameters:

Name Type Description Default
hdf_filename

str filename of HDF file

''
parent

tk root or None

None
Source code in mmg_toolbox/tkguis/widgets/image_slider.py
class ImageViewer:
    """
    HDF Image Viewer - display a 3+D dataset as a series of images
    Usage:
        HDFViewer("hdf_file.hdf")
    Select a dataset address (one will be choosen by default)
    Use the displayed slider and options to view the data

    :param hdf_filename: str filename of HDF file
    :param parent: tk root or None
    """

    def __init__(self, hdf_filename="", parent=None):

        self.root = create_root('HDF Image Viewer', parent=parent)

        # Variables
        self._ax = 0
        self._x_axis = 1
        self._y_axis = 2
        self.view_axis = tk.StringVar(self.root, AXES[self._ax])
        self.view_index = tk.IntVar(self.root, 0)
        self.axis_name = tk.StringVar(self.root, 'axis = ')
        self.axis_value = tk.DoubleVar(self.root, 0)
        self.add_phase = tk.DoubleVar(self.root, 0)
        self.logplot = tk.BooleanVar(self.root, False)
        self.difplot = tk.BooleanVar(self.root, False)
        self.mask = tk.DoubleVar(self.root, 0)
        self.cmin = tk.DoubleVar(self.root, 0)
        self.cmax = tk.DoubleVar(self.root, 1)
        self.fixclim = tk.BooleanVar(self.root, False)
        self.colormap = tk.StringVar(self.root, DEFAULT_COLORMAP)

        "----------- Options -----------"
        self.ini_options()

        "----------- Slider -----------"
        self.tkscale = self.ini_slider()

        "----------- Image -----------"
        self.fig, self.ax1, self.plot_list, self.ax1_image, self.cb1, self.toolbar = ini_image(self.root)

        "-------- Start Mainloop ------"
        if parent is None:
            self.root.mainloop()

    "======================================================"
    "================= init functions ====================="
    "======================================================"

    def ini_options(self):
        frm = ttk.LabelFrame(self.root, text='Options', relief=tk.RIDGE)
        frm.pack(expand=tk.NO, pady=2, padx=5)

        var = ttk.Checkbutton(frm, text='Log', variable=self.logplot, command=self.update_image)
        var.pack(side=tk.LEFT, padx=6)
        var = ttk.Checkbutton(frm, text='Diff', variable=self.difplot, command=self.update_image)
        var.pack(side=tk.LEFT, padx=6)

        var = ttk.Label(frm, text='Mask <')
        var.pack(side=tk.LEFT, expand=tk.NO, padx=6)
        var = ttk.Entry(frm, textvariable=self.mask, width=6)
        var.pack(side=tk.LEFT, padx=6)
        var.bind('<Return>', self.update_image)
        var.bind('<KP_Enter>', self.update_image)

        var = ttk.OptionMenu(frm, self.colormap, *COLORMAPS, command=self.update_image)
        var.pack(side=tk.LEFT)

        var = ttk.Label(frm, text='clim:')
        var.pack(side=tk.LEFT, expand=tk.NO)
        var = ttk.Entry(frm, textvariable=self.cmin, width=6)
        var.pack(side=tk.LEFT)
        var.bind('<Return>', self.update_image)
        var.bind('<KP_Enter>', self.update_image)
        var = ttk.Entry(frm, textvariable=self.cmax, width=6)
        var.pack(side=tk.LEFT)
        var.bind('<Return>', self.update_image)
        var.bind('<KP_Enter>', self.update_image)
        var = ttk.Checkbutton(frm, text='Fix', variable=self.fixclim)
        var.pack(side=tk.LEFT)

    def ini_slider(self):
        frm = ttk.Frame(self.root)
        frm.pack(expand=tk.NO, pady=2, padx=5)

        var = ttk.OptionMenu(frm, self.view_axis, None, *AXES, command=self.update_axis)
        var.pack(side=tk.LEFT)

        def inc():
            self.view_index.set(self.view_index.get() + 1)
            self.update_image()

        def dec():
            self.view_index.set(self.view_index.get() - 1)
            self.update_image()

        var = ttk.Label(frm, text='Index:', width=8)
        var.pack(side=tk.LEFT)
        var = ttk.Button(frm, text='-', command=dec)
        var.pack(side=tk.LEFT)
        tkscale = ttk.Scale(frm, from_=0, to=100, variable=self.view_index, orient=tk.HORIZONTAL,
                            command=self.update_image, length=300)
        # var.bind("<ButtonRelease-1>", callback)
        tkscale.pack(side=tk.LEFT, expand=tk.YES)
        var = ttk.Button(frm, text='+', command=inc)
        var.pack(side=tk.LEFT)
        var = ttk.Entry(frm, textvariable=self.view_index, width=6)
        var.pack(side=tk.LEFT)
        var.bind('<Return>', self.update_image)
        var.bind('<KP_Enter>', self.update_image)

        # axis mode
        var = ttk.Label(frm, textvariable=self.axis_name)
        var.pack(side=tk.LEFT)
        var = ttk.Label(frm, textvariable=self.axis_value)
        var.pack(side=tk.LEFT)
        return tkscale

    "======================================================"
    "================ general functions ==================="
    "======================================================"

    def _update_axis(self):
        """Get data size etc"""
        self._ax = int(self.view_axis.get()[-1]) - 1  # e.g. 'axis 1'

        hdf_filename = self.filepath.get()
        address = self.address.get()
        axis_address = self.axis_address.get()
        # Check dataset
        self.error_message = check_image_dataset(hdf_filename, address)
        if self.error_message:
            show_error(self.error_message, self.root)
        # Load image to get size and shape
        with load_hdf(hdf_filename) as hdf:
            dataset = hdf.get(address)

            shape = dataset_shape(dataset)
            if not self.fixclim.get():
                image = get_image(
                    dataset=dataset,
                    image_number=shape[self._ax]//2,
                    axis=self._ax
                )
                image_mean = np.mean(image[image > 0])
                image_max = np.max(image)
                cmax = image_mean + (image_max - image_mean) ** 0.7
                cmax = float(f"{cmax: .2g}")
                self.cmin.set(0)
                self.cmax.set(cmax)

            # axis values
            if axis_address:
                axis_dataset = hdf.get(axis_address)
                if axis_dataset and len(axis_dataset) == shape[self._ax]:
                    self.axis_name.set(f"{address_name(axis_address)} = ")
                    self.axis_value.set(axis_dataset[shape[self._ax]//2])

        # udpate scale and axes
        self.tkscale.config(to=shape[self._ax] - 1)  # set slider max
        if self._ax == 0:
            self.ax1.set_xlabel(u'Axis 3')
            self.ax1.set_ylabel(u'Axis 2')
            self.ax1.set_xlim([0, shape[2]])
            self.ax1.set_ylim([0, shape[1]])
        elif self._ax == 1:
            self.ax1.set_xlabel(u'Axis 3')
            self.ax1.set_ylabel(u'Axis 1')
            self.ax1.set_xlim([0, shape[2]])
            self.ax1.set_ylim([0, shape[0]])
        else:
            self.ax1.set_xlabel(u'Axis 2')
            self.ax1.set_ylabel(u'Axis 1')
            self.ax1.set_xlim([0, shape[1]])
            self.ax1.set_ylim([0, shape[0]])
        self.view_index.set(shape[self._ax]//2)

    def update_image(self, event=None):
        """Plot image data"""
        if self.error_message:
            show_error(self.error_message, self.root)
        # Load image
        image = get_hdf_image(
            hdf_filename=self.filepath.get(),
            address=self.address.get(),
            image_number=int(self.view_index.get()),
            axis=self._ax
        )
        # Options
        cmin, cmax = self.cmin.get(), self.cmax.get()
        if self.logplot.get():
            image = np.log10(image)
            cmax = np.log10(cmax)
        if self.difplot.get():
            raise Warning('Not implemented yet')
        if self.mask.get():
            raise Warning('Not implemented yet')
        # Add plot
        self.ax1_image.remove()
        colormap = self.colormap.get()
        clim = [cmin, cmax]
        self.ax1_image = self.ax1.pcolormesh(image, shading='auto', clim=clim, cmap=colormap)
        self.ax1_image.set_clim(clim)
        self.cb1.update_normal(self.ax1_image)
        self.toolbar.update()
        self.fig.canvas.draw()
        # Load axis mode
        value = get_hdf_array_value(
            hdf_filename=self.filepath.get(),
            address=self.axis_address.get(),
            image_number=int(self.view_index.get())
        )
        self.axis_value.set(value)

    "======================================================"
    "================= event functions ===================="
    "======================================================"

    def loadfile(self, event=None):
        self._loadfile(self.filepath.get())

    def update_axis(self, event=None):
        """Get data size etc"""
        self._update_axis()
        self.update_image()

colormap = tk.StringVar(self.root, DEFAULT_COLORMAP) instance-attribute

----------- Options -----------

tkscale = self.ini_slider() instance-attribute

----------- Image -----------

update_axis(event=None)

Get data size etc

Source code in mmg_toolbox/tkguis/widgets/image_slider.py
def update_axis(self, event=None):
    """Get data size etc"""
    self._update_axis()
    self.update_image()

update_image(event=None)

Plot image data

Source code in mmg_toolbox/tkguis/widgets/image_slider.py
def update_image(self, event=None):
    """Plot image data"""
    if self.error_message:
        show_error(self.error_message, self.root)
    # Load image
    image = get_hdf_image(
        hdf_filename=self.filepath.get(),
        address=self.address.get(),
        image_number=int(self.view_index.get()),
        axis=self._ax
    )
    # Options
    cmin, cmax = self.cmin.get(), self.cmax.get()
    if self.logplot.get():
        image = np.log10(image)
        cmax = np.log10(cmax)
    if self.difplot.get():
        raise Warning('Not implemented yet')
    if self.mask.get():
        raise Warning('Not implemented yet')
    # Add plot
    self.ax1_image.remove()
    colormap = self.colormap.get()
    clim = [cmin, cmax]
    self.ax1_image = self.ax1.pcolormesh(image, shading='auto', clim=clim, cmap=colormap)
    self.ax1_image.set_clim(clim)
    self.cb1.update_normal(self.ax1_image)
    self.toolbar.update()
    self.fig.canvas.draw()
    # Load axis mode
    value = get_hdf_array_value(
        hdf_filename=self.filepath.get(),
        address=self.axis_address.get(),
        image_number=int(self.view_index.get())
    )
    self.axis_value.set(value)

SimpleImage

Simple Image plot

Source code in mmg_toolbox/tkguis/widgets/image_slider.py
class SimpleImage:
    """
    Simple Image plot
    """

    def __init__(self, root: tk.Misc, xdata, ydata, xlabel='', ylabel='', title=''):
        self.root = root
        self.fig, self.ax1, self.plot_list, self.ax1_image, self.cb1, self.toolbar = ini_image(self.root)
        self.ax1.set_xlabel(xlabel)
        self.ax1.set_ylabel(ylabel)
        self.ax1.set_title(title)
        self.plot(xdata, ydata)

    def plot(self, *args, **kwargs):
        lines = self.ax1.imshow(*args, **kwargs)
        self.plot_list.extend(lines)
        self.update_plot()

    def remove_lines(self):
        for obj in self.plot_list:
            obj.remove()
        self.plot_list.clear()

    def reset_plot(self):
        # self.ax1.set_xlabel(self.xaxis.get())
        # self.ax1.set_ylabel(self.yaxis.get())
        self.ax1.set_title('')
        self.ax1.set_prop_cycle(None)  # reset colours
        self.ax1.legend([]).set_visible(False)
        for obj in self.ax1.lines:
            obj.remove()

    def update_plot(self):
        self.ax1.relim()
        self.ax1.autoscale(True)
        self.ax1.autoscale_view()
        self.fig.canvas.draw()
        self.toolbar.update()