API Reference¶
bids.layout
: Querying BIDS datasets¶
|
|
|
Layout class representing an entire BIDS dataset. |
|
An object for BIDS (Brain Imaging Data Structure) verification in a data. |
|
Represents a single file or directory in a BIDS dataset. |
|
Represents a single data file in a BIDS dataset. |
|
Represents a single JSON metadata file in a BIDS dataset. |
|
Container for BIDS configuration information. |
|
Represents a single entity defined in the JSON config. |
|
Represents an association between a File and an Entity. |
|
Parse the passed filename for entity/value pairs. |
|
Add to the pool of available configuration files for BIDSLayout. |
Indexer class for BIDSLayout. |
|
Contains helper functions that involve writing operations. |
bids.analysis
: Model specification for BIDS datasets¶
|
|
|
Represents an entire BIDS-Model analysis. |
|
Create a simple default model for each of the tasks in a BIDSLayout. |
|
Represents a single analysis block from a BIDS-Model specification. |
|
A single analysis node generated within a Step. |
Apply all transformations to the variables in the collection. |
bids.reports
: Data acquisition report generation¶
|
|
|
Generates publication-quality data acquisition methods section from BIDS dataset. |
Generate publication-quality data acquisition methods section from BIDS dataset. |
bids.variables
: Variables¶
|
|
|
Represents a simple design matrix column that has no timing information. |
|
A sparse representation of a single column of events. |
|
A dense representation of a single column. |
|
A container for one or more variables extracted from variable files at a single level of analysis. |
A container for one or more RunVariables–i.e., Variables that have a temporal dimension. |
|
|
Merge two or more collections at the same level of analysis. |
|
A convenience wrapper for one or more load_*_variables() calls. |
|
Merge/concatenate a list of variables along the row axis. |
Tools for reading/writing BIDS data files. |
|
Data classes for internal BIDS data hierarchy. |
|
Classes and functions related to the management of sets of BIDSVariables. |
|
Classes for representing BIDS variables. |
bids.config
: PyBIDS Configuration utilities¶
|
Utilities for manipulating package-level settings. |
|
Set a package-wide option. |
|
Set multiple package-wide options. |
Retrieve the current value of a package-wide option. |
|
|
Load package-wide settings from specified file(s). |
|
Reset all options to the package defaults. |
bids.utils
: Utility functions¶
|
Utility functions. |
|
Wraps all non-list or tuple objects in a list; provides a simple way to accept flexible arguments. |
|
Checks whether an object’s entities match the input. |
Recursively convert CamelCase keys to snake_case. |
|
|
Create a BIDSFile instance of the appropriate class. |