API Reference

bids.layout: Querying BIDS datasets

bids.layout

bids.layout.BIDSLayout(root[, validate, …])

Layout class representing an entire BIDS dataset.

bids.layout.BIDSValidator([index_associated])

An object for BIDS (Brain Imaging Data Structure) verification in a data.

bids.analysis: Model specification for BIDS datasets

bids.analysis

bids.analysis.Analysis(layout, model)

Represents an entire BIDS-Model analysis.

bids.analysis.auto_model(layout[, …])

Create a simple default model for each of the tasks in a BIDSLayout.

bids.reports: Data acquisition report generation

bids.reports

bids.reports.BIDSReport(layout[, config])

Generates publication-quality data acquisition methods section from BIDS dataset.

bids.reports.utils

Generate publication-quality data acquisition methods section from BIDS dataset.

bids.variables: Variables

bids.variables

bids.variables.io

bids.variables.entities

bids.variables.kollekshuns

Classes and functions related to the management of sets of BIDSVariables.

bids.variables.variables

bids.utils: Utility functions

bids.utils

bids.utils.listify(obj)

Wraps all non-list or tuple objects in a list; provides a simple way to accept flexible arguments.

bids.utils.matches_entities(obj, entities[, …])

Checks whether an object’s entities match the input.