From 305ec527d0e07f131208f2affa7007f0df0a3f10 Mon Sep 17 00:00:00 2001 From: alessandrofelder Date: Mon, 17 Jun 2024 15:33:07 +0100 Subject: [PATCH] improve docstring and signature --- brainglobe_heatmap/heatmaps.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/brainglobe_heatmap/heatmaps.py b/brainglobe_heatmap/heatmaps.py index 8d23b81..ab8ed18 100644 --- a/brainglobe_heatmap/heatmaps.py +++ b/brainglobe_heatmap/heatmaps.py @@ -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: """ - 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