Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
finsberg committed Dec 13, 2024
1 parent e78acdf commit 6663ec6
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# pyvista-ftetwild-pipeline
# mri2mesh

This repository contains a pipeline to generate surfaces from voxelized data using `scikit-image` and `pyvista`. It also contains tools for visualization using `pyvista`.

Expand All @@ -7,39 +7,39 @@ This repository contains a pipeline to generate surfaces from voxelized data usi
To install the required packages, run:

```bash
python3 -m pip install git+https://github.com/finsberg/pyvista-ftetwild-pipeline.git
python3 -m pip install git+https://github.com/scientificcomputing/mri2mesh.git
```

## Usage
The basic using is through the command line using the command `mri2fem`. To see all the options, run:
The basic using is through the command line using the command `mri2mesh`. To see all the options, run:

```bash
mri2fem --help
mri2mesh --help
```

### Visualization
Visualization is achieved through the subcommand `viz`. To see all options you can do

```bash
mri2fem viz --help
mri2mesh viz --help
```

For example to visualize a nifty file called `T1_synthseg.nii.gz`, run:

```bash
mri2fem viz volume-clip -i T1_synthseg.nii.gz
mri2mesh viz volume-clip -i T1_synthseg.nii.gz
```
which will open up the volume with a clipping plane. To see all the options, run:

```bash
mri2fem viz volume-clip --help
mri2mesh viz volume-clip --help
```

### Surface generation
To generate a surface from a nifty file, run:
To generate the parenchyma surface from a nifty file, run:

```bash
mri2fem surface -i T1_synthseg.nii.gz
mri2mesh surface parenchyma -i T1_synthseg.nii.gz
```

## Authors
Expand Down

0 comments on commit 6663ec6

Please sign in to comment.