ConFixel: Moved to ModelArrayIO

ConFixel has moved beyond fixels and handles a lot of other modalities. It also got optimized! Going forward, ConFixel is now ModelArrayIO.. This repository will be left here because the URL is in the publication.

ConFixel is companion converter software for ModelArray for converting data back and forth from the HDF5 file format.

ConFixel software includes three converters: ConFixel for fixel-wise data (.mif), ConVoxel for voxel-wise data (NIfTI) and ConCIFTI for CIFTI-2 dscalar files. Each converter converts between the original image format and the HDF5 file format (.h5) that ModelArray uses.

Below lists the commands in each converter. After installation, these commands can be directly called in a terminal console.

• ConFixel converter for fixel-wise data (MRtrix image format .mif):
  • .mif --> .h5: command confixel
  • .h5 --> .mif: command fixelstats_write
• ConVoxel converter for voxel-wise data (NIfTI):
  • NIfTI --> .h5: command convoxel
  • .h5 --> NIfTI: command volumestats_write
• ConCIFTI converter for greyordinate-wise data (CIFTI-2):
  • CIFTI-2 --> .h5: command concifti
  • .h5 --> CIFTI-2: command ciftistats_write

Installation

Install dependent software MRtrix (only required for fixel-wise data .mif)

When converting fixel-wise data's format (.mif), converter ConFixel uses function mrconvert from MRtrix, so please make sure MRtrix has been installed. If it's not installed yet, please refer to MRtrix's webpage for how to install it. Type mrview in the terminal to check whether MRtrix installation is successful.

If your input data is voxel-wise data or CIFTI (greyordinate-wise) data, you can skip this step.

Install ConFixel software

Before installing ConFixel software, you may want to create a conda environment - see here for more. If you installed MRtrix in a conda environment, you can directly install ConFixel software in that environment.

You can install ConFixel software from GitHub:

git clone https://github.com/PennLINC/ConFixel.git
cd ConFixel
pip install .   # build via pyproject.toml

If you are a developer, and if there is any update in the source code locally, you may update the installation with an editable install:

# From the repository root
pip install -e .

Alternatively, if you have hatch installed, you can build wheels/sdist locally:

hatch build
pip install dist/*.whl

How to use

We provide walkthrough for how to use ConFixel for fixel-wise data, and walkthrough for ConVoxel for voxel-wise data.

As ConFixel software is usually used together with ModelArray, we also provide a combined walkthrough of ConFixel + ModelArray with example fixel-wise data.

You can also refer to --help for additional information:

confixel --help

You can replace confixel with other commands in ConFixel.