tedana.io.OutputGenerator

class OutputGenerator(reference_img, convention='bidsv1.5.0', out_dir='.', prefix='', config='auto', make_figures=True, verbose=False)[source]

A class for managing tedana outputs.

Parameters

  • reference_img (img_like) – The reference image which defines affine, shape, etc. of output images.

  • convention ({“bidsv1.5.0”, “orig”, or other str}, optional) – Default is “bidsv1.5.0”. Must correspond to a key in config.

  • out_dir (str, optional) – Output directory. Default is current working directory (“.”).

  • prefix (None or str, optional) – Prefix to prepend to output filenames. Default is None, which means no prefix will be used.

  • config (str, optional) – Path to configuration json file, which determines appropriate filenames based on file descriptions. Default is “auto”, which uses tedana’s default configuration file.

  • make_figures (bool, optional) – Whether or not to actually make a figures directory

Variables

  • config (dict) – File naming configuration information.

  • reference_img (img_like) – The reference image which defines affine, shape, etc. of output images.

  • convention (str) – The naming convention for output files.

  • out_dir (str) – Directory in which outputs will be saved.

  • figures_dir (str) – Directory in which figures will be saved. This will correspond to a “figures” subfolder of out_dir.

  • prefix (str) – Prefix to prepend to output filenames.

  • verbose (bool) – Whether or not to generate verbose output