bids.analysis.analysis.Step¶
-
class
Step
(layout, level, index, name=None, transformations=None, model=None, contrasts=None, input_nodes=None, dummy_contrasts=False)[source]¶ Represents a single analysis block from a BIDS-Model specification.
- Parameters
layout (
bids.layout.BIDSLayout
) – The BIDSLayout containing all project files.level (str) – The BIDS keyword to use as the grouping variable; must be one of [‘run’, ‘session’, ‘subject’, or ‘dataset’].
index (int) – The numerical index of the current Step within the sequence of steps.
name (str) – Optional name to assign to the block. Must be specified in order to enable name-based indexing in the parent Analysis.
transformations (list) – List of BIDS-Model transformations to apply.
model (dict) – The ‘model’ part of the BIDS-Model block specification.
contrasts (list) – List of contrasts to apply to the parameter estimates generated when the model is fit.
input_nodes (list) – Optional list of AnalysisNodes to use as input to this Step (typically, the output from the preceding Step).
dummy_contrasts (dict) – Optional dictionary specifying which conditions to create indicator contrasts for. Dictionary must include a “type” key (‘t’ or ‘FEMA’), and optionally a subset of “conditions”. This parameter is over-written by the setting in setup() if the latter is passed.
Methods
get_contrasts
(self[, names, variables])Return contrast information for the current block.
get_design_matrix
(self[, names, format, …])Get design matrix and associated information.
setup
(self[, input_nodes, drop_na])Set up the Step and construct the design matrix.
-
__init__
(self, layout, level, index, name=None, transformations=None, model=None, contrasts=None, input_nodes=None, dummy_contrasts=False)[source]¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
(self, layout, level, index[, name, …])Initialize self.
get_contrasts
(self[, names, variables])Return contrast information for the current block.
get_design_matrix
(self[, names, format, …])Get design matrix and associated information.
setup
(self[, input_nodes, drop_na])Set up the Step and construct the design matrix.