Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove references to nrrd files #202

Merged
merged 1 commit into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions docs/source/documentation/brainglobe-utils/image_io.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Image IO submodule

The image IO submodule provides various options to load and save image data.
It supports common formats like `tiff`, `nrrd` and `nifti`.
It supports common formats like `tiff` and `nifti`.

## Installation

Expand Down Expand Up @@ -29,9 +29,6 @@ load.load_img_stack('mydata.tif', x_scaling_factor=1, y_scaling_factor=1, z_scal
# directory containing a sequence of 2D tiffs
load.load_from_folder('/path/to/dir')

# nrrd
load.load_nrrd('mydata.nrrd')

# nifti
load.load_nii('mydata.nii')
```
Expand Down Expand Up @@ -65,9 +62,6 @@ save.to_tiff(my_array, 'mydata.tif')
# directory containing a sequence of 2D tiffs
save.to_tiffs(my_array, '/path/to/dir/prefix')

# nrrd
save.to_nrrd(my_array, 'mydata.nrrd')

# nifti
save.to_nii(my_array, 'mydata.nii')
```
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ and process neuron morphology data.

Given the popularity of python for scientific research, there are tools to load almost all data formats. These include
numpy to load `.npy` files, `tiffiles` for `.tiff` etc. BrainGlobe provides a general purpose software tool for
loading and saving image data ([image_io](/documentation/brainglobe-utils/image_io)). You can use `image_io` to load most types of
data (e.g. `.nrrd`, `.tiff`, `.nifti` etc), e.g.:
loading and saving image data ([image_io](/documentation/brainglobe-utils/image_io)). You can use `image_io` to load many types of
data (e.g. `.tiff`, `.nifti` etc), e.g.:

```python
from brainglobe_utils.image_io import load
Expand Down