Changeset fa412df in sasview

Timestamp:

Sep 6, 2018 10:58:01 AM (6 years ago)

Author:

krzywon

Branches:

master, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, unittest-saveload

Children:

d0ce666f

Parents:

ec4b19c

Message:

Simplify calling image handler and add documentation.

Location:

src/sas/sasgui

Files:

• guiframe/report_image_handler.py (modified) (4 diffs)
• perspectives/fitting/basepage.py (modified) (1 diff)
• perspectives/invariant/invariant_panel.py (modified) (2 diffs)
• perspectives/invariant/invariant_state.py (modified) (1 diff)

src/sas/sasgui/guiframe/report_image_handler.py

@@ -3 +3 @@
 
 class ReportImageHandler:
-
+    # Singleton class that manages all report plot images
+    # To call the handler, call the static method set_figs
 
     class _ReportImageHandler:
@@ -14 +15 @@
 
         def set_figs(self, figs, bitmaps, perspective):
+            """
+            Save figures and images to memory and return refernces
+            :param figs: A list of matplotlib Figures
+            :param bitmaps: A list of bitmaps
+            :param perspective: A String with the perspective name
+            :return: A tuple of a list of Figures and a list of memory refs
+            """
             imgs = []
             refs = []
@@ -34 +42 @@
 
         def create_unique_name(self, perspective, index=None):
+            """
+            Create a unique key for each item in memory
+            :param perspective: The perspective name as a string
+            :param index: The base index used for incrementing the name
+            :return: A unique file name not currently in use
+            """
             if not index:
                 index = len(self.indices)
@@ -43 +57 @@
             return name
 
-
     instance = None
 
-    def __init__(self):
+    @staticmethod
+    def set_figs(figs, bitmaps, perspective):
         if not ReportImageHandler.instance:
             ReportImageHandler.instance = ReportImageHandler._ReportImageHandler()
+        return ReportImageHandler.instance.set_figs(figs, bitmaps, perspective)

src/sas/sasgui/perspectives/fitting/basepage.py

@@ -652 +652 @@
         by plotting, putting it into wx.FileSystem image object
         """
-
-        img_handler = ReportImageHandler()
         bitmaps = []
         for canvas in canvases:
             bitmaps.append(canvas.bitmap)
-        imgs, refs = img_handler.instance.set_figs(figs, bitmaps, 'fit')
-
-        return img_handler.instance.img_holder, imgs, refs
+        imgs, refs = ReportImageHandler.set_figs(figs, bitmaps, 'fit')
+
+        return ReportImageHandler.instance, imgs, refs
 
     def on_save(self, event):

src/sas/sasgui/perspectives/invariant/invariant_panel.py

@@ -24 +24 @@
 from sas.sasgui.guiframe.panel_base import PanelBase
 from sas.sasgui.guiframe.documentation_window import DocumentationWindow
+from sas.sasgui.guiframe.report_image_handler import ReportImageHandler
 
 logger = logging.getLogger(__name__)
@@ -783 +784 @@
         report_img = self.state.image
         report_list = [report_html_str, report_text_str, report_img]
-        imgRAM = self.state.img_handler
+        imgRAM = ReportImageHandler.instance.img_holder
         refs = [self.state.wximgbmp]
         dialog = ReportDialog(report_list, imgRAM, refs, None, wx.ID_ANY, "")

src/sas/sasgui/perspectives/invariant/invariant_state.py

@@ -612 +612 @@
         wximgbmp = wx.BitmapFromImage(wximg)
         # store the image in wx.FileSystem Object
-        self.img_handler = ReportImageHandler()
-        imgs, refs = self.img_handler.instance.set_figs([fig], [wximgbmp], 'inv')
+        imgs, refs = ReportImageHandler.set_figs([fig], [wximgbmp], 'inv')
 
         self.wximgbmp = refs[0]