docs: add tool tips for most controls

DC-analysis · May 28, 2024 · f1f13b0 · f1f13b0
1 parent 9cc18db
commit f1f13b0
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -6,6 +6,7 @@
    "Exploit basins" checkbox
  - fix: show correct data PPID in CLI
  - setup: bump dcnum from 0.19.1 to 0.20.1
+ - docs: add tool tips for most controls
 0.3.1
  - ref: migrate from QTableView to QTableWidget (issues with Windows 11)
 0.3.0

diff --git a/chipstream/gui/main_window.ui b/chipstream/gui/main_window.ui
@@ -158,7 +158,7 @@
           <item>
            <widget class="QCheckBox" name="checkBox_bg_flickering">
             <property name="toolTip">
-             <string/>
+             <string>Use this option if the input dataset exhibits global temporal brightness variations of a few grayscal values</string>
             </property>
             <property name="text">
              <string>flickering correction</string>
@@ -209,6 +209,9 @@
              <layout class="QGridLayout" name="gridLayout_3">
               <item row="0" column="0">
                <widget class="QLabel" name="label">
+                <property name="toolTip">
+                 <string>Mask-generating threshold for the background-corrected image.</string>
+                </property>
                 <property name="text">
                  <string>Threshold</string>
                 </property>
@@ -217,7 +220,7 @@
               <item row="0" column="1">
                <widget class="QSpinBox" name="spinBox_thresh">
                 <property name="toolTip">
-                 <string>Mask-generating threshold for the background-corrected image.</string>
+                 <string>Values smaller than zero are allowed</string>
                 </property>
                 <property name="minimum">
                  <number>-10</number>
@@ -245,6 +248,9 @@
               <verstretch>0</verstretch>
              </sizepolicy>
             </property>
+            <property name="toolTip">
+             <string>Select the segmentation method to use</string>
+            </property>
             <item>
              <property name="text">
               <string>Disabled (from input file)</string>
@@ -274,6 +280,9 @@
          <layout class="QVBoxLayout" name="verticalLayout_7">
           <item>
            <widget class="QCheckBox" name="checkBox_feat_bright">
+            <property name="toolTip">
+             <string>Compute brightness features, such as mean event brightness</string>
+            </property>
             <property name="text">
              <string>Image brightness features</string>
             </property>
@@ -284,6 +293,9 @@
           </item>
           <item>
            <widget class="QCheckBox" name="checkBox_feat_volume">
+            <property name="toolTip">
+             <string>Estimate the event volume using volrevolve algorithm</string>
+            </property>
             <property name="text">
              <string>Volume</string>
             </property>
@@ -294,6 +306,9 @@
           </item>
           <item>
            <widget class="QCheckBox" name="checkBox_feat_haralick">
+            <property name="toolTip">
+             <string>Compute the haralick texture features (computationally expensive)</string>
+            </property>
             <property name="text">
              <string>Haralick texture features</string>
             </property>
@@ -306,6 +321,9 @@
             </property>
             <item>
              <widget class="QCheckBox" name="checkBox_pixel_size">
+              <property name="toolTip">
+               <string>Set the pixel size to a fixed value for all input files</string>
+              </property>
               <property name="text">
                <string>Set global pixel size</string>
               </property>
@@ -349,8 +367,11 @@
          <layout class="QVBoxLayout" name="verticalLayout_8">
           <item>
            <widget class="QSpinBox" name="spinBox_procs">
+            <property name="toolTip">
+             <string>Number of CPU threads to use, reduce if you need a responsive system</string>
+            </property>
             <property name="suffix">
-             <string> Worker Processes</string>
+             <string> Worker threads</string>
             </property>
             <property name="minimum">
              <number>2</number>