Skip to content

Commit

Permalink
improve docstring and signature
Browse files Browse the repository at this point in the history
  • Loading branch information
alessandrofelder committed Jun 17, 2024
1 parent 37d83b1 commit 305ec52
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions brainglobe_heatmap/heatmaps.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,19 @@ def show(self, **kwargs) -> Union[Scene, plt.Figure]:
view = self.plot(**kwargs)
return view

def render(self, camera=None, **kwargs) -> Scene:
def render(self, camera=None) -> Scene:

Check warning on line 137 in brainglobe_heatmap/heatmaps.py

View check run for this annotation

Codecov / codecov/patch

brainglobe_heatmap/heatmaps.py#L137

Added line #L137 was not covered by tests
"""
Renders the hetamap visualization as a 3D scene in brainrender.
Renders the heatmap visualization as a 3D scene in brainrender.
Parameters:
----------
camera : str or dict, optional
The `brainrender` camera to render the scene.
If not provided, `self.orientation` is used.
Returns:
-------
scene : Scene
The rendered 3D scene.
"""

# set brain regions colors
Expand Down

0 comments on commit 305ec52

Please sign in to comment.