og package

Submodules

og.app module

class og.app.HistoryApp(file)

Bases: object

Applications with history stored in JSON format in isimple/.history

reset_history()

load_history()

save_history()

get_own_history()

unpack_history()

pack_history()

og.gui module

class og.gui.OG_ScriptWindow

Bases: tkinter.Tk

focus()

Direct input focus to this widget.

If the application currently does not have the focus this widget will get the focus if the application gets the focus through the window manager.

close(do_exit=True)

Called when user tries to close the window.

class og.gui.OG_FileSelectWindow(WRAPPER, file='/home/docs/checkouts/readthedocs.org/user_builds/isimple/checkouts/master/og/gui.py')

Bases: og.app.HistoryApp

• Select video & overlay files
• Edit script parameters (dt, …)

config = {}

reset_history()

unpack_history()

browse_video()

browse_design()

commit(_=None)

class og.gui.OG_ReshapeSelection(window, transform, initial_coordinates=None)

Bases: object

Reshape-able rectangle ROI selection for tkinter canvases

initialize()

undo(_)

Callback to clear selection rectangle

press(event)

Mouse press callback. Initializes rectangle dragging.

release(event)

Mouse release callback. Commits rectangle dragging result.

get_corners()

update()

Update selection rectangle and transform matrix.

redraw()

Redraw selection rectangle on the canvas.

quit(_)

Close the window.

class og.gui.OG_Corner(selection, co, name='')

Bases: object

Draggable corner for ROI selection rectangle

alpha = 0.05

handle = None

press(event)

Callback for mouse click

drag(event)

Callback for mouse movement after click

release(event)

Callback for mouse release

delete()

class og.gui.OG_ImageDisplay(window: og.gui.OG_ScriptWindow, order=(0, 1, 2, 3), initial_coordinates=None)

Bases: object

OpenCV image display in tkinter canvas with link to ROI selection and coordinate transform.

permute(permutation_id)

class og.gui.OG_TransformImage(canvas, image, overlay_img, co, callback, ratio, initial_order=(0, 1, 2, 3), frame_number=0)

Bases: object

OpenCV perspective transform overlay alpha blending and display with tkinter

alpha = 0.1

get_new_transform(from_coordinates)

Recalculate transform and show overlay.

update()

Update image based

show_overlay()

Show overlay; i.e. without the acual video frame

og.gui.hsvimg2tk(image, ratio=1.0)

Convert OpenCV HSV image to PhotoImage object

og.gui.bgrimg2tk(image, ratio=1.0)

Convert OpenCV HSV image to PhotoImage object

og.gui.binimg2tk(image, ratio=1.0)

Convert OpenCV binary image to PhotoImage object

class og.gui.OG_ColorPicker(window, WRAPPER)

Bases: object

Select colours by clicking image pixels.

update()

Update UI

pick(event)

Pick a colour

track(value)

Scrollbar callback - track through the video.

quit(_)

Close the window.

class og.gui.OG_OverlayAlignWindow(WRAPPER)

Bases: og.gui.OG_ScriptWindow

class og.gui.OG_MaskFilterWindow(WRAPPER)

Bases: og.gui.OG_ScriptWindow

selection_callback()

class og.gui.OG_ProgressWindow(WRAPPER)

Bases: og.gui.OG_ScriptWindow

update_image(state, frame)

Show the current video frame in the UI

update_window(time, values, state, frame)

plot(t, areas)

Update the plot.

keepopen()

Called to keep the window open after the script has run.

og.gui.has_zenity()

og.gui.load_file_dialog(title: str = None, patterns: List[str] = None, patterns_str: str = None)

og.gui.save_file_dialog(title: str = None, patterns: List[str] = None, patterns_str: str = None)

class og.gui.EntryPopup(parent, iid, index, item, callback, **kw)

Bases: tkinter.ttk.Entry

Pop-up widget to allow value editing in TreeDict

on_return(event)

select_all(*ignore)

Set selection on the whole text

class og.gui.TreeDict(tk: Union[tkinter.Tk, tkinter.Misc], data: dict, callback: Callable[[dict], dict])

Bases: object

An editable representation of a dictionary in a ttk.Treeview

set(data: dict)

set_value(iid, value)

callback()

build()

edit(event)

Executed, when a row is double-clicked. Opens read-only EntryPopup above the item’s column, so it is possible to select text

update(data: dict)

class og.gui.guiElement

Bases: abc.ABC

Abstract class for GUI elements

build()

class og.gui.guiPane

Bases: og.gui.guiElement

Abstract class for a GUI pane

build()

class og.gui.guiWindow

Bases: og.gui.guiElement

Abstract class for a GUI window

open()

close()

class og.gui.SetupWindow

Bases: og.gui.guiWindow

open()

class og.gui.TransformWindow

Bases: og.gui.guiWindow

Allows the user to set up a transform interactively * Callbacks:

• Get the raw and transformed frame at a certain frame number (scrollable)
• Estimate the transform for a set of coordinates

open()

class og.gui.FilterWindow

Bases: og.gui.guiWindow

Allows the user to set up a filter interactively * Interaction:

• Scroll through the video to find the liquid of interest, click on it and set the filter according to the selected pixel
• todo: extra GUI elements for more control over filter parameters

• todo: would be great to change the filter type dynamically; in that

  case the gui Manager would have to be involved in order to update the FilterWindow’s callbacks… Otherwise: filter implementations wrapped by Filter, not inheriting from Filter

• Callbacks:

  • Get the masked / masked & filtered frame at a certain frame number (scrollable)
  • Set the filter

open()

class og.gui.ProgressWindow

Bases: og.gui.guiWindow

Shows the progress of an analysis. * No callbacks; not interactive, so the backend pushes to the GUI instead

open()

update(time: float, values: list, state: numpy.ndarray, frame: numpy.ndarray) → None

class og.gui.VideoAnalyzerGui(backend: isimple.core.common.Manager)

Bases: isimple.core.common.Manager, og.gui.guiElement

open_setupwindow() → None

open_transformwindow() → None

open_filterwindow(index: int) → None

open_progresswindow() → None

add_window(window_type: Type[og.gui.guiWindow])

open_window(window_type: Type[og.gui.guiWindow], index: int = None)

close_window(index: int)

wait_on_close(window)

close_all_windows()

Module contents