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

[Feature] Better documentation for brainglobe_space #218

Open
alessandrofelder opened this issue Jul 18, 2024 · 0 comments
Open

[Feature] Better documentation for brainglobe_space #218

alessandrofelder opened this issue Jul 18, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@alessandrofelder
Copy link
Member

alessandrofelder commented Jul 18, 2024

Is your feature request related to a problem? Please describe.
@sfmig @viktorpm and I needed to spend quite a while to understand basic brainglobe-space functionality (in particular, the AnatomicalSpace constructor and its map_points_to function - orientations are tricky. For example, it's not clear from the docstrings or the documentation here, whether and how scale is handled.

Describe the solution you'd like

  • Examples in the brainglobe-space docs showing how re-orienting and scaling are expected to work, and how to instantiate AnatomicalSpaces for this.
  • As a consequence, a clarification about in what units and orientation map_points_to expect its points argument.
    • in particular, what scale will a target space have when I call my_anatomical_space.map_points_to("lpi", points)?
  • An explanation/pointing out of the decorator @to_target in the dev docs
  • updating of existing docs to include the deprecated use of SpaceConvention and use AnatomicalSpace instead.

Describe alternatives you've considered

\

Additional context
Confusion here arising from trying to fix the admba atlas.

@alessandrofelder alessandrofelder added the enhancement New feature or request label Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant