modified: Cargo.lock

modified: Cargo.toml modified: README.md modified: assets/favicon.ico modified: assets/icon-1024.png modified: assets/icon-256.png modified: assets/icon_ios_touch_192.png modified: assets/maskable_icon_x512.png modified: assets/sw.js modified: index.html modified: src/app.rs modified: src/app_web.rs modified: src/histoer/histogram1d.rs modified: src/histoer/histogrammer.rs modified: src/histoer/plot_settings.rs modified: src/lib.rs modified: src/main.rs modified: src/pane.rs
alconley · Jun 6, 2024 · cd092f0 · cd092f0
1 parent 28381fd
commit cd092f0
Show file tree

Hide file tree

Showing 18 changed files with 108 additions and 52 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "muc"
+name = "nat"
 version = "0.1.0"
 authors = ["Alex Conley <[email protected]>"]
 edition = "2021"

diff --git a/README.md b/README.md
@@ -1,8 +1,22 @@
-# muc
+# Nuclear Analysis Tool (NAT)
+
+The Nuclear Analysis Tool (NAT) is a comprehensive software designed for nuclear data analysis. It provides functionalities for histogramming, Gaussian fitting, and interactive data visualization using `egui` and `egui_plot` crates.
+
+## Features
+
+- Create and manage histograms
+- Fit Gaussian peaks
+- Interactive data visualization
+- Export and import fits
+- Customizable plot settings
 
 ### Testing locally
 
-Make sure you are using the latest version of stable rust by running `rustup update`.
+Make sure you are using the latest version of stable rust by running `rustup update`. Rust is very easy to install on any computer. First, you'll need to install the Rust toolchain (compiler, cargo, etc). Go to the [Rust website](https://www.rust-lang.org/tools/install) and follow the instructions there.
+
+Then clone the respository recursively
+
+`git clone --recursive https://github.com/alconley/NAT.git`
 
 `cargo run --release`
 
@@ -13,3 +27,22 @@ On Linux you need to first run:
 On Fedora Rawhide you need to run:
 
 `dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel`
+
+## 1D Histogram 
+
+### Fitting
+Multiple gaussians can be fitted interactively similar to [hdtv](https://github.com/janmayer/hdtv).
+
+**Keybinds** 
+- P: Add Marker
+- B: Add Background Marker
+- R: Add Region Marker
+- -: Remove Marker Closest to Cursor
+- Delete: Remove All Markers and Temp Fits
+- G: Fit Background (Fit a linear background using the background markers)
+- F: Fit Gaussians (Fit gaussians at the peak markers within a specified region with a linear background)
+- S: Store Fit (Store the current fit as a permanent fit which can be saved and loaded later)
+- I: Toggle Stats
+- L: Toggle Log Y
+
+The idea is to put region markers around you peak of intrest. If there are multiple peaks in between the region markers, add the centroid approximately with the peak markers. The background will be calculated with a linear line. To manually select the background data, add the background markers. If no background markers are supplied, background markers will be put at the region markers. The fits can be stored, and then the user can save/load them by right clicking on the plot and going into the fit menu.
diff --git a/assets/favicon.ico b/assets/favicon.ico
diff --git a/assets/icon-1024.png b/assets/icon-1024.png
diff --git a/assets/icon-256.png b/assets/icon-256.png
diff --git a/assets/icon_ios_touch_192.png b/assets/icon_ios_touch_192.png
diff --git a/assets/maskable_icon_x512.png b/assets/maskable_icon_x512.png
diff --git a/assets/sw.js b/assets/sw.js
@@ -2,8 +2,8 @@ var cacheName = 'egui-template-pwa';
 var filesToCache = [
   './',
   './index.html',
-  './muc.js',
-  './muc_bg.wasm',
+  './NAT.js',
+  './NAT_bg.wasm',
 ];
 
 /* Start the service worker and cache all of the app's content */

diff --git a/index.html b/index.html
@@ -7,7 +7,7 @@
 
 <head>
     <!-- change this to your project name -->
-    <title>muc</title>
+    <title>NAT</title>
 
     <!-- config for our rust wasm binary. go to https://trunkrs.dev/assets/#rust for more customization -->
     <link data-trunk rel="rust" data-wasm-opt="2" />

diff --git a/src/app.rs b/src/app.rs
@@ -25,8 +25,9 @@ impl Default for NATApp {
         let workspacer = Workspacer::new();
         let processer = Processer::new();
 
-        let mut tabs = vec![];
-        tabs.push(tiles.insert_pane(Pane::Workspace(workspacer.clone())));
+        // let mut tabs = vec![];
+        // tabs.push(tiles.insert_pane(Pane::Workspace(workspacer.clone())));
+        let tabs = vec![tiles.insert_pane(Pane::Workspace(workspacer.clone()))];
 
         let root = tiles.insert_tab_tile(tabs);
 
@@ -101,7 +102,7 @@ impl eframe::App for NATApp {
         });
 
         egui::SidePanel::left("tree")
-            .max_width(300.0)
+            .max_width(200.0)
             .show_animated(ctx, self.side_panel_open, |ui| {
                 egui::global_dark_light_mode_buttons(ui);
 

diff --git a/src/app_web.rs b/src/app_web.rs
@@ -1,15 +1,15 @@
 use eframe::App;
 
 #[derive(serde::Deserialize, serde::Serialize, Debug, Default)]
-pub struct MUCApp {}
+pub struct NATApp {}
 
-impl MUCApp {
+impl NATApp {
     pub fn new(_cc: &eframe::CreationContext<'_>) -> Self {
         Self::default()
     }
 }
 
-impl App for MUCApp {
+impl App for NATApp {
     fn update(&mut self, ctx: &eframe::egui::Context, _frame: &mut eframe::Frame) {
         egui::CentralPanel::default().show(ctx, |ui| {
             ui.label("muc is not supported in the browser yet. Please run it natively.");

diff --git a/src/histoer/histogram1d.rs b/src/histoer/histogram1d.rs
@@ -5,11 +5,6 @@ use crate::fitter::fit_handler::{FitModel, Fits, Fitter};
 
 use super::plot_settings::EguiPlotSettings;
 
-// background_fit_line: DrawLine::new(true, egui::Color32::GREEN),
-// deconvoluted_fit_line: DrawLine::new(true, egui::Color32::from_rgb(255, 0, 255)),
-// convoluted_fit_line: DrawLine::new(true, egui::Color32::BLUE),
-// stored_fit_lines: DrawLine::new(true, egui::Color32::BLUE),
-
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub struct PlotSettings {
     #[serde(skip)]
@@ -325,6 +320,34 @@ impl Histogram {
         }
     }
 
+    // create a ui function to show the keybinds in the context menu
+    fn keybinds_ui(&mut self, ui: &mut egui::Ui) {
+        ui.menu_button("Keybind Help", |ui| {
+            egui::ScrollArea::vertical()
+            .id_source("keybinds_scroll")
+            .max_height(300.0)
+            .show(ui, |ui| {
+                ui.heading("Keybinds");
+                ui.separator();
+                ui.label("Markers");
+                ui.label("P: Add Marker");
+                ui.label("B: Add Background Marker");
+                ui.label("R: Add Region Marker");
+                ui.label("-: Remove Marker Closest to Cursor");
+                ui.label("Delete: Remove All Markers and Temp Fits");
+                ui.separator();
+                ui.label("Fitting");
+                ui.label("G: Fit Background").on_hover_text("Fit a linear background using the background markers");
+                ui.label("F: Fit Gaussians").on_hover_text("Fit gaussians at the peak markers give some region with a linear background");
+                ui.label("S: Store Fit").on_hover_text("Store the current fit as a permanent fit which can be saved and loaded later");
+                ui.separator();
+                ui.label("Plot");
+                ui.label("I: Toggle Stats");
+                ui.label("L: Toggle Log Y");
+            });
+        });
+    }
+
     // Draw the histogram, fit lines, markers, and stats
     fn draw(&mut self, plot_ui: &mut egui_plot::PlotUi) {
         // update the histogram and fit lines with the log setting and draw
@@ -354,6 +377,7 @@ impl Histogram {
         self.line.menu_button(ui);
         self.plot_settings.settings_ui(ui);
         self.fits.fit_context_menu_ui(ui);
+        self.keybinds_ui(ui);
     }
 
     // Renders the histogram using egui_plot

diff --git a/src/histoer/histogrammer.rs b/src/histoer/histogrammer.rs
@@ -222,7 +222,8 @@ impl Histogrammer {
         let mut panes = vec![];
 
         for hist in &self.histograms1d {
-            panes.push(Pane::Histogram(hist.clone()));
+            // panes.push(Pane::Histogram(hist.clone()));
+            panes.push(Pane::Histogram(Box::new(hist.clone())));
         }
 
         panes

diff --git a/src/histoer/plot_settings.rs b/src/histoer/plot_settings.rs
@@ -118,14 +118,12 @@ impl EguiPlotSettings {
             plot
         };
 
-        let plot = if log_y {
+        if log_y {
             plot.y_grid_spacer(log_axis_spacer)
                 .y_axis_formatter(log_axis_formatter)
         } else {
             plot
-        };
-
-        plot
+        }
     }
 }
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -25,4 +25,4 @@ pub mod tree;
 #[cfg(target_arch = "wasm32")]
 mod app_web;
 #[cfg(target_arch = "wasm32")]
-pub use app_web::MUCApp;
+pub use app_web::NATApp;
diff --git a/src/main.rs b/src/main.rs
@@ -1,6 +1,6 @@
 #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
 
-use muc::NATApp;
+use nat::NATApp;
 
 use eframe::egui;
 
@@ -20,13 +20,12 @@ fn main() -> eframe::Result<()> {
         ..Default::default()
     };
     eframe::run_native(
-        "muc",
+        "NAT",
         native_options,
         Box::new(|cc| Box::new(NATApp::new(cc))),
     )
 }
 
-
 // When compiling to web using trunk:
 #[cfg(target_arch = "wasm32")]
 fn main() {
@@ -40,9 +39,9 @@ fn main() {
             .start(
                 "NAT", // hardcode it
                 web_options,
-                Box::new(|cc| Box::new(muc::app::new(cc))),
+                Box::new(|cc| Box::new(NATApp::new(cc))),
             )
             .await
             .expect("failed to start eframe");
     });
-}
+}
diff --git a/src/pane.rs b/src/pane.rs
@@ -5,7 +5,7 @@ use crate::workspacer::Workspacer;
 #[derive(Clone, serde::Serialize, serde::Deserialize)]
 pub enum Pane {
     Workspace(Workspacer),
-    Histogram(Histogram),
+    Histogram(Box<Histogram>),
     Histogram2D(Histogram2D),
 }