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.

Sign up for GitHub

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 documentation about disabled brainglobe-napari-io functionality #75

Merged
merged 1 commit into from
Oct 25, 2023
Merged

Remove documentation about disabled brainglobe-napari-io functionality #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 0 additions & 16 deletions docs/source/documentation/brainreg/user-guide/visualisation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ If you have used the brainreg command-line interface, or simply want to view res
brainreg comes with a plugin for napari to allow you to easily view registration results.

## Usage
Typically, you would view the results in sample space, i.e. with registration results overlaid on your data.

To begin, open napari and drag your brainreg output directory (the one with the log file) onto the napari window.

Various images should then open, including:
Expand All @@ -22,17 +20,3 @@ N.B. If you use a high-resolution atlas (such as `allen_mouse_10um`), then the f
:::

![Visualisation in sample space](/documentation/brainreg/images/sample_space.gif)

## Atlas space

`napari-brainreg` also comes with an additional plugin, for visualising your data in atlas space,
i.e., where your data is warped to the atlas coordinate space.

This is typically only used in other software, but you can enable it yourself:

* Open napari
* Navigate to `Plugins` -> `Plugin Call Order`
* In the `Plugin Sorter` window, select `napari_get_reader` from the `select hook...` dropdown box
* Drag `brainreg_read_dir_standard_space` (the atlas space viewer plugin) above `brainreg_read_dir`
(the normal plugin) to ensure that the atlas space plugin is used preferentially.