modelarrayio.cli.export_results.export_results

modelarrayio.cli.export_results.export_results(in_file, analysis_name, output_dir, group_mask_file=None, compress=True, index_file=None, directions_file=None, cohort_file=None, example_file=None)[source]

Export statistical results from an HDF5 modelarray file.

The modality is inferred from the arguments provided:

  • NIfTI: group_mask_file is given

  • MIF/fixel: index_file and directions_file are given

  • CIFTI: only cohort_file or example_file is given

Parameters:

  • in_file (path-like) – HDF5 file containing statistical results.

  • analysis_name (str) – Name of the statistical analysis results group inside the HDF5 file.

  • output_dir (path-like) – Directory where output files will be written.

  • group_mask_file (path-like, optional) – NIfTI binary group mask. Required for NIfTI results.

  • compress (bool, optional) – Whether to compress output NIfTI or MIF files. Default True.

  • index_file (path-like, optional) – Nifti2 index file. Required for MIF/fixel results.

  • directions_file (path-like, optional) – Nifti2 directions file. Required for MIF/fixel results.

  • cohort_file (path-like, optional) – CSV cohort file used to locate an example source file. Required for CIFTI or MIF if example_file is not given.

  • example_file (path-like, optional) – Path to an example source file whose header serves as a template. Required for CIFTI or MIF if cohort_file is not given.