brainglobe / brainglobe/brainglobe.github.io

[Feature] Document unit convention (pixels v microns) clearly

Open
#268 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
14
Forks
32
Avg merge
1d 22m
Merged PRs (30d)
9

Description

**Is your feature request related to a problem? Please describe.**
https://forum.image.sc/t/brainmapper-points-transformation-issue/105261/6

**Describe the solution you'd like**
In particular, it's confusing that brainrender and brainrender-napari have differing conventions (because we want tools within napari to be self-consistent) - so this should be very clearly documented. And the fact that our "Export to brainrender" button does the scaling for you.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

Contributor guide

Open the contributing guide

Research direction

Start by reading the linked forum discussion and locating the relevant documentation in the brainglobe.github.io repository. Document the differing pixel and micron conventions between brainrender and brainrender-napari, and explain that the “Export to brainrender” button performs the scaling; done means users can find and understand these rules.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.