Merge new dataset backend into master for v0.5.0

Author: MatthewSpofford

.github/CONTRIBUTING.md

@@ -1,11 +1,40 @@
 # Contributing
 
 When contributing to this repository, please first discuss the change you wish to make via issue,
-email, or any other method with the owners of this repository before making a change. 
+email, or any other method with the owners of this repository before making a change.
 
 Please note we have a code of conduct, please follow it in all your interactions with the project.
 
-## Pull Request Process
+## Committing
+
+1. *Need* to contain reference to any of the issues that it resolved.
+2. Should contain a description about what was accomplished in the change. If an issue is
+tied to the given commit, then a longer description can be given in the corresponding issue's comments.
+
+## Issues
+
+1. Complete overview of what needs to be accomplished in order to resolve this issue, or what occurs
+when this issue takes place.
+2. *Blocked* and/or *Blocking* labels must be applied if an issue interrupts the progress of another. The
+issues that are *Blocking*/*Blocked* should then be stated in the issue description like so:
+
+> ***Blocking/Blocked Example***:
+> --------------------------- 
+> **Blocked by:** #0, ...
+> 
+> **Blocking:** #0, ...
+
+3. Priority labels that correspond to this issue (please contact code owners with any questions regarding
+priority labels).
+4. Any other labelling that corresponds to this issue should be applied.
+5. Once an issue is being worked on, the *In Progress* label must be applied, as well as assigned to the
+user working on this issue.
+6. An issue will be marked as *Closed* once it is merged successfully into *main* or approved to be closed by
+any code owners.
+7. Don't forget to comment on the issue with any updates regarding your progress, questions/concerns, as well as
+requesting help from any other contributors.
+
+## Pull Requests
 
 1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
    build.

build_config.spec

@@ -0,0 +1,37 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+block_cipher = None
+
+a = Analysis(['src\\multi_stat_analysis\\__main__.py'],
+             pathex=['src\\multi_stat_analysis'],
+             binaries=[],
+             datas=[('C:/workspace/Multiscale-Statistical-Analysis/resources/*', 'resources')],
+             hiddenimports=['scipy.special.cython_special',
+							 'pkg_resources.py2_warn',
+							 'pyimod03_importers',
+							 'pyi_rth_pkgres'],
+             hookspath=[],
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher,
+             noarchive=False)
+			 
+pyz = PYZ(a.pure, a.zipped_data,
+             cipher=block_cipher)
+			 
+exe = EXE(pyz,
+          a.scripts,
+          a.binaries,
+          a.zipfiles,
+          a.datas,
+          [],
+          name='MultiscaleStatisticalAnalysis',
+          debug=False,
+          bootloader_ignore_signals=False,
+          strip=False,
+          upx=False,
+          upx_exclude=[],
+          runtime_tmpdir=None,
+          console=False )

src/multi_stat_analysis/CanvasPanel.py

@@ -98,9 +98,9 @@ def pick_point(event):
                         pos = self.get_scatter_plot().get_offsets()[ind["ind"][0]]
                         scale = pos[0]
 
-                        index = self.get_data().get_results_scale().index(scale)
+                        index = self.data.get_results_scale().index(scale)
                         xregress = self.get_save_xr()
-                        yregress = self.get_data().get_regress_sets()[index]
+                        yregress = self.data.get_regress_sets()[index]
                         # checks the given id to perform the correct regression using the data determined above
                         # this needs error exceptions still
                         regression_choices = \
@@ -285,7 +285,7 @@ def __init__(self, parent, x, xr, y, swb, tree):
         wx.Panel.__init__(self, parent, size=wx.Size(640, 480), style=wx.SIMPLE_BORDER)
 
         self.tree_menu = tree
-        self.workbook = self.tree_menu.GetItemData(swb).get_wb()
+        self.workbook = self.tree_menu.GetItemData(swb)
         self.swb = swb
         self.figure = figure()
         # defines the plot
@@ -540,6 +540,8 @@ def set_popt(self, popt): self.popt = popt
 # TODO: rename the class name
 class SclbyAreaPlot(wx.Panel):
 
+    _X_AXIS_LABEL = "Scale-sensitive multiscale analysis"
+
     def __init__(self, parent, x, y, data):
         # gets the Panel properties
         wx.Panel.__init__(self, parent, size=wx.Size(640, 530), style=wx.SIMPLE_BORDER)
@@ -642,8 +644,8 @@ def draw_plot(self):
 
         self.set_y(newy)
         self.get_axes().set_title('')
-        self.get_axes().set_xlabel(self.data.get_strings()[3][0] + ' ' + self.data.get_strings()[4][0])
-        self.get_axes().set_ylabel(self.data.get_strings()[3][1])
+        self.get_axes().set_xlabel(SclbyAreaPlot._X_AXIS_LABEL)
+        self.get_axes().set_ylabel(self.data.get_row_labels()[0][0])
         self.set_scatter_plot(scatterList)
         # set the x-scale to log plot
         self.get_axes().set_xscale('log')
@@ -681,8 +683,8 @@ def draw_complexity_plot(self):
             scatterList.append(self.get_axes().scatter(self.get_x(), np.log10(yvals), marker="o", s=8))
 
         self.get_axes().set_title('')
-        self.get_axes().set_xlabel(self.data.get_strings()[3][0] + ' ' + self.data.get_strings()[4][0])
-        self.get_axes().set_ylabel(self.data.get_strings()[3][2] + ' log10 scale')
+        self.get_axes().set_xlabel(SclbyAreaPlot._X_AXIS_LABEL)
+        self.get_axes().set_ylabel(self.data.get_row_labels()[0][1] + ' log10 scale')
         self.set_scatter_plot(scatterList)
         # set x-axis to log scale
         self.get_axes().set_xscale('log')

src/multi_stat_analysis/Dialogs.py

@@ -1330,7 +1330,7 @@ def set_saved_legend_text(self, txt): self.legend_text = txt
 # class for the dialog which allows the user to set the x-regression values based on the opened data sets
 class XRValuesDialog(wx.Dialog):
     # Dynamic UI stuff
-    def __init__(self, parent, x):
+    def __init__(self, parent, regress_vals:list):
         wx.Dialog.__init__(self, parent, wx.ID_ANY, "X-Axis Regression Values", size=(450, 350))
         self.main_panel = wx.Panel(self, wx.ID_ANY)
 
@@ -1348,37 +1348,32 @@ def __init__(self, parent, x):
         self.sizer.Add(self.lblxvals, 1, wx.ALL, 5)
 
         self.txt_ctrl = []
-        # dynamically add a new textbox for each file that is opened
-        for value in x:
-            # default textbox value is the name of the file
+        # dynamically add a new textbox for each value that is given in the list
+        for value in regress_vals:
             txt = wx.TextCtrl(self.scroll_panel, value=str(value), pos=(140, 20), size=(250, -1))
             self.txt_ctrl.append(txt)
             self.sizer.Add(txt, 0, wx.ALL, 5)
 
         self.ok = wx.Button(self.btn_panel, id=wx.ID_OK, label="OK", pos=(240, 0))
         self.cancel = wx.Button(self.btn_panel, id=wx.ID_CANCEL, label="Cancel", pos=(335, 0))
 
-        self.xvals_txt = ''
+        self.regress_vals = ''
         self.scroll_panel.SetSizer(self.sizer)
         self.scroll_panel.Layout()
         self.scroll_panel.Fit()
+
     # function for closing the dialog
     def OnQuit(self, event):
-
         self.Destroy()
+
     # function to save the user input values
     def SaveString(self):
-
-        vals = []
-
+        new_regress_vals = []
         for values in self.get_txtctrl():
+            new_regress_vals.append(float(values.GetValue()))
+        self.regress_vals = new_regress_vals
 
-            vals.append(float(values.GetValue()))
-
-        self.set_xvals(vals)
-
-    def get_xvals(self): return self.xvals_txt
-    def set_xvals(self, x): self.xvals_txt = x
+    def get_regress_vals(self): return self.regress_vals
     def get_txtctrl(self): return self.txt_ctrl
 
 class HHPlotDialog(wx.Frame):

src/multi_stat_analysis/MountainsImporter/ImportUtils.py

@@ -4,10 +4,9 @@
 from typing import Optional
 from ctypes import wintypes, windll, create_unicode_buffer, pointer
 
-_DEFAULT_TIMEOUT = 60.0
-_resource_paths = {}
-
 class ResourceFiles:
+    DIRECTORY = "resources"
+
     SSFA_TEMPLATE = "ssfa-template.mnt"
 
     START_MNTS_BTN = "start-mountains.png"
@@ -24,6 +23,15 @@ def append_to_path(end_str, prefix=os.getcwd()):
     """Joins the given end string to the end of the file path prefix."""
     return os.path.join(os.sep, prefix, end_str)
 
+_DEFAULT_TIMEOUT = 60.0
+_resource_paths = {}
+# Find base path for resources
+try:
+    # PyInstaller creates a temp folder and stores path in _MEIPASS
+    _resource_base_path = append_to_path(ResourceFiles.DIRECTORY, sys._MEIPASS)
+except Exception:
+    _resource_base_path = append_to_path(ResourceFiles.DIRECTORY)
+
 def resource_abs_path(relative_path):
     """Get absolute path to resources, works for normal file handling and for PyInstaller.
     Based on answer from stackoverflow page: 
@@ -34,13 +42,8 @@ def resource_abs_path(relative_path):
     if relative_path in _resource_paths:
         return _resource_paths[relative_path]
 
-    try:
-        # PyInstaller creates a temp folder and stores path in _MEIPASS
-        base_path = sys._MEIPASS
-    except Exception:
-        base_path = append_to_path("resources")
-
-    path = append_to_path(relative_path, base_path)
+    global _resource_base_path
+    path = append_to_path(relative_path, _resource_base_path)
     if not os.path.exists(path):
         raise FileNotFoundError("Could not find resource " + path)
     _resource_paths[relative_path] = path

src/multi_stat_analysis/MountainsImporter/Importer.py

@@ -111,20 +111,17 @@ class MntsImporter:
     @param result_file_path
     @param file_dir
     @param file_name
-    @param sensitivity_func
     @param analysis_func_wrapper
     
     @return If an exception is thrown, it can be recieved using the excep_queue queue.
     This queue outputs a tuple with data:
       [0] - Exception to re-raise
       [1] - Traceback to print out"""
-    def __init__(self, is_init, result_file_path, file_dir, file_name,
-                 sensitivity_func, analysis_func_wrapper):
+    def __init__(self, is_init, result_file_path, file_dir, file_name, analysis_func_wrapper):
         self.is_init = is_init
         self.result_file_path = result_file_path
         self.file_dir = file_dir
         self.file_name = file_name
-        self.sensitivity_func = sensitivity_func
         self.analysis_func_wrapper = analysis_func_wrapper
         if __debug__:
             print("Mountains Import Process Initialized.")
@@ -141,7 +138,7 @@ def start(self):
             if self.is_init:
                 self.init_mnts()
 
-            # Generate results file from scale-sensitive fractal analysis
+            # Generate results file from scale-sensitive multiscale analysis
             self.option_select_export_func()
             # Throw exception if the results file was not correctly generated
             if not os.path.exists(self.result_file_path):
@@ -199,11 +196,7 @@ def option_select_export_func(self):
             if __debug__:
                 print("Selected graph")
 
-        # Select sensitivity and analysis options
-        self.sensitivity_func()
-        if __debug__:
-            time.sleep(_DELAY)
-            print("Ran sensitivity selection")
+        # Select analysis options
         self.analysis_func_wrapper.call()
         if __debug__:
             time.sleep(_DELAY)
@@ -243,7 +236,7 @@ def option_select_export_func(self):
         if __debug__:
             print("Closed file editor")
 
-def get_results_data(file_paths, results_dir, sensitive_func, analysis_func_wrapper):
+def get_results_data(file_paths, results_dir, analysis_func_wrapper):
     """Given the list of surface files and a results directory,
     generate the corresponding list of new file names and paths.
     Also generates mountains interaction process calls."""
@@ -261,31 +254,10 @@ def get_results_data(file_paths, results_dir, sensitive_func, analysis_func_wrap
         result_temp_paths.append(ImportUtils.append_to_path(surf_full_name, TEMP_PATH))
         # Add to function list
         mountains_processes.append(
-            MntsImporter(i==0, result_temp_paths[i], TEMP_PATH, surfName, sensitive_func, analysis_func_wrapper))
+            MntsImporter(i==0, result_temp_paths[i], TEMP_PATH, surfName, analysis_func_wrapper))
     # Output generated paths and functions
     return result_paths, result_temp_paths, mountains_processes
 
-def select_scale_sensitivity():
-    """Select scale-sensitivity option"""
-    ImportUtils.click_resource(ResourceFiles.SCALE_SENSITIVE_BTN)
-
-def select_complexity():
-    """Select scale-sensitivity option"""
-    ImportUtils.click_resource(ResourceFiles.COMPLEXITY_BTN)
-
-_sensitivity_option_map = {}
-class SensitivityOption(Enum):
-    """Used by ImportOptionsDialog to specify options for sensitivity combo box."""
-    Scale = ("Scale-sensitive Analysis", select_scale_sensitivity)
-    Complexity = ("Complexity Analysis", select_complexity)
-
-    def __init__(self, label, func):
-        self.label = label
-        self.func = func
-        # Assign label to function map
-        global _sensitivity_option_map
-        _sensitivity_option_map[label] = func
-
 def select_analysis_option(pos):
     """Click on the analysis menu button to prepare for selecting the option"""
     ImportUtils.click_resource(ResourceFiles.ANALYSIS_OPTION_BTN)
@@ -315,10 +287,10 @@ def __init__(self, label, blank):
         _analysis_option_map[label] = AnalysisOptionFuncWrapper(len(_analysis_option_map) + 1)
 
 class ImportOptionsDialog(wx.Dialog):
-    """Create surface import options selection. This includes specifying scale/complexity sensitivity,
-    the type of surface analysis being done, as well as the directory for saving the analysis data.
-    It can then be used to return these selected options wrapped within interactive functions designed
-    for Digital Surf's MountainsMap application."""
+    """Create surface import options selection. This includes specifying the type of surface analysis
+    being done, as well as the directory for saving the analysis data. It can then be used to return
+    these selected options wrapped within interactive functions designed for Digital Surf's MountainsMap 
+    application."""
 
     def __init__(self, parent, file_paths):
         """@param file_paths - List of surface file paths that will be analyzed into result files."""
@@ -339,30 +311,18 @@ def __init__(self, parent, file_paths):
         analysis_label = wx.StaticText(self.options_panel, wx.ID_ANY, label="Analysis Type:")
         self.analysis_combo = self.getTypeCombo(AnalysisOption)
 
-        # Sensitivity Type Selection
-        sensitivity_label = wx.StaticText(self.options_panel, wx.ID_ANY, label="Sensitivity Type:")
-        self.sensitivity_combo = self.getTypeCombo(SensitivityOption)
-
         # Initialize sizer for both combo boxes
         combo_sizer = wx.BoxSizer(wx.HORIZONTAL)
         analysis_sizer = wx.BoxSizer(wx.VERTICAL)
-        sensitivity_sizer = wx.BoxSizer(wx.VERTICAL)
         # Initialize Analyasis sizer
         analysis_sizer.AddStretchSpacer()
         analysis_sizer.Add(analysis_label, flag=wx.ALIGN_LEFT)
         analysis_sizer.Add(self.analysis_combo, flag=wx.ALIGN_LEFT)
         analysis_sizer.AddStretchSpacer()
-        # Initialize Sensitivity sizer
-        sensitivity_sizer.AddStretchSpacer()
-        sensitivity_sizer.Add(sensitivity_label, flag=wx.ALIGN_LEFT)
-        sensitivity_sizer.Add(self.sensitivity_combo, flag=wx.ALIGN_LEFT)
-        sensitivity_sizer.AddStretchSpacer()
         # Layout combo sizers
         combo_sizer.AddStretchSpacer()
         combo_sizer.Add(analysis_sizer, flag=wx.CENTER)
         combo_sizer.AddStretchSpacer()
-        combo_sizer.Add(sensitivity_sizer, flag=wx.CENTER)
-        combo_sizer.AddStretchSpacer()
 
         # Results folder selection button handling
         results_label = wx.StaticText(self.options_panel, wx.ID_ANY, label="Select Results Folder:")
@@ -416,11 +376,10 @@ def okBtnHandler(self, event):
             else: # Create new directory to save files, directory accepted
                 os.mkdir(selected_results_dir)
 
-            sensitive_func = _sensitivity_option_map[self.sensitivity_combo.GetStringSelection()]
             analysis_func = _analysis_option_map[self.analysis_combo.GetStringSelection()]
             # Build new file path based on given surface files and results dir
             new_file_paths, temp_file_paths, new_mountains_processes = \
-                get_results_data(self.file_paths, selected_results_dir, sensitive_func, analysis_func)
+                get_results_data(self.file_paths, selected_results_dir, analysis_func)
 
             # Possibly overwrite check was requested
             already_exists = []
@@ -471,6 +430,7 @@ class ImportInfoDialog(wx.MessageDialog):
     tool_information = \
     "Please follow these requirements in order to have the most optimal/functional experience with" \
     "the surface import tool:\n\n" \
+    "  - To recieve reliable results, the means of measuring and equipment used should be identical between surfaces\n"\
     "  - Do not move your mouse or use the keyboard during the import process\n" \
     "  - Enable the MountainsMap product configuration startup window\n" \
     "  - Verify that last usage of MountainsMap did not terminate unexpectedly\n" \