bsmschema.models.Options#
- object Options#
Estimation options that are common to multiple estimation packages.
- Config:
extra: Extra = Extra.forbid
- field ReplaceVariables: Optional[Dict[str, Any]]#
Allows a specification of design matrix columns that are to be replaced by the estimating software. Keys are the names of columns to replace; values are unconstrained, and can be anything that helps the receiving software understand what is intended. For example, it is relatively common to want to include a voxel-specific timecourse as a covariate. In this case, the expectation is that the user will have constructed a dummy column as a placeholder (e.g., by adding a constant column to events.tsv files), and then indicate (via ReplaceVariables) how the receiving software should inject new values.
- field Mask: Optional[Dict[str, List[Any]]]#
BIDS entities specifying a mask file from the input dataset. For example, {“desc”: “brain”, “suffix”: “mask”}.
- field Aggregate: Optional[Literal['none', 'mean', 'pca']]#
Method of combining time series within each value in the Mask. The following values are valid: “none”, “mean”, “pca”. “none” (the default) indicates no dimensionality reduction; a separate timecourse is returned for each voxel that contains at least one non-zero value in its timecourse. “mean” returns the average of all voxels within each discrete non-zero value found in the image. “pca” returns the first principal component of all voxels within each discrete non-zero value found in the image.