API Documentation¶

API reference for the ndspflow module.

Table of Contents¶

Core object for defining and executing analysis workflows. This class sub-classes BIDS, Simulation, Transform, and Model classes.

WorkFlow([y_array, x_array])

Workflow definition.

An interface for reading BIDS organized signals into a WorkFlow.

BIDS([bids_path, subjects, fs])

BIDS interface.

An interface allowing simulated signal inputs into a WorkFlow.

Simulate([n_seconds, fs, seeds])

Simulation class.

An interface for defining any (series of) array transform of the input data within a WorkFlow.

Transform([y_array, x_array])

Transformation class.

An wrapper for any model class with a fit method.

Model([model, nodes])

Model wrapper.

Functions to generate workflow graphs using networkx.

`create_graph`(wf[, npad])	Create a networkx graph of the workflow.
`inspect_workflow`(wf[, npad])	Infers nodes and edges from a workflow.