teareduce 0.5.8__py3-none-any.whl → 0.6.0__py3-none-any.whl

teareduce/cleanest/reviewcosmicray.py

@@ -13,7 +13,14 @@ import tkinter as tk
 from tkinter import messagebox
 from tkinter import simpledialog
 
-from maskfill import maskfill
+try:
+    from maskfill import maskfill
+except ModuleNotFoundError as e:
+    raise ModuleNotFoundError(
+        "The 'teareduce.cleanest' module requires the 'ccdproc' and 'maskfill' packages. "
+        "Please install teareduce with the 'cleanest' extra dependencies: "
+        "`pip install teareduce[cleanest]`."
+    ) from e
 import matplotlib.pyplot as plt
 from matplotlib.backend_bases import key_press_handler
 from matplotlib.backends.backend_tkagg import FigureCanvasTkAgg, NavigationToolbar2Tk
@@ -21,15 +28,19 @@ import numpy as np
 from rich import print
 
 from .centerchildparent import center_on_parent
+from .definitions import DEFAULT_TK_WINDOW_SIZE_X
+from .definitions import DEFAULT_TK_WINDOW_SIZE_Y
 from .definitions import MAX_PIXEL_DISTANCE_TO_CR
 from .imagedisplay import ImageDisplay
 from .interpolation_a import interpolation_a
 from .interpolation_x import interpolation_x
 from .interpolation_y import interpolation_y
+from .trackedbutton import TrackedTkButton
 
 from ..imshow import imshow
 from ..sliceregion import SliceRegion2D
 from ..zscale import zscale
+from ..version import VERSION
 
 import matplotlib
 
@@ -42,6 +53,8 @@ class ReviewCosmicRay(ImageDisplay):
     def __init__(
         self,
         root,
+        root_width,
+        root_height,
         data,
         auxdata,
         cleandata_lacosmic,
@@ -52,6 +65,10 @@ class ReviewCosmicRay(ImageDisplay):
         last_dilation=None,
         last_npoints=None,
         last_degree=None,
+        last_maskfill_size=None,
+        last_maskfill_operator=None,
+        last_maskfill_smooth=None,
+        last_maskfill_verbose=None,
     ):
         """Initialize the review window.
 
@@ -59,6 +76,10 @@ class ReviewCosmicRay(ImageDisplay):
         ----------
         root : tk.Toplevel
             The parent Tkinter root window.
+        root_width : int
+            The width of the root window. The review window is scaled accordingly.
+        root_height : int
+            The height of the root window. The review window is scaled accordingly.
         data : 2D numpy array
             The original image data.
         auxdata : 2D numpy array or None
@@ -83,6 +104,14 @@ class ReviewCosmicRay(ImageDisplay):
             The last used number of points parameter for interpolation.
         last_degree : int or None, optional
             The last used degree parameter for interpolation.
+        last_maskfill_size : int or None, optional
+            The last used maskfill size parameter.
+        last_maskfill_operator : str or None, optional
+            The last used maskfill operator parameter.
+        last_maskfill_smooth : bool or None, optional
+            The last used maskfill smooth parameter.
+        last_maskfill_verbose : bool or None, optional
+            The last used maskfill verbose parameter.
 
         Methods
         -------
@@ -119,6 +148,10 @@ class ReviewCosmicRay(ImageDisplay):
         ----------
         root : tk.Toplevel
             The parent Tkinter root window.
+        factor_width : float
+            The scaling factor for the width of the review window.
+        factor_height : float
+            The scaling factor for the height of the review window.
         data : 2D numpy array
             The original image data.
         auxdata : 2D numpy array or None
@@ -139,19 +172,33 @@ class ReviewCosmicRay(ImageDisplay):
             Degree parameter for interpolation.
         npoints : int
             Number of points parameter for interpolation.
+        maskfill_size : int
+            The last used maskfill size parameter.
+        maskfill_operator : str
+            The last used maskfill operator parameter.
+        maskfill_smooth : bool
+            The last used maskfill smooth parameter.
+        maskfill_verbose : bool
+            The last used maskfill verbose parameter.
         last_dilation : int or None
             The last used dilation parameter employed after L.A.Cosmic
             detection.
         """
         self.root = root
-        self.root.title("Review Cosmic Rays")
+        self.root.title(f"Review Cosmic Rays (TEA version {VERSION})")
+        self.factor_width = root_width / DEFAULT_TK_WINDOW_SIZE_X
+        self.factor_height = root_height / DEFAULT_TK_WINDOW_SIZE_Y
         self.auxdata = auxdata
         if self.auxdata is not None:
             # self.root.geometry("1000x700+100+100")  # This does not work in Fedora
-            self.root.minsize(1000, 700)
+            window_width = int(1000 * self.factor_width + 0.5)
+            window_height = int(700 * self.factor_height + 0.5)
+            self.root.minsize(window_width, window_height)
         else:
-            # self.root.geometry("800x700+100+100")  # This does not work in Fedora
-            self.root.minsize(900, 700)
+            # self.root.geometry("900x700+100+100")  # This does not work in Fedora
+            window_width = int(900 * self.factor_width + 0.5)
+            window_height = int(700 * self.factor_height + 0.5)
+            self.root.minsize(window_width, window_height)
         self.root.update_idletasks()
         self.root.geometry("+100+100")
         self.data = data
@@ -164,6 +211,10 @@ class ReviewCosmicRay(ImageDisplay):
         self.first_plot = True
         self.degree = last_degree if last_degree is not None else 1
         self.npoints = last_npoints if last_npoints is not None else 2
+        self.maskfill_size = last_maskfill_size if last_maskfill_size is not None else 3
+        self.maskfill_operator = last_maskfill_operator if last_maskfill_operator is not None else "median"
+        self.maskfill_smooth = last_maskfill_smooth if last_maskfill_smooth is not None else True
+        self.maskfill_verbose = last_maskfill_verbose if last_maskfill_verbose is not None else False
         self.last_dilation = last_dilation
         # Make a copy of the original labels to allow pixel re-marking
         self.cr_labels_original = self.cr_labels.copy()
@@ -180,29 +231,74 @@ class ReviewCosmicRay(ImageDisplay):
 
     def create_widgets(self):
         """Create the GUI widgets for the review window."""
+        # Define instance of TrackedTkButton, that facilitates to show help information
+        # for each button displayed in the current application window.
+        tkbutton = TrackedTkButton(self.root)
+
         # Row 1 of buttons
         self.button_frame1 = tk.Frame(self.root)
         self.button_frame1.pack(pady=5)
-        self.ndeg_label = tk.Button(
-            self.button_frame1, text=f"Npoints={self.npoints}, Degree={self.degree}", command=self.set_ndeg
+        self.ndeg_label = tkbutton.new(
+            self.button_frame1,
+            text=f"Npoints={self.npoints}, Degree={self.degree}",
+            command=self.set_ndeg,
+            help_text="Set the Npoints and Degree parameters for interpolation.",
+            alttext="Npoints=?, Degree=?",
         )
         self.ndeg_label.pack(side=tk.LEFT, padx=5)
-        self.remove_crosses_button = tk.Button(self.button_frame1, text="remove all x's", command=self.remove_crosses)
+        self.maskfill_button = tkbutton.new(
+            self.button_frame1,
+            text="Maskfill params.",
+            command=self.set_maskfill_params,
+            help_text="Set the parameters for the maskfill method.",
+        )
+        self.maskfill_button.pack(side=tk.LEFT, padx=5)
+        self.remove_crosses_button = tkbutton.new(
+            self.button_frame1,
+            text="remove all x's",
+            command=self.remove_crosses,
+            help_text="Remove all cross marks from the image.",
+        )
         self.remove_crosses_button.pack(side=tk.LEFT, padx=5)
-        self.restore_cr_button = tk.Button(self.button_frame1, text="[r]estore CR data", command=self.restore_cr)
+        self.restore_cr_button = tkbutton.new(
+            self.button_frame1,
+            text="restore CR",
+            command=self.restore_cr,
+            help_text="Restore current cosmic ray pixels to their original values.",
+        )
         self.restore_cr_button.pack(side=tk.LEFT, padx=5)
         self.restore_cr_button.config(state=tk.DISABLED)
-        self.next_button = tk.Button(self.button_frame1, text="[c]ontinue", command=self.continue_cr)
+        self.next_button = tkbutton.new(
+            self.button_frame1,
+            text="[c]ontinue",
+            command=self.continue_cr,
+            help_text="Continue to the next cosmic ray.",
+        )
         self.next_button.pack(side=tk.LEFT, padx=5)
-        self.exit_button = tk.Button(self.button_frame1, text="[e]xit review", command=self.exit_review)
+        self.exit_button = tkbutton.new(
+            self.button_frame1,
+            text="[e]xit review",
+            command=self.exit_review,
+            help_text="Exit the cosmic ray review process.",
+        )
         self.exit_button.pack(side=tk.LEFT, padx=5)
 
         # Row 2 of buttons
         self.button_frame2 = tk.Frame(self.root)
         self.button_frame2.pack(pady=5)
-        self.interp_x_button = tk.Button(self.button_frame2, text="[x] interp.", command=self.interp_x)
+        self.interp_x_button = tkbutton.new(
+            self.button_frame2,
+            text="[x] interp.",
+            command=self.interp_x,
+            help_text="Perform X-interpolation for the current cosmic ray.",
+        )
         self.interp_x_button.pack(side=tk.LEFT, padx=5)
-        self.interp_y_button = tk.Button(self.button_frame2, text="[y] interp.", command=self.interp_y)
+        self.interp_y_button = tkbutton.new(
+            self.button_frame2,
+            text="[y] interp.",
+            command=self.interp_y,
+            help_text="Perform Y-interpolation for the current cosmic ray.",
+        )
         self.interp_y_button.pack(side=tk.LEFT, padx=5)
         # it is important to use lambda here to pass the method argument correctly
         # (avoiding the execution of the function at button creation time, which would happen
@@ -211,23 +307,51 @@ class ReviewCosmicRay(ImageDisplay):
         # the function is trying to deactivate the buttons before they are created, which
         # would lead to an error; in addition, since I have two buttons calling the same function
         # with different arguments, using lambda allows to differentiate them)
-        self.interp_s_button = tk.Button(
-            self.button_frame2, text="[s]urface interp.", command=lambda: self.interp_a("surface")
+        self.interp_s_button = tkbutton.new(
+            self.button_frame2,
+            text="[s]urface interp.",
+            command=lambda: self.interp_a("surface"),
+            help_text="Perform surface interpolation for the current cosmic ray.",
         )
         self.interp_s_button.pack(side=tk.LEFT, padx=5)
-        self.interp_d_button = tk.Button(self.button_frame2, text="me[d]ian", command=lambda: self.interp_a("median"))
+        self.interp_d_button = tkbutton.new(
+            self.button_frame2,
+            text="me[d]ian",
+            command=lambda: self.interp_a("median"),
+            help_text="Perform median interpolation for the current cosmic ray.",
+        )
         self.interp_d_button.pack(side=tk.LEFT, padx=5)
-        self.interp_m_button = tk.Button(self.button_frame2, text="[m]ean", command=lambda: self.interp_a("mean"))
+        self.interp_m_button = tkbutton.new(
+            self.button_frame2,
+            text="[m]ean",
+            command=lambda: self.interp_a("mean"),
+            help_text="Perform mean interpolation for the current cosmic ray.",
+        )
         self.interp_m_button.pack(side=tk.LEFT, padx=5)
-        self.interp_l_button = tk.Button(self.button_frame2, text="[l]acosmic", command=self.use_lacosmic)
+        self.interp_l_button = tkbutton.new(
+            self.button_frame2,
+            text="[l]acosmic",
+            command=self.use_lacosmic,
+            help_text="Use L.A.Cosmic interpolation for the current cosmic ray.",
+        )
         self.interp_l_button.pack(side=tk.LEFT, padx=5)
         if self.last_dilation is not None and self.last_dilation > 0:
             self.interp_l_button.config(state=tk.DISABLED)
         if self.cleandata_lacosmic is None:
             self.interp_l_button.config(state=tk.DISABLED)
-        self.interp_maskfill_button = tk.Button(self.button_frame2, text="mas[k]fill", command=self.use_maskfill)
+        self.interp_maskfill_button = tkbutton.new(
+            self.button_frame2,
+            text="mask[f]ill",
+            command=self.use_maskfill,
+            help_text="Perform maskfill interpolation for the current cosmic ray.",
+        )
         self.interp_maskfill_button.pack(side=tk.LEFT, padx=5)
-        self.interp_aux_button = tk.Button(self.button_frame2, text="[a]ux. data", command=self.use_auxdata)
+        self.interp_aux_button = tkbutton.new(
+            self.button_frame2,
+            text="[a]ux. data",
+            command=self.use_auxdata,
+            help_text="Use auxiliary data for interpolation of the current cosmic ray.",
+        )
         self.interp_aux_button.pack(side=tk.LEFT, padx=5)
         if self.auxdata is None:
             self.interp_aux_button.config(state=tk.DISABLED)
@@ -236,20 +360,53 @@ class ReviewCosmicRay(ImageDisplay):
         self.button_frame3 = tk.Frame(self.root)
         self.button_frame3.pack(pady=5)
         vmin, vmax = zscale(self.data)
-        self.vmin_button = tk.Button(self.button_frame3, text=f"vmin: {vmin:.2f}", command=self.set_vmin)
+        self.vmin_button = tkbutton.new(
+            self.button_frame3,
+            text=f"vmin: {vmin:.2f}",
+            command=self.set_vmin,
+            help_text="Set the minimum value for the display scale.",
+            alttext="vmin: ??",
+        )
         self.vmin_button.pack(side=tk.LEFT, padx=5)
-        self.vmax_button = tk.Button(self.button_frame3, text=f"vmax: {vmax:.2f}", command=self.set_vmax)
+        self.vmax_button = tkbutton.new(
+            self.button_frame3,
+            text=f"vmax: {vmax:.2f}",
+            command=self.set_vmax,
+            help_text="Set the maximum value for the display scale.",
+            alttext="vmax: ??",
+        )
         self.vmax_button.pack(side=tk.LEFT, padx=5)
-        self.set_minmax_button = tk.Button(self.button_frame3, text="minmax [,]", command=self.set_minmax)
+        self.set_minmax_button = tkbutton.new(
+            self.button_frame3,
+            text="minmax [,]",
+            command=self.set_minmax,
+            help_text="Set the display scale to the minimum and maximum data values.",
+        )
         self.set_minmax_button.pack(side=tk.LEFT, padx=5)
-        self.set_zscale_button = tk.Button(self.button_frame3, text="zscale [/]", command=self.set_zscale)
+        self.set_zscale_button = tkbutton.new(
+            self.button_frame3,
+            text="zscale [/]",
+            command=self.set_zscale,
+            help_text="Set the display scale using zscale.",
+        )
         self.set_zscale_button.pack(side=tk.LEFT, padx=5)
+        self.help_button = tkbutton.new(
+            self.button_frame3,
+            text="Help",
+            command=tkbutton.show_help,
+            help_text="Show help information for all buttons.",
+        )
+        self.help_button.pack(side=tk.LEFT, padx=5)
 
         # Figure
         if self.auxdata is not None:
-            self.fig, (self.ax_aux, self.ax) = plt.subplots(ncols=2, figsize=(11, 5.5), constrained_layout=True)
+            self.fig, (self.ax, self.ax_aux) = plt.subplots(
+                ncols=2, figsize=(11 * self.factor_width, 5.5 * self.factor_height), constrained_layout=True
+            )
         else:
-            self.fig, self.ax = plt.subplots(figsize=(9, 5.5), constrained_layout=True)
+            self.fig, self.ax = plt.subplots(
+                figsize=(9 * self.factor_width, 5.5 * self.factor_height), constrained_layout=True
+            )
         self.canvas = FigureCanvasTkAgg(self.fig, master=self.root)
         self.canvas.get_tk_widget().pack(padx=5, pady=5)
         # The next two instructions prevent a segmentation fault when pressing "q"
@@ -369,18 +526,66 @@ class ReviewCosmicRay(ImageDisplay):
         self.npoints = new_npoints
         self.ndeg_label.config(text=f"Npoints={self.npoints}, Degree={self.degree}")
 
+    def set_maskfill_params(self):
+        """Set the maskfill parameters."""
+        new_size = simpledialog.askinteger(
+            "Set Maskfill Size", "Enter Maskfill Size (odd integer >=1):", initialvalue=self.maskfill_size, minvalue=1
+        )
+        if new_size is None:
+            return
+        if new_size % 2 == 0:
+            messagebox.showerror("Input Error", "Maskfill size must be an odd integer.")
+            return
+        new_operator = simpledialog.askstring(
+            "Set Maskfill Operator",
+            "Enter Maskfill Operator ('median' or 'mean'):",
+            initialvalue=self.maskfill_operator,
+        )
+        if new_operator is None:
+            return
+        if new_operator not in ["median", "mean"]:
+            messagebox.showerror("Input Error", "Maskfill operator must be 'median' or 'mean'.")
+            return
+        smooth_str = simpledialog.askstring(
+            "Set Maskfill Smooth",
+            "Enter Maskfill Smooth ('True' or 'False'):",
+            initialvalue=str(self.maskfill_smooth),
+        )
+        if smooth_str is None:
+            return
+        smooth_str = smooth_str.strip().lower()
+        if smooth_str == "true":
+            new_smooth = True
+        elif smooth_str == "false":
+            new_smooth = False
+        else:
+            messagebox.showerror("Input Error", "Maskfill Smooth must be 'True' or 'False'.")
+            return
+        verbose_str = simpledialog.askstring(
+            "Set Maskfill Verbose",
+            "Enter Maskfill Verbose ('True' or 'False'):",
+            initialvalue=str(self.maskfill_verbose),
+        )
+        if verbose_str is None:
+            return
+        verbose_str = verbose_str.strip().lower()
+        if verbose_str == "true":
+            new_verbose = True
+        elif verbose_str == "false":
+            new_verbose = False
+        else:
+            messagebox.showerror("Input Error", "Maskfill Verbose must be 'True' or 'False'.")
+            return
+        self.maskfill_size = new_size
+        self.maskfill_operator = new_operator
+        self.maskfill_smooth = new_smooth
+        self.maskfill_verbose = new_verbose
+
     def set_buttons_after_cleaning_cr(self):
         """Set the state of buttons after cleaning a cosmic ray."""
+        self.disable_interpolation_buttons()
         self.restore_cr_button.config(state=tk.NORMAL)
         self.remove_crosses_button.config(state=tk.DISABLED)
-        self.interp_x_button.config(state=tk.DISABLED)
-        self.interp_y_button.config(state=tk.DISABLED)
-        self.interp_s_button.config(state=tk.DISABLED)
-        self.interp_d_button.config(state=tk.DISABLED)
-        self.interp_m_button.config(state=tk.DISABLED)
-        self.interp_l_button.config(state=tk.DISABLED)
-        self.interp_maskfill_button.config(state=tk.DISABLED)
-        self.interp_aux_button.config(state=tk.DISABLED)
 
     def interp_x(self):
         """Perform x-direction interpolation to clean a cosmic ray."""
@@ -388,6 +593,7 @@ class ReviewCosmicRay(ImageDisplay):
             messagebox.showerror("Input Error", "2*Npoints must be greater than Degree for x interpolation.")
             return
         print(f"X-interpolation of cosmic ray {self.cr_index}")
+        print(f"Interpolation parameters: Npoints={self.npoints}, Degree={self.degree}")
         interpolation_performed, xfit_all, yfit_all = interpolation_x(
             data=self.data,
             mask_fixed=self.mask_fixed,
@@ -410,6 +616,7 @@ class ReviewCosmicRay(ImageDisplay):
             messagebox.showerror("Input Error", "2*Npoints must be greater than Degree for y interpolation.")
             return
         print(f"Y-interpolation of cosmic ray {self.cr_index}")
+        print(f"Interpolation parameters: Npoints={self.npoints}, Degree={self.degree}")
         interpolation_performed, xfit_all, yfit_all = interpolation_y(
             data=self.data,
             mask_fixed=self.mask_fixed,
@@ -435,6 +642,7 @@ class ReviewCosmicRay(ImageDisplay):
             The interpolation method to use ('surface', 'median' or 'mean').
         """
         print(f"{method} interpolation of cosmic ray {self.cr_index}")
+        print(f'Interpolation parameters: Npoints={self.npoints}, method="{method}"')
         interpolation_performed, xfit_all, yfit_all = interpolation_a(
             data=self.data,
             mask_fixed=self.mask_fixed,
@@ -468,6 +676,12 @@ class ReviewCosmicRay(ImageDisplay):
     def use_maskfill(self):
         """Use maskfill cleaned data to clean a cosmic ray."""
         print(f"Maskfill interpolation of cosmic ray {self.cr_index}")
+        print(
+            f"Maskfill parameters: size={self.maskfill_size}, "
+            f"operator={self.maskfill_operator}, "
+            f"smooth={self.maskfill_smooth}, "
+            f"verbose={self.maskfill_verbose}"
+        )
         ycr_list, xcr_list = np.where(self.cr_labels == self.cr_index)
         mask = np.zeros(self.data.shape, dtype=bool)
         for iy, ix in zip(ycr_list, xcr_list):
@@ -475,9 +689,10 @@ class ReviewCosmicRay(ImageDisplay):
         smoothed_output, _ = maskfill(
             input_image=self.data,
             mask=mask,
-            size=3,
-            operator="median",
-            smooth=True,
+            size=self.maskfill_size,
+            operator=self.maskfill_operator,
+            smooth=self.maskfill_smooth,
+            verbose=self.maskfill_verbose,
         )
         for iy, ix in zip(ycr_list, xcr_list):
             self.data[iy, ix] = smoothed_output[iy, ix]
@@ -506,35 +721,21 @@ class ReviewCosmicRay(ImageDisplay):
         for iy, ix in zip(ycr_list, xcr_list):
             self.cr_labels[iy, ix] = 0
         print(f"Removed all pixels of cosmic ray {self.cr_index}")
-        self.remove_crosses_button.config(state=tk.DISABLED)
-        self.interp_x_button.config(state=tk.DISABLED)
-        self.interp_y_button.config(state=tk.DISABLED)
-        self.interp_s_button.config(state=tk.DISABLED)
-        self.interp_d_button.config(state=tk.DISABLED)
-        self.interp_m_button.config(state=tk.DISABLED)
-        self.interp_l_button.config(state=tk.DISABLED)
-        self.interp_aux_button.config(state=tk.DISABLED)
+        self.disable_interpolation_buttons()
         self.update_display()
 
     def restore_cr(self):
         """Restore all pixels of the current cosmic ray to their original values."""
         ycr_list, xcr_list = np.where(self.cr_labels == self.cr_index)
+        if len(xcr_list) == 0:
+            print(f"No pixels to restore for cosmic ray {self.cr_index}")
+            return
         for iy, ix in zip(ycr_list, xcr_list):
             self.data[iy, ix] = self.data_original[iy, ix]
             self.mask_fixed[iy, ix] = False
-            self.interp_x_button.config(state=tk.NORMAL)
-            self.interp_y_button.config(state=tk.NORMAL)
-            self.interp_s_button.config(state=tk.NORMAL)
-            self.interp_d_button.config(state=tk.NORMAL)
-            self.interp_m_button.config(state=tk.NORMAL)
-            if self.cleandata_lacosmic is not None:
-                if self.last_dilation is None or self.last_dilation == 0:
-                    self.interp_l_button.config(state=tk.NORMAL)
-            self.interp_maskfill_button.config(state=tk.NORMAL)
-            if self.auxdata is not None:
-                self.interp_aux_button.config(state=tk.NORMAL)
         print(f"Restored all pixels of cosmic ray {self.cr_index}")
         self.num_cr_cleaned -= 1
+        self.enable_interpolation_buttons()
         self.remove_crosses_button.config(state=tk.NORMAL)
         self.restore_cr_button.config(state=tk.DISABLED)
         self.update_display()
@@ -550,16 +751,7 @@ class ReviewCosmicRay(ImageDisplay):
             return  # important: do not remove (to avoid errors)
         self.first_plot = True
         self.restore_cr_button.config(state=tk.DISABLED)
-        self.interp_x_button.config(state=tk.NORMAL)
-        self.interp_y_button.config(state=tk.NORMAL)
-        self.interp_s_button.config(state=tk.NORMAL)
-        self.interp_d_button.config(state=tk.NORMAL)
-        self.interp_m_button.config(state=tk.NORMAL)
-        if self.cleandata_lacosmic is not None:
-            if self.last_dilation is None or self.last_dilation == 0:
-                self.interp_l_button.config(state=tk.NORMAL)
-        if self.auxdata is not None:
-            self.interp_aux_button.config(state=tk.NORMAL)
+        self.enable_interpolation_buttons()
         self.remove_crosses_button.config(state=tk.NORMAL)
         self.update_display()
 
@@ -624,25 +816,35 @@ class ReviewCosmicRay(ImageDisplay):
                 print(f"Pixel ({ix+1}, {iy+1}), with signal {self.data[iy, ix]}, marked as cosmic ray.")
             xcr_list, ycr_list = np.where(self.cr_labels == self.cr_index)
             if len(xcr_list) == 0:
-                self.interp_x_button.config(state=tk.DISABLED)
-                self.interp_y_button.config(state=tk.DISABLED)
-                self.interp_s_button.config(state=tk.DISABLED)
-                self.interp_d_button.config(state=tk.DISABLED)
-                self.interp_m_button.config(state=tk.DISABLED)
-                self.interp_l_button.config(state=tk.DISABLED)
-                self.interp_aux_button.config(state=tk.DISABLED)
+                self.disable_interpolation_buttons()
                 self.remove_crosses_button.config(state=tk.DISABLED)
             else:
-                self.interp_x_button.config(state=tk.NORMAL)
-                self.interp_y_button.config(state=tk.NORMAL)
-                self.interp_s_button.config(state=tk.NORMAL)
-                self.interp_d_button.config(state=tk.NORMAL)
-                self.interp_m_button.config(state=tk.NORMAL)
-                if self.cleandata_lacosmic is not None:
-                    if self.last_dilation is None or self.last_dilation == 0:
-                        self.interp_l_button.config(state=tk.NORMAL)
-                if self.auxdata is not None:
-                    self.interp_aux_button.config(state=tk.NORMAL)
+                self.enable_interpolation_buttons()
                 self.remove_crosses_button.config(state=tk.NORMAL)
             # Update the display to reflect the change
             self.update_display()
+
+    def disable_interpolation_buttons(self):
+        """Disable all interpolation buttons."""
+        self.interp_x_button.config(state=tk.DISABLED)
+        self.interp_y_button.config(state=tk.DISABLED)
+        self.interp_s_button.config(state=tk.DISABLED)
+        self.interp_d_button.config(state=tk.DISABLED)
+        self.interp_m_button.config(state=tk.DISABLED)
+        self.interp_l_button.config(state=tk.DISABLED)
+        self.interp_maskfill_button.config(state=tk.DISABLED)
+        self.interp_aux_button.config(state=tk.DISABLED)
+
+    def enable_interpolation_buttons(self):
+        """Enable all interpolation buttons."""
+        self.interp_x_button.config(state=tk.NORMAL)
+        self.interp_y_button.config(state=tk.NORMAL)
+        self.interp_s_button.config(state=tk.NORMAL)
+        self.interp_d_button.config(state=tk.NORMAL)
+        self.interp_m_button.config(state=tk.NORMAL)
+        if self.cleandata_lacosmic is not None:
+            if self.last_dilation is None or self.last_dilation == 0:
+                self.interp_l_button.config(state=tk.NORMAL)
+        self.interp_maskfill_button.config(state=tk.NORMAL)
+        if self.auxdata is not None:
+            self.interp_aux_button.config(state=tk.NORMAL)

teareduce/cleanest/trackedbutton.py

@@ -0,0 +1,73 @@
+#
+# Copyright 2025 Universidad Complutense de Madrid
+#
+# This file is part of teareduce
+#
+# SPDX-License-Identifier: GPL-3.0+
+# License-Filename: LICENSE.txt
+#
+
+"""Tracked button widget for the cleanest module."""
+
+import tkinter as tk
+from rich.console import Console
+
+console = Console()
+
+
+class TrackedTkButton:
+    """Class to create tracked Tkinter buttons with help text."""
+
+    def __init__(self, root):
+        """Initialize the TrackedTkButton instance.
+
+        Initializes an empty list to store button information.
+
+        Parameters
+        ----------
+        root : tk.Tk or tk.Frame
+            The parent widget where the help information about
+            the actions associated to each button will be displayed.
+        """
+        self.root = root
+        self.buttons_info = []
+
+    def new(self, parent, text, command, help_text, alttext=None, **kwargs):
+        """Create a Tkinter button with tracking information.
+
+        Parameters
+        ----------
+        parent : tk.Widget
+            The parent widget where the button will be placed.
+        text : str
+            The text to display on the button.
+        command : callable
+            The function to call when the button is pressed.
+        help_text : str
+            The help text associated with the button.
+        alttext : str, optional
+            Alternative text for the button.
+        **kwargs : dict
+            Additional keyword arguments to pass to the Tkinter Button constructor.
+
+        Returns
+        -------
+        button : tk.Button
+            The created Tkinter button.
+        """
+        button = tk.Button(parent, text=text, command=command, **kwargs)
+        self.buttons_info.append({"button": button, "text": text, "help_text": help_text, "alttext": alttext})
+        return button
+
+    def show_help(self):
+        """Display help information for all tracked buttons."""
+        console.rule("[bold red]Button Help Information[/bold red]")
+        for info in self.buttons_info:
+            if info["alttext"] is not None:
+                text = info["alttext"]
+            else:
+                text = info["text"]
+            # replace '[' by '\[' to avoid formatting issues
+            text = text.replace("[", "\\[")
+            console.print(f"[bold blue]{text}[/bold blue]: {info['help_text']}")
+        console.rule()

teareduce/version.py

@@ -9,7 +9,7 @@
 #
 """Module to define the version of the teareduce package."""
 
-VERSION = '0.5.8'
+VERSION = '0.6.0'
 
 
 def main():