From 18f9865ef6c8258b8e0ad39582080caca1c99266 Mon Sep 17 00:00:00 2001 From: bbean Date: Fri, 26 Apr 2024 14:23:09 -0600 Subject: [PATCH] update docstrings as suggested in PR for #82 --- .../spot_analysis/image_processor/View3dImageProcessor.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/opencsp/common/lib/cv/spot_analysis/image_processor/View3dImageProcessor.py b/opencsp/common/lib/cv/spot_analysis/image_processor/View3dImageProcessor.py index 5361eea07..aba3b1233 100644 --- a/opencsp/common/lib/cv/spot_analysis/image_processor/View3dImageProcessor.py +++ b/opencsp/common/lib/cv/spot_analysis/image_processor/View3dImageProcessor.py @@ -16,6 +16,11 @@ class View3dImageProcessor(AbstractSpotAnalysisImagesProcessor): + """ + Interprets the current image as a 3D surface plot and either displays it, or if interactive it displays the surface + and waits on the next press of the "enter" key. + """ + def __init__( self, label: str | rca.RenderControlAxis = 'Light Intensity', @@ -24,9 +29,6 @@ def __init__( crop_to_threshold: int | None = None, ): """ - Interprets the current image as a 3D surface plot and either displays it, or if interactive it displays the - surface and waits on the next press of the "enter" key. - Parameters ---------- label : str | rca.RenderControlAxis, optional