glmdenoise.io.directory module

glmdenoise.io.directory.run_bids(bids, sub_num=None, sub=None, task=None, ses=None)[source]

Recursively run GLMdenoise on subjects, tasks, sessions

This uses a bids object that is able to find data in the BIDS directory it represents. See run_bids_directory to call this with a directory path.

Parameters:
  • bids (glmdenoise.io.bids.BidsDirectory) – Wrapper for pybids
  • sub_num (int, optional) – Number of one subject to run. Defaults to None.
  • sub (str, optional) – BIDS identifier of one subject to run. Defaults to None.
  • task (str, optional) – Name of specific task to run. Defaults to None.
  • ses (str, optional) – Session identifier to run. Defaults to None, meaning run all sessions one by one
glmdenoise.io.directory.run_bids_directory(directory='.', sub_num=None, sub=None, task=None)[source]

Run glmdenoise on a whole or part of a dataset in a BIDS directory

Parameters:
  • directory (str, optional) – Root data directory containing BIDS. Defaults to ‘.’
  • sub_num (int, optional) – Number of one subject to run. Defaults to None.
  • sub (string, optional) – BIDS identifier of one subject to run. Defaults to None.
  • task (string, optional) – Name of specific task to run. Defaults to None.
glmdenoise.io.directory.run_bids_subset(bids, sub, task, ses=None)[source]

Run GLMdenoise on a subset of files in a BIDS dir defined by the args

This uses a bids object that is able to find data in the BIDS directory it represents. See run_bids_directory to call this with a directory path.

Parameters:
  • bids (glmdenoise.io.bids.BidsDirectory) – Wrapper for pybids
  • sub (str) – BIDS identifier of one subject to run.
  • task (str) – Name of specific task to run.
  • ses (str, optional) – Session identifier to run. Defaults to None, meaning there are no sessions.