Merge pull request #218 from spc-group/planwindows

Planwindows

src/firefly/application.py

@@ -257,7 +257,9 @@ def setup_window_actions(self):
         plans = [
             # (plan_name, text, display file)
             ("count", "&Count", "count.py"),
+            ("move_motor", "&Move motor", "move_motor_window.py"),
             ("line_scan", "&Line scan", "line_scan.py"),
+            ("grid_scan", "&Grid scan", "grid_scan.py"),
             ("xafs_scan", "&XAFS Scan", "xafs_scan.py"),
         ]
         self.plan_actions = []

src/firefly/plans/grid_scan.py

@@ -0,0 +1,188 @@
+import logging
+
+from bluesky_queueserver_api import BPlan
+from qtpy import QtWidgets
+from qtpy.QtGui import QDoubleValidator
+
+from firefly.application import FireflyApplication
+from firefly.component_selector import ComponentSelector
+from firefly.plans.line_scan import LineScanDisplay
+
+log = logging.getLogger()
+
+
+class TitleRegion:
+    def __init__(self):
+        self.setup_ui()
+
+    def setup_ui(self):
+        self.layout = QtWidgets.QGridLayout()
+        labels = ["Priority axis", "Motor", "Start", "Stop", "Snake", "Fly"]
+        Qlabels_all = {}
+
+        # add labels in the first row
+        for i, label_i in enumerate(labels):
+            Qlabel_i = QtWidgets.QLabel(label_i)
+            self.layout.addWidget(Qlabel_i, 0, i)
+            Qlabels_all[label_i] = Qlabel_i
+
+        # fix widths so the labels are aligned with GridScanRegions
+        Qlabels_all["Priority axis"].setFixedWidth(70)
+        Qlabels_all["Motor"].setFixedWidth(100)
+        Qlabels_all["Snake"].setFixedWidth(53)
+        Qlabels_all["Fly"].setFixedWidth(43)
+
+        # add labels in the second row
+        label = QtWidgets.QLabel("fast -> slow")
+        self.layout.addWidget(label, 1, 0)
+
+
+class GridScanRegion:
+    def __init__(self):
+        self.setup_ui()
+
+    def setup_ui(self):
+        self.layout = QtWidgets.QHBoxLayout()
+
+        # First item, motor No.
+        self.motor_label = QtWidgets.QLCDNumber()
+        self.motor_label.setStyleSheet(
+            "QLCDNumber { background-color: white; color: red; }"
+        )
+        self.layout.addWidget(self.motor_label)
+
+        # Second item, ComponentSelector
+        self.motor_box = ComponentSelector()
+        self.layout.addWidget(self.motor_box)
+
+        # Third item, start point
+        self.start_line_edit = QtWidgets.QLineEdit()
+        self.start_line_edit.setValidator(QDoubleValidator())  # only takes floats
+        self.start_line_edit.setPlaceholderText("Start…")
+        self.layout.addWidget(self.start_line_edit)
+
+        # Forth item, stop point
+        self.stop_line_edit = QtWidgets.QLineEdit()
+        self.stop_line_edit.setValidator(QDoubleValidator())  # only takes floats
+        self.stop_line_edit.setPlaceholderText("Stop…")
+        self.layout.addWidget(self.stop_line_edit)
+
+        # Fifth item, snake checkbox
+        self.snake_checkbox = QtWidgets.QCheckBox()
+        self.snake_checkbox.setText("Snake")
+        self.snake_checkbox.setEnabled(True)
+        self.layout.addWidget(self.snake_checkbox)
+
+        # Sixth item, fly checkbox # not available right now
+        self.fly_checkbox = QtWidgets.QCheckBox()
+        self.fly_checkbox.setText("Fly")
+        self.fly_checkbox.setEnabled(False)
+        self.layout.addWidget(self.fly_checkbox)
+
+
+class GridScanDisplay(LineScanDisplay):
+    default_num_regions = 2
+
+    def __init__(self, parent=None, args=None, macros=None, ui_filename=None, **kwargs):
+        super().__init__(parent, args, macros, ui_filename, **kwargs)
+
+    def customize_ui(self):
+        super().customize_ui()
+        # add title layout
+        self.title_region = TitleRegion()
+        self.ui.title_layout.addLayout(self.title_region.layout)
+        # reset button
+        self.ui.reset_pushButton.clicked.connect(self.reset_default_regions)
+
+    def add_regions(self, num=1):
+        for i in range(num):
+            region = GridScanRegion()
+            self.ui.regions_layout.addLayout(region.layout)
+            # Save it to the list
+            self.regions.append(region)
+
+            # the num of motor
+            num_motor_i = len(self.regions)
+            # region.motor_label.setText(str(num_motor_i)) # when using label
+            region.motor_label.display(num_motor_i)
+
+    def time_calculate_method(self, detector_time):
+        num_points = self.ui.scan_pts_spin_box.value()
+        num_regions = len(self.regions)
+        total_time_per_scan = num_regions * detector_time * num_points
+        return total_time_per_scan
+
+    def update_regions(self):
+        super().update_regions()
+
+        # disable snake for the last region and enable the previous regions
+        self.regions[-1].snake_checkbox.setEnabled(False)
+        for region_i in self.regions[:-1]:
+            region_i.snake_checkbox.setEnabled(True)
+
+    def queue_plan(self, *args, **kwargs):
+        """Execute this plan on the queueserver."""
+        detectors, num_points, motor_args, repeat_scan_num, md = (
+            self.get_scan_parameters()
+        )
+
+        # get snake axes, if all unchecked, set it None
+        snake_axes = [
+            region_i.motor_box.current_component().name
+            for i, region_i in enumerate(self.regions)
+            if region_i.snake_checkbox.isChecked()
+        ]
+
+        if snake_axes == []:
+            snake_axes = False
+
+        if self.ui.relative_scan_checkbox.isChecked():
+            scan_type = "rel_grid_scan"
+        else:
+            scan_type = "grid_scan"
+
+        # # Build the queue item
+        item = BPlan(
+            scan_type,
+            detectors,
+            *motor_args,
+            num=num_points,
+            snake_axes=snake_axes,
+            md=md,
+        )
+
+        # Submit the item to the queueserver
+        app = FireflyApplication.instance()
+        log.info("Added line scan() plan to queue.")
+        # repeat scans
+        for i in range(repeat_scan_num):
+            app.add_queue_item(item)
+
+    def ui_filename(self):
+        return "plans/grid_scan.ui"
+
+
+# -----------------------------------------------------------------------------
+# :author:    Juanjuan Huang
+# :email:     [email protected]
+# :copyright: Copyright © 2024, UChicago Argonne, LLC
+#
+# Distributed under the terms of the 3-Clause BSD License
+#
+# The full license is in the file LICENSE, distributed with this software.
+#
+# DISCLAIMER
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# -----------------------------------------------------------------------------