Metadata-Version: 2.1
Name: brainbow
Version: 0.0.11
Summary: Script for visualizing ICA/ROI brain parcellation
Author-email: paavali.popov@gmail.com, s.m.plis@gmail.com
Project-URL: Homepage, https://github.com/neuroneural/brainbow
Project-URL: Bug Tracker, https://github.com/neuroneural/brainbow/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: nipy
Requires-Dist: matplotlib

# brainbow
Script for visualizing ICA/ROI brain parcellation
<img src="https://raw.githubusercontent.com/neuroneural/brainbow/main/.github/images/1.png"/>

# Requirements
```
pip install brainbow
```

# Examples
```
brainbow --nifti nifti.nii --anat anat.nii
```

# Options for `brainbow`

- `--nifti`
    - path to the 4D nifti to convert to images
    - required
- `--anat`
    - path to the anatomical image to use as underlay
    - required

- `--output`
    - Name of the output file(s) 
    - default - brainbow-output.png/svg
    - You can specify the exact extension (png or svg). If none is provided, both extensions will be used.
- `--dir`
    - name for the directory where to save results
    - can be nested (e.g., `final/most_final`)
    - default - directory where brainbow is executed
- `--sign`
    - choices: `pos, neg, both`
    - used for filtering only positive, only negative, or both components
    - default - `both`
- `--thr`
    - threshold value for component significance
    - default - `2.0`
- `--dpi`
    - dpi for png output
    - default - `300`


# Output example

<img src="https://raw.githubusercontent.com/neuroneural/brainbow/main/.github/images/brainbow-output.png"/>
