Module neuropype.engine

The data-flow engine of NeuroPype.

The engine defines processing nodes arranged into a flow graph, which is implemented in the following modules:

The data structure that is exchanged between nodes (the Packet) is defined in the following modules:

Furthermore, the following additional modules are defined:

Lastly, the main loop is implemented in the following module:

It is enough to import the engine packet to get access to all engine functionality (except for breakpoints which must be imported explicitly).

Many other utility functions are defined in various modules in neuropype.utilities

Sub-modules

neuropype.engine.axes

Definitions of various kinds of commonly used axis classes …

neuropype.engine.block

Defines the Block data structure …

neuropype.engine.breakpoints

Controls behavior of breakpoints and exceptions in Neuropype nodes in debug mode.

neuropype.engine.common

Miscellaneous low-level primitives that are commonly used across the CPE.

neuropype.engine.constants

Constants that are used throughout the NeuroPype framework …

neuropype.engine.errors

Definitions of error codes and warnings used in NeuroPype …

neuropype.engine.graph

A data-flow graph of processing nodes in NeuroPype …

neuropype.engine.helpers

Useful helper functions for working with engine data structure …

neuropype.engine.main

Definition of Core Processing Engine (CPE) class.

neuropype.engine.node

Defines the base class for all processing nodes in NeuroPype …

neuropype.engine.packet

Defines a data structure that holds the packets of data transmitted between processing nodes (Packet) …

neuropype.engine.ports

Functionality for declaring input/output data ports in NeuroPype …

neuropype.engine.scheduler

Scheduling subsystem for executing data-flow graphs (patches) in NeuroPype.

neuropype.engine.stats

Definitions for representing statistical distributions …