bids.analysis.Analysis

class Analysis(layout, model)[source]

Represents an entire BIDS-Model analysis.

Parameters
  • layout (bids.layout.BIDSLayout or str) – A BIDSLayout instance or path to pass on to the BIDSLayout initializer.

  • model (str or dict) – A BIDS model specification. Can either be a string giving the path of the JSON model spec, or an already-loaded dict containing the model info.

Methods

setup(self[, steps, drop_na, finalize])

Set up the sequence of steps for analysis.

finalize

__init__(self, layout, model)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, layout, model)

Initialize self.

finalize(self, \*\*kwargs)

setup(self[, steps, drop_na, finalize])

Set up the sequence of steps for analysis.

setup(self, steps=None, drop_na=False, finalize=True, **kwargs)[source]

Set up the sequence of steps for analysis.

Parameters
  • steps (list) – Optional list of steps to set up. Each element must be either an int giving the index of the step in the JSON config step list, or a str giving the (unique) name of the step, as specified in the JSON config. Steps that do not match either index or name will be skipped.

  • drop_na (bool) – Boolean indicating whether or not to automatically drop events that have a n/a amplitude when reading in data from event files.

  • finalize (bool) – Indicates whether or not to finalize setup. If False, variables are loaded in each Step, but transformations aren’t yet applied, and outputs from each Step aren’t fed forward. If True, the latter procedures are executed, and all Step instances are finalized for design matrix generation.