nwbwidgets.controllers package

Submodules

nwbwidgets.controllers.group_and_sort_controllers module

class nwbwidgets.controllers.group_and_sort_controllers.AbstractGroupAndSortController(**kwargs: Any)[source]

Bases: VBox, ValueWidget

Defines the abstract type for GroupAndSortController objects. These classes take in a DynamicTable objects and broadcast a value of the form dict(

order=array-like(uint), group_inds=array-like(uint) | None, labels=array-like(str) | None

)

Public constructor

class nwbwidgets.controllers.group_and_sort_controllers.GroupAndSortController(**kwargs: Any)[source]

Bases: AbstractGroupAndSortController

Parameters

  • dynamic_table (DynamicTable) – the table wrt which the grouping is performed

  • group_by (str) – the column name from the dynamic table for which the grouping is performed

  • window (None or bool,) –

  • keep_rows (Iterable) – rows of dynamic table to consider in the grouping op

  • control_limit (bool) – whether to control the limit of the displayed rows

  • control_order (bool) – whether to control the order of the displayed rows based on other column

  • groups (dict) – dict(column_name=column_values) to work with specific columns only

get_children()[source]
set_group_by(group_by)[source]
group_dd_observer(change)[source]

group dropdown observer

limit_bit_observer(change)[source]

limit bounded int text observer

limit_cb_observer(change)[source]

limit checkbox observer

order_dd_observer(change)[source]

order dropdown observer

ascending_dd_observer(change)[source]

ascending dropdown observer

group_sm_observer(change)[source]

group SelectMultiple observer

range_controller_observer(change)[source]
get_groups()[source]
get_column_values(column_name: str, rows_select=None)[source]

Get the values of the group_by variable

Parameters

  • column_name (str) –

  • rows_select –

get_orderable_cols()[source]
group_and_sort()[source]
update_value()[source]

nwbwidgets.controllers.misc module

class nwbwidgets.controllers.misc.ProgressBar(*_, **__)[source]

Bases: tqdm_notebook

Supports the usual tqdm.tqdm parameters as well as those listed below.

Parameters

display (Whether to call display(self.container) immediately) – [default: True].

nwbwidgets.controllers.misc.make_trial_event_controller(trials, layout=None, multiple=False)[source]

Controller for which reference to use (e.g. start_time) when making time-aligned averages

nwbwidgets.controllers.time_window_controllers module

class nwbwidgets.controllers.time_window_controllers.WindowController(**kwargs: Any)[source]

Bases: HBox, ValueWidget, DescriptionWidget

Public constructor

abstract get_children()[source]
abstract move_up(change)[source]
abstract move_down(change)[source]
abstract move_start(change)[source]
abstract move_end(change)[source]
class nwbwidgets.controllers.time_window_controllers.RangeController(**kwargs: Any)[source]

Bases: WindowController

Public constructor

make_range_slider(**kwargs)[source]
Parameters

kwargs (passed into RangeSlider constructor) –

move_up(change)[source]
move_down(change)[source]
move_start(change)[source]
move_end(change)[source]
get_children()[source]
class nwbwidgets.controllers.time_window_controllers.StartAndDurationController(**kwargs: Any)[source]

Bases: WindowController

Can be used in place of the RangeController.

Parameters

  • tmax (float) – in seconds

  • tmin (float) – in seconds

  • start_value ((float, float)) – start and stop in seconds

  • description (str) –

  • kwargs (dict) –

DEFAULT_DURATION = 5
monitor_slider(change)[source]
monitor_duration(change)[source]
move_up(change)[source]
move_down(change)[source]
move_start(change)[source]
move_end(change)[source]
get_children()[source]

Module contents