You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-11
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,15 @@
1
1
# brainglobe-heatmap
2
-
Rendering anatomical heatmaps with brainrender and matplotlib.
2
+
`brainglobe-heatmap` allows you to create heatmaps, mapping scalar values for each brain region (e.g., number of labelled cells in each region) to a color and creating beautiful visualizations in 2D (using [matplotlib](https://matplotlib.org/) or 3D (using [brainrender](https://brainglobe.info/documentation/brainrender/index.html)).
3
3
4
+


7
9
10
+
**3D heatmap generated using brainrender**
8
11
9
-
10
-
`brainglobe-heatmap` makes it easier to create beautiful heatmaps from anatomical data mapping a scalar values for each brain region (e.g., number of labelled cells in each region) to color and creating beautiful visualizations in 3D and 2D.
11
-
12
-

13
-

14
-
15
-
### installation
12
+
## Installation
16
13
`pip install brainglobe-heatmap`
17
14
18
15
@@ -32,7 +29,7 @@ For example:
32
29
```
33
30
34
31
`brainglobe-heatmap` creates a brainrender 3D `Scene` with the given regions colored according the values in the dictionary.
35
-
Next, to create visualizations like the ones shown above, the three dimensional sceen needs to be **sliced** to expose
32
+
Next, to create visualizations like the ones shown above, the three dimensional scene needs to be **sliced** to expose
36
33
the relevant parts.
37
34
This is done by specifying the position and orientation of a `Plane` which cuts through the scene.
38
35
@@ -149,7 +146,7 @@ For more information see the API's [documentation](https://brainglobe.info/docum
149
146
## Contributing
150
147
Contributions to `brainglobe-heatmap` are more than welcome. Please see the [Developer's guide](https://github.com/brainglobe/.github/blob/main/CONTRIBUTING.md).
151
148
152
-
# Citing `brainglobe-heatmap`
149
+
##Citing `brainglobe-heatmap`
153
150
If you use `brainglobe-heatmap` in your work, please cite it as:
0 commit comments