mkpy.mkh5viewer module

class mkpy.mkh5viewer.Application(parent=None, mkh5_f=None, tmp_yarf_f=None)

Bases: Frame

top level viewer frame

class mkpy.mkh5viewer.DBlockView(parent, model, *args, **kwargs)

Bases: Treeview

set_vp_cursor(e)

vp cursor tracks dblock focus item, i.e., dblock row

Responds to DblockView cursor selection virtual events, also called by TraceView cursor mouse dragging

class mkpy.mkh5viewer.Dashboard(parent, *args, **kwargs)

Bases: PanedWindow

wrapper around HeaderView, H5Nav

layout_dashboard_widgets()

note: dims controlled in appearance spec globals

class mkpy.mkh5viewer.DataView(parent, *args, **kwargs)

Bases: PanedWindow

wrapper around pygarv editor, traces and dblock datatable

layout_DV_widgets()

note: dims controlled in appearance spec globals

class mkpy.mkh5viewer.EventView(model, *args, **kwargs)

Bases: Frame

lightweight wrapper for regular expression event finding, same search mechanism as mkh5.event_table()

class mkpy.mkh5viewer.H5Nav(parent, *args, **kwargs)

Bases: Notebook

Tab 1 (default) is dblocks, other tabs are epochs

update_model_dblock_paths(e)

class mkpy.mkh5viewer.H5View(parent, model, layer=None, *args, **kwargs)

Bases: Treeview

unified tabular viewer for data block (= a long epoch), events (a single sample epoch) and epoch tables

update_model_view(e)

handles clicks on H5view row.

Each row of self.h5view_df has a dblock_path and match_ticks column.

Selecting by mouse click or arrowing

• update the main model to use the dblock at dblock_path

• move the viewport to the relevant tick

• switch the dashboard into event scroll mode and notify of the new event data

class mkpy.mkh5viewer.HeaderView(parent, model, *args, **kwargs)

Bases: Labelframe

dict_to_tree(d, tree_item)

class mkpy.mkh5viewer.Model(mkh5_f=None, tmp_yarf_f=None)

Bases: object

data model for the views

This is the Model in the mkh5viewer Model-View architecture

dblock_paths and epoch_tables are set once upon init when the mkh5 file is read.

The rest track datablock and index pointers, updated in response to UI events.

Parameters

mkh5_f (string) – file path to current mkpy.mkh5 hdf5 format data file

Variables

• ~mkh5.mkh5.mkh5 (object) – mkh5 instance that exposes the hdf5 data and methods

• dblock_paths (list of str) – catalogue of all hdf5 slashpaths to mkh5 dblocks

• epoch_tables (list of str) – each string is a slash path ‘_epoch_tables/*’ to an mkh5 epoch table dataset

• dbp_idx (uint) – index of model’s current dblock_path

• dblock_path (string) – slash path to the active mkpy.mkh5 data set, e.g., sub01/dblock_0 or exp1/S07/dblock_7.

• dblock (np.ndarray) – current dblock data streams

• header (dict) – current dblock header

• pg (PyGarv()) –

• pg.yarf_docs (list) – item at pg.yarf_docs[idx] is a list of tests to run on dblock at dblock_paths[idx]

export_yarf_docs(filename)

scrape yarf doc test info from tr_docs and dump to YAML .yarf file

get_pg_test_list()

return this dblock’s tr_doc test list, e.g., for populating a UI test tree

next_event(from_idx, direction, pygarv_type=None, event_col='log_evcodes')

return index of next or previous event in current

dblock model w/ pygarv type

Parameters

• from_idx (unint) – index in current data block to start from

• direction (int) – 1 looks right, -1 looks left

• pygarv_type (str (None, ‘good’ ‘bad’)) – None (default) ignores pygarv column, ‘good’ searches for pygarv == 0, bad searches pygarv > 0

• event_col (str (‘log_evcodes’)) – name dblock column to search for events. usually default, perhaps ‘crw_evcodes’

Return type

index of next event satisfying the criteria or from_idx if None are found

update_model(dblock_path)

refresh index, path, and header, dblock data, and pygarv results

Parameters

dbp (str) – slashpath to dblock dataset

class mkpy.mkh5viewer.PyGarvCatalogView(parent, *args, **kwargs)

Bases: Labelframe

viewer/chooser for available PyGarvTest tests

class mkpy.mkh5viewer.PyGarvEditorDashboard(parent)

Bases: Frame

wrapper for Editor UI controls

class mkpy.mkh5viewer.PyGarvEditorView(parent, *args, **kwargs)

Bases: PanedWindow

class mkpy.mkh5viewer.PyGarvTestView(parent, *args, **kwargs)

Bases: Labelframe

viewer + parameter value editor for PyGarvTest datablock test params

class mkpy.mkh5viewer.PyGarvTreeView(parent, columns=None, *args, **kwargs)

Bases: Treeview

common container and styling wrapper for PyGarv catalog and dblock test views

class mkpy.mkh5viewer.PyGarvView(parent, *args, **kwargs)

Bases: Labelframe

thin wrapper around PyGarvEditor model-view for selecting, editing, deleting pygarv tests

Fun facts

• the mkh5 data file is not modified

• View.model.pg maintains the local PyGarv() data model that tracks test results

• pygarv tests are tracked and run “what if”

• test results are are overlayed for viewing in the scope traces and table scope

• test doc may be exported as yaml *.yarf

  • open an editor for new/existing tests and hands them off to Model.pygarv to dry run

Outline

• on init …

  • pygarv (comes with a built in catalog of implemented tests)

  • walk the dblocks and scrape data for pygarv data stream and headers for any pygarv tests

  • user edits create, delete, update the in-memory test specs

  • when input validated for type, self.model.pg attemps to run the test

  • success on running updates the self.pg.pg.tr_docs w/ the test and triggers a view._update() cascade

  • failure returns the exception for handling by the viewer

  • Export button dumps the .yarf YAML (= yarf_docs) for the tr_docs

  • mini-console shows activity and messages

class mkpy.mkh5viewer.TraceView(parent, model, *args, **kwargs)

Bases: Frame

trace view of data drawn on tk.Canvas wrapped in a tk.Label frame

class Trace(parent, x=None, y=None, x_offset=0, y_offset=0, label=None, canvas_id=None, width=None, fill=None)

Bases: object

scalable x,y tk.Canvas grobs

The x and y are the 1-1 unscaled data, stretched into canvas_pts according to parent.x_scale, parent.x_scale

Parameters

parent (TraceView object) – Assumed to have parent.x_scale, parent.y_scale, parent.canvas

Variables

canvas_id (int (None)) – canvas item index if Trace is currently rendered, else None.

• Construct:

  my_line = Trace(parent_trace_view) # container only my_line = Trace(parent_trace_view, x=x_data, y=ydata) # ready to render my_rect = Trace(parent_trace_view, x=(x0,x1), y=(y0,y1)) # ready to render

• Update, optionally with new x,y data

  my_line.update() # rescale only my_line.update(x=x_data, y=y_data) # set x,y data and rescale

• To render a Trace grob on a tk.canvas

  my_line.canvas_id = canvas.create_line(my_trace.canvas_pts, …) my_rect.canvas_id = canvas.create_rectangle(my_trace.canvas_pts, …)

• To delete a Trace grob from a tk.canvas

  canvas.delete(my_trace.canvas_id) my_trace.canvas_id = None

set_x_y(x, y)

store data sample x, y and convert to canvas coords

class TraceDashboard(parent, model, *args, **kwargs)

Bases: Frame

Status and UI controls for continuous vs. event/epoch scrolling

Parameters

• parent

• model

property anchor

The anchor value controls how to place the grid within the master when no row/column has any weight.

The default anchor is nw.

property anchor_dblock_idx

property anchor_event_data

property anchor_vp_offset

find_next_anchor(direction)

look left or right for next event of current pygarv type

This calls Model.next_event() according to the dashboard settings.

Parameters

direction (int) – -1 searches left, 1 searches right

Returns

new_vp_idx – viewport left-edge index to view the found event after taking the anchor offset into account.

Return type

uint

get_scroll_by()

property is_event_view

boolean True if scrolling by one of the event modes

property poststim

property poststim_dblock_idx

property poststim_vp_offset

property prestim

property prestim_dblock_idx

property prestim_vp_offset

set_anchor(dblock_idx)

anchor at dblock index idx, update prestim and poststim from scales

set_dash_status_text(units='seconds')

refresh the status report text

Parameters

units (str (‘samples’, ‘seconds’))

set_epoch_labels_text()

synch epoch text labels w/ scale settings

set_scroll_by(scroll_by)

class TraceHScrollbar(parent, *args, **kwargs)

Bases: Scrollbar

derived scrollbar to update xview from model on set

property position

set()

Set the fractional values of the slider position (upper and lower ends as value between 0 and 1).

b1_drag(e)

stub

b2_drag(e)

stub

b3_drag(e)

stub

bind_keys()

bindings

bind_mouse()

mouse bindings

canvas_get_focus(e)

canvas_mouse_wheel(e)

drag_vp_cursor(e)

dragging mouse over moves viewport cursor and dblock selection

This modifies dblock view selection to drive the cursor, indirect but synchronizes dblock selection and cursor

init_vp_cursor()

mouse_wheel(e)

handle mouse wheel

render_event_marks()

render_pygarv()

render_trace_dashboard()

render or hide the trace dashboard view grobs

render_traces()

fetch viewport info from model and render

render_vernier(e)

render_vp_cursor(vp_cursor_idx=None)

reset_event_marks()

called when viewport changes

reset_pygarv()

called when dblock or PyGarv.tr_docs test changes

reset_scrollregion(*args)

change the canvas scrollregion on zoom params or window changes y scrollregion always needs to include all traces. x scrollregion is canvas width … _update_vp() sets vp_len data points

reset_trace_dashboard()

pull info from the trace dashboard view controls and render

• anchor marker

reset_traces()

reset_vernier()

reset_vp(vp_idx)

set the TraceView viewport index and data slices of the current model.dblock

Parameters

• vp_idx (int) – dblock index (samples) of left edge of TraceView viewport

• viewport start index values may come from keyboard/mouse TraceView navigation or

• be derived from epoch data lookup during table navigation

• The viewport length in samples is derived from the canvas

• scrollregion fraction of the canvas width (== len(dblock) * x_scale)

toggle_event_marks(e)

update_x_scale(e)

handle time zoom

update_y_offset(e)

handle trace vertical spacing

update_y_scale(e)

handle uV zoom

property viewport

class mkpy.mkh5viewer.View(parent, model, *args, **kwargs)

Bases: PanedWindow

top_level view/controller, horizontal paned window with DataView, DashboardView

Parameters

• parent (tk.object)

• model (mkh5viewer.Model instance) – see Model for details

mkpy.mkh5viewer.launch_app(mkh5_f)

mkpy.mkh5viewer.set_styles()