Skip to main content

Export of FSL statistical results using NIDM as specified at

Project description

NIDM-Results for FSL

Build Status

Export mass-univariate neuroimaging results computed in FSL (using FEAT) as NIDM-Results packs.

A NIDM-Results pack is a compressed file containing a NIDM-Results serialization and some or all of the referenced image data files in compliance with NIDM-Results specification.

usage: nidmfsl [-h] [-g GROUP_NAME NUM_SUBJECTS] [-o OUTPUT_NAME] [-d]
               [-n NIDM_VERSION] [--version]

NIDM-Results exporter for FSL Feat.

positional arguments:
  feat_dir              Path to feat directory.

optional arguments:
  -h, --help            show this help message and exit
                        Group label followed by number of subjects
  -o OUTPUT_NAME, --output_name OUTPUT_NAME
                        Name of the output. A "" or ".nidm" (when -d
                        is used) suffix will be appended.
  -d, --directory-output
                        Produces a .nidm directory rather than a
  -n NIDM_VERSION, --nidm_version NIDM_VERSION
                        NIDM-Results version to use (default: latest).
  --version             show program's version number and exit

To install, run the below command in the bash terminal.

    pip install nidmfsl
Compatible with

FSL version 5.0.9


To run the tests for this repository, the following must be installed

  • Git LFS. Installation instructions for Git LFS can be found here.

  • The python packages vcr and ddt. These can be installed using the below commands in the bash terminal:

pip install vcrpy
pip install ddt

In addition, the test data must also be downloaded from the nidmresults-examples repository to <path_to_this_repository>/test/data/nidmresults-examples.

git lfs clone <path_to_this_repository>/test/data/nidmresults-examples
Running the tests

The below command can be used to generate the test cases.

python <path_to_this_repository>/test/

Folowing this, the test cases can be verified against the ground truth provided in the nidmresults-examples repository using the below command.

cd <path_to_this_repository>/test/
python -m unittest discover

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nidmfsl-2.2.0.tar.gz (23.0 kB view hashes)

Uploaded source

Built Distribution

nidmfsl-2.2.0-py2.py3-none-any.whl (24.5 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page