xrdPlanner 2.4.0__tar.gz → 2.4.2__tar.gz

{xrdplanner-2.4.0 → xrdplanner-2.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: xrdPlanner
-Version: 2.4.0
+Version: 2.4.2
 Summary: A tool to project X-ray diffraction cones on a detector screen at different geometries (tilt, rotation, offset) and X-ray energies
 Author-email: Lennard Krause <lkrause@chem.au.dk>
 Project-URL: Homepage, https://github.com/LennardKrause/xrdPlanner
@@ -19,9 +19,10 @@ Requires-Dist: pyqtgraph>=0.13
 Requires-Dist: Dans_Diffraction>=2.2.3
 Requires-Dist: PyQt6>=6.5
 Requires-Dist: pyFAI>=2023.5
+Dynamic: license-file
 
 # xrdPlanner
-## Version 2.4.0 (released 04.03.2025)
+## Version 2.4.1 (released 05.03.2025)
 #### A tool to project X-ray diffraction cones on a detector screen at different geometries (tilt, rotation, offset) and X-ray energies
  - Article published in [_J. Synchrotron Rad._ (2024). **31**](https://doi.org/10.1107/S1600577523011086).
  - Main application is to visualize the maximum achievable resolution at a given geometry.
@@ -121,7 +122,10 @@ where $SDD$ is the sample to detector distance.
 > - A new parameter was added to allow for detector screen padding (plo.plot_padding), default is 0.
 
 ## Latest updates:
-  - 2025-03-04 Update: Added pxrd ghost lines to play with and compare the scattering using different parameters.
+  - 2025-03-05 Update: The slider values now accept input (thanks Clemens and Guðrún).
+  - 2025-03-05 Bugfix: Windows that allow typing will now disregard hotkeys.
+  - 2025-03-04 Update: Allowed smaller pixels in the detector-db editor (thanks tjalb).
+  - 2025-03-04 Update: Added pxrd ghost lines to play with and compare the scattering using different parameters (they are not perfect, don't scare them away!).
   - 2025-03-04 Update: Made some improvements to the highlighting.
   - 2025-03-04 Update: Trained most sub-windows to remember their place.
   - 2025-03-04 Update: Started to declutter the code.

{xrdplanner-2.4.0 → xrdplanner-2.4.2}/README.md

@@ -1,5 +1,5 @@
 # xrdPlanner
-## Version 2.4.0 (released 04.03.2025)
+## Version 2.4.1 (released 05.03.2025)
 #### A tool to project X-ray diffraction cones on a detector screen at different geometries (tilt, rotation, offset) and X-ray energies
  - Article published in [_J. Synchrotron Rad._ (2024). **31**](https://doi.org/10.1107/S1600577523011086).
  - Main application is to visualize the maximum achievable resolution at a given geometry.
@@ -99,7 +99,10 @@ where $SDD$ is the sample to detector distance.
 > - A new parameter was added to allow for detector screen padding (plo.plot_padding), default is 0.
 
 ## Latest updates:
-  - 2025-03-04 Update: Added pxrd ghost lines to play with and compare the scattering using different parameters.
+  - 2025-03-05 Update: The slider values now accept input (thanks Clemens and Guðrún).
+  - 2025-03-05 Bugfix: Windows that allow typing will now disregard hotkeys.
+  - 2025-03-04 Update: Allowed smaller pixels in the detector-db editor (thanks tjalb).
+  - 2025-03-04 Update: Added pxrd ghost lines to play with and compare the scattering using different parameters (they are not perfect, don't scare them away!).
   - 2025-03-04 Update: Made some improvements to the highlighting.
   - 2025-03-04 Update: Trained most sub-windows to remember their place.
   - 2025-03-04 Update: Started to declutter the code.

{xrdplanner-2.4.0 → xrdplanner-2.4.2}/xrdPlanner/__init__.py

@@ -1,6 +1,6 @@
-__version__ = '2.4.0'
+__version__ = '2.4.2'
 __author__ = 'Lennard Krause'
 __authors__ = ['Lennard Krause', 'Frederik H. Gjørup', 'Mads R. V. Jørgensen']
 __email__ = 'lkrause@chem.au.dk'
-__date__ = '04.03.2025'
+__date__ = '01.04.2025'
 __year__ = '2025'

{xrdplanner-2.4.0 → xrdplanner-2.4.2}/xrdPlanner/classes.py

@@ -15,8 +15,7 @@ import xrdPlanner.resources
 # change pxrd scatterplot highlight to use dedicated highlighter (scatterplot)
 # check what windows need update on theme change
 # out-class pxrd window
-
-# work out how to update fwhm window only in visible
+# pxrd viewer prevent using 'd'?
 
 # debug fn to show who is calling what and when to find out why.
 #import inspect
@@ -35,7 +34,7 @@ class MainWindow(QtWidgets.QMainWindow):
         super().__init__(*args, **kwargs)
 
         # set path home
-        self.path_home = os.path.dirname(__file__)
+        self.path_home = os.getenv('XRDPLANNER', os.path.dirname(__file__))
         #self.setMouseTracking(True)
 
         # enable antialiasing
@@ -164,13 +163,13 @@ class MainWindow(QtWidgets.QMainWindow):
         # initialize hotkey window
         self.hotkeys_win = HotkeysWindow(parent=self)
         # initialize detdb window
-        self.detdb_win = DetdbWindow(parent=self)
+        self.detdb_win = DetdbWindow(parent=self, hotkeys=False)
         # initialize export window
-        self.export_win = ExportWindow(parent=self)
+        self.export_win = ExportWindow(parent=self, hotkeys=False)
         # initialize fwhm parameter window
         self.fwhm_win = FwhmWindow(parent=self)
         # initialize unit cell window
-        self.uc_win = UnitCellWindow(parent=self)
+        self.uc_win = UnitCellWindow(parent=self, hotkeys=False)
         # initialize absorption window
         #self.abs_win = AbsorptionWindow(parent=self)
 
@@ -2596,10 +2595,10 @@ class MainWindow(QtWidgets.QMainWindow):
                                             'dc':'Change to sin(\u03B8)/\u03BB'},
                             
                             ('Label position'):None,
-                            ('Up', None):  {'fn':(self.label_set_position, 'top'),
-                                            'dc':'Top left'},
-                            ('Down', None):{'fn':(self.label_set_position, 'bottom'),
-                                            'dc':'Bottom left'},
+                            ('Up', 'SHIFT'):  {'fn':(self.label_set_position, 'top'),
+                                               'dc':'Top left'},
+                            ('Down', 'SHIFT'):{'fn':(self.label_set_position, 'bottom'),
+                                               'dc':'Bottom left'},
                             
                             ('Toggles'):None,
                             ('P', None):   {'fn':(self.toggle_overlay_polarisation, None),
@@ -2768,7 +2767,6 @@ class MainWindow(QtWidgets.QMainWindow):
         self.pxrd_line = pg.InfiniteLine(pos=0, angle=0, pen=pg.mkPen(None))
         self.pxrd_plot.addItem(self.pxrd_line)
         
-
         self.pxrd_ghost_curves = [] # list to store ghost lines
         self.pxrd_ghost_bank = [('blinky', '#fb0009'), ('pinky', '#fc60ff'), ('inky', '#22ffff'),
                                 ('clyde', '#f27a10'), ('sue', '#9208ff'), ('dinky', '#e1e1e1'),
@@ -3033,18 +3031,22 @@ class MainWindow(QtWidgets.QMainWindow):
             pxrd_ghost_bank (list): List to store removed ghost curves with their 
                                     name and pen color.
         """
+        # find all invisible ghosts
         remove_later = []
         for ghost in self.pxrd_ghost_curves:
             if not ghost.isVisible():
                 remove_later.append(ghost)
+        # remove them, append to ghost bank
         for ghost in remove_later:
             self.pxrd_plot.getPlotItem().removeItem(ghost)
             self.pxrd_ghost_curves.remove(ghost)
             self.pxrd_ghost_bank.insert(0, (ghost.name(), ghost.opts['pen'].color().name()))
+        # if nothing was flagged, remove the last, append to ghost bank
         if len(remove_later) == 0 and len(self.pxrd_ghost_curves) > 0:
                 ghost = self.pxrd_ghost_curves[-1]
                 self.pxrd_plot.getPlotItem().removeItem(ghost)
                 self.pxrd_ghost_curves.remove(ghost)
+                self.pxrd_ghost_bank.insert(0, (ghost.name(), ghost.opts['pen'].color().name()))
 
     #######
     # CIF #
@@ -4241,7 +4243,7 @@ class MainWindow(QtWidgets.QMainWindow):
         self.path_settings_current = os.path.join(self.path_settings, name)
         self.settings_reload()
     
-    def settings_import_win(self):
+    def settings_import_win(self, fname=None):
         """
         Opens a file dialog to import a settings file in JSON format. If a file is selected,
         it copies the file to the settings folder, adds it to the custom settings menu, 
@@ -4256,7 +4258,9 @@ class MainWindow(QtWidgets.QMainWindow):
         Returns:
             None
         """
-        fname, filter = QtWidgets.QFileDialog.getOpenFileName(self, 'Import settings file', '', "Settings files (*.json)")
+        if fname is None:
+            fname, filter = QtWidgets.QFileDialog.getOpenFileName(self, 'Import settings file', '', "Settings files (*.json)")
+    
         if fname:
             # copy to settings folder
             shutil.copy(fname, self.path_settings)
@@ -4335,8 +4339,12 @@ class MainWindow(QtWidgets.QMainWindow):
             None
         """
         fpath = event.mimeData().urls()[0].toLocalFile()
+        
         if os.path.splitext(fpath)[1] == '.cif':
             self.calc_ref_from_cif(fpath, open_pxrd=True)
+        
+        if os.path.splitext(fpath)[1] == '.json':
+            self.settings_import_win(fname=fpath)
 
     def keyReleaseEvent(self, event):
         """
@@ -4360,12 +4368,14 @@ class MainWindow(QtWidgets.QMainWindow):
         # set m to None if no modifier or only keypad modifier is pressed
         if m == QtCore.Qt.KeyboardModifier.NoModifier or m == QtCore.Qt.KeyboardModifier.KeypadModifier:
             m = None
-        elif m == QtCore.Qt.KeyboardModifier.AltModifier:
+        elif QtCore.Qt.KeyboardModifier.AltModifier in m:
             m = 'ALT'
-        elif m == QtCore.Qt.KeyboardModifier.ShiftModifier:
+        elif QtCore.Qt.KeyboardModifier.ShiftModifier in m:
             m = 'SHIFT'
-        elif m == QtCore.Qt.KeyboardModifier.ControlModifier:
+        elif QtCore.Qt.KeyboardModifier.ControlModifier in m:
             m = 'CTRL'
+        else:
+            print('Unrecognized modifier', m)
         
         # check if key and modifier combination exists in hotkey_dict
         k = QtGui.QKeySequence(k).toString()
@@ -4781,7 +4791,7 @@ class SliderWidget(QtWidgets.QFrame):
         """
         self.move(int((self.parent().size().width()-self.box_width_dynamic)/2), self.parent().offset_win32)
 
-    def update_slider_label(self, label, value):
+    def update_slider_value(self, label, value):
         """
         Updates the text of a given label to reflect the provided slider value.
 
@@ -4792,7 +4802,8 @@ class SliderWidget(QtWidgets.QFrame):
         Returns:
             None
         """
-        label.setText(str(int(value)))
+        label.setValue(int(value))
+        self.box_toggle = True
 
     def update_slider_limits(self, slider, lmin, lmax):
         """
@@ -4823,10 +4834,10 @@ class SliderWidget(QtWidgets.QFrame):
         font = QtGui.QFont()
         font.setPixelSize(self.parent().plo.slider_label_size)
 
-        label_name = QtWidgets.QLabel(label)
-        label_name.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter)
-        label_name.setFont(font)
-        label_name.setStyleSheet(f'''
+        slider_name = QtWidgets.QLabel(label)
+        slider_name.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter)
+        slider_name.setFont(font)
+        slider_name.setStyleSheet(f'''
             QLabel {{
                 color: {self.parent().slider_label_color.name(format=QtGui.QColor.NameFormat.HexArgb)};
                 border: 0px solid none;
@@ -4834,11 +4845,13 @@ class SliderWidget(QtWidgets.QFrame):
             }}
         ''')
         
-        label_value = QtWidgets.QLabel()
-        label_value.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter)
-        label_value.setFont(font)
-        label_value.setText(str(int(lval)))
-        label_value.setStyleSheet(f'''
+        slider_value = QtWidgets.QSpinBox()
+        slider_value.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter)
+        slider_value.setRange(int(lmin), int(lmax))
+        slider_value.setButtonSymbols(QtWidgets.QAbstractSpinBox.ButtonSymbols.NoButtons)
+        slider_value.setFont(font)
+        slider_value.setValue(int(lval))
+        slider_value.setStyleSheet(f'''
             QLabel {{
                 color: {self.parent().slider_label_color.name(format=QtGui.QColor.NameFormat.HexArgb)};
                 border: 0px solid transparent;
@@ -4851,14 +4864,16 @@ class SliderWidget(QtWidgets.QFrame):
         slider.setSingleStep(int(lstp))
         slider.setPageStep(int(lstp))
         slider.setValue(int(lval))
+
         slider.valueChanged.connect(self.parent().update_screen)
-        slider.valueChanged.connect(lambda value: self.update_slider_label(label_value, value))
+        slider.valueChanged.connect(lambda value: self.update_slider_value(slider_value, value))
+        slider_value.valueChanged.connect(lambda value: self.update_slider_value(slider, value))
 
-        layout.addWidget(label_name, 0, idx, QtCore.Qt.AlignmentFlag.AlignCenter)
+        layout.addWidget(slider_name, 0, idx, QtCore.Qt.AlignmentFlag.AlignCenter)
         layout.addWidget(slider, 1, idx, QtCore.Qt.AlignmentFlag.AlignHCenter)
-        layout.addWidget(label_value, 2, idx, QtCore.Qt.AlignmentFlag.AlignCenter)
+        layout.addWidget(slider_value, 2, idx, QtCore.Qt.AlignmentFlag.AlignCenter)
 
-        return slider#(slider, label_name, label_value)
+        return slider#(slider, slider_name, slider_value)
 
     def toggle_panel(self, event):
         """
@@ -4989,7 +5004,7 @@ class HotkeyDialog(QtWidgets.QDialog):
             **kwargs: Arbitrary keyword arguments.
         """
         super().__init__(parent)
-
+        self.hotkeys = kwargs.get('hotkeys', True)
         self.setWindowFlags(QtCore.Qt.WindowType.Dialog)
         #self.setWindowFlags(QtCore.Qt.WindowType.Tool)
         #self.setWindowModality(QtCore.Qt.WindowModality.NonModal)
@@ -5023,7 +5038,9 @@ class HotkeyDialog(QtWidgets.QDialog):
         pressed key is the Escape key. If the Escape key is pressed, the widget
         will be closed.
         """
-        self.parent().keyReleaseEvent(event)
+        if self.hotkeys:
+            self.parent().keyReleaseEvent(event)
+        
         k = event.key()
         if k == QtCore.Qt.Key.Key_Escape:
             self.close()

{xrdplanner-2.4.0 → xrdplanner-2.4.2}/xrdPlanner.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: xrdPlanner
-Version: 2.4.0
+Version: 2.4.2
 Summary: A tool to project X-ray diffraction cones on a detector screen at different geometries (tilt, rotation, offset) and X-ray energies
 Author-email: Lennard Krause <lkrause@chem.au.dk>
 Project-URL: Homepage, https://github.com/LennardKrause/xrdPlanner
@@ -19,9 +19,10 @@ Requires-Dist: pyqtgraph>=0.13
 Requires-Dist: Dans_Diffraction>=2.2.3
 Requires-Dist: PyQt6>=6.5
 Requires-Dist: pyFAI>=2023.5
+Dynamic: license-file
 
 # xrdPlanner
-## Version 2.4.0 (released 04.03.2025)
+## Version 2.4.1 (released 05.03.2025)
 #### A tool to project X-ray diffraction cones on a detector screen at different geometries (tilt, rotation, offset) and X-ray energies
  - Article published in [_J. Synchrotron Rad._ (2024). **31**](https://doi.org/10.1107/S1600577523011086).
  - Main application is to visualize the maximum achievable resolution at a given geometry.
@@ -121,7 +122,10 @@ where $SDD$ is the sample to detector distance.
 > - A new parameter was added to allow for detector screen padding (plo.plot_padding), default is 0.
 
 ## Latest updates:
-  - 2025-03-04 Update: Added pxrd ghost lines to play with and compare the scattering using different parameters.
+  - 2025-03-05 Update: The slider values now accept input (thanks Clemens and Guðrún).
+  - 2025-03-05 Bugfix: Windows that allow typing will now disregard hotkeys.
+  - 2025-03-04 Update: Allowed smaller pixels in the detector-db editor (thanks tjalb).
+  - 2025-03-04 Update: Added pxrd ghost lines to play with and compare the scattering using different parameters (they are not perfect, don't scare them away!).
   - 2025-03-04 Update: Made some improvements to the highlighting.
   - 2025-03-04 Update: Trained most sub-windows to remember their place.
   - 2025-03-04 Update: Started to declutter the code.