Context & events

Filters share state with each other through the context proxy and react to GUI key presses through the read-only events proxy, both importable from interactive_pipe.

global_params was removed in 0.9.0

The pre-0.9.0 pattern of declaring global_params={} (or context, state, ...) in a filter signature now raises TypeError at filter construction. The proxies replace it entirely — see the changelog for the migration guide.

context — share data between filters

from interactive_pipe import interactive, context

@interactive(color_choice=["red", "green", "blue", "gray"])
def generate_flat_colored_image(color_choice="red"):
    flat_array = COLOR_DICT[color_choice] * np.ones((64, 64, 3))
    context["avg"] = np.average(flat_array)   # dict-style
    context.avg = np.average(flat_array)      # or attribute-style
    return flat_array

def special_image_slice(img):
    out_img = img.copy()
    if context["avg"] > 0.4:                  # read what another filter stored
        out_img[out_img.shape[0] // 2:, ...] = 0.
    return out_img

get_context() returns the underlying shared dictionary directly. You can seed it at pipeline construction: @interactive_pipeline(gui="qt", context={"avg": 0.0}).

events — key-bound one-shot flags

Read-only flags raised by GUI key bindings for a single pipeline run — see Keyboard.

API

Full reference: Context & layout.