siplot 0.4.1

silx-style scientific plotting for egui, rendered with wgpu
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

//! A table of per-ROI statistics over a plot item, mirroring silx
//! [`ROIStatsWidget`]: one row per region of interest with count / min / max /
//! mean / sum / integral, computed by the pure reductions in
//! [`crate::widget::roi_stats`] (`image_roi_stats` / `curve_roi_stats`).
//!
//! The rows are filled by [`PlotWidget::feed_roi_stats`] /
//! [`PlotWidget::show_roi_stats_widget`] from the active item's retained data,
//! so the table follows the active image / curve and the live ROI list. The
//! widget itself only renders the rows it was given, so the
//! row-building is GPU-free and unit-tested via
//! [`PlotWidget::feed_roi_stats`]'s helper.
//!
//! [`ROIStatsWidget`]: https://www.silx.org/doc/silx/latest/modules/gui/plot/roistatswidget.html
//! [`PlotWidget::feed_roi_stats`]: crate::widget::high_level::PlotWidget::feed_roi_stats
//! [`PlotWidget::show_roi_stats_widget`]: crate::widget::high_level::PlotWidget::show_roi_stats_widget

use crate::core::stats::ComCoord;
use crate::widget::roi_stats::RoiStats;
use crate::widget::stats_widget::format_stat;

/// Format a [`ComCoord`] for the stats table: `-` when undefined, the single
/// `x` for a curve coordinate, or `(x, y)` for an image coordinate. Each
/// component uses the shared [`format_stat`] significant-digit formatting.
fn format_coord(c: ComCoord) -> String {
    match (c.x, c.y) {
        (None, _) => "-".to_string(),
        (Some(_), None) => format_stat(c.x),
        (Some(_), Some(_)) => format!("({}, {})", format_stat(c.x), format_stat(c.y)),
    }
}

/// One ROI's row in the ROI-stats table: a display label plus the statistics
/// reduced over the item inside that ROI.
#[derive(Clone, Debug, PartialEq)]
pub struct RoiStatsRow {
    /// Display label for the ROI (its name, or `ROI {index}` when unnamed).
    pub label: String,
    /// Reduced statistics of the item's samples inside the ROI.
    pub stats: RoiStats,
}

/// A per-ROI statistics table (silx `ROIStatsWidget`).
///
/// Holds the rows computed from the active item + ROI list and renders them as
/// a grid: `ROI | N | min | max | mean | sum | integral`. Fill it via
/// [`PlotWidget::feed_roi_stats`] (or render+fill in one call with
/// [`PlotWidget::show_roi_stats_widget`]); [`Self::ui`] draws the current rows.
///
/// [`PlotWidget::feed_roi_stats`]: crate::widget::high_level::PlotWidget::feed_roi_stats
/// [`PlotWidget::show_roi_stats_widget`]: crate::widget::high_level::PlotWidget::show_roi_stats_widget
#[derive(Default)]
pub struct RoiStatsWidget {
    rows: Vec<RoiStatsRow>,
}

impl RoiStatsWidget {
    /// Create an empty ROI-stats table.
    pub fn new() -> Self {
        Self::default()
    }

    /// The current rows (one per ROI), as last filled.
    pub fn rows(&self) -> &[RoiStatsRow] {
        &self.rows
    }

    /// Replace the rows shown by the table (called by
    /// [`PlotWidget::feed_roi_stats`]).
    ///
    /// [`PlotWidget::feed_roi_stats`]: crate::widget::high_level::PlotWidget::feed_roi_stats
    pub fn set_rows(&mut self, rows: Vec<RoiStatsRow>) {
        self.rows = rows;
    }

    /// Render the ROI-stats table. Columns: `ROI | N | min | max | mean | sum |
    /// integral | COM | coord min | coord max` (silx ROIStatsWidget stat
    /// columns incl. `StatCOM`/`StatCoordMin`/`StatCoordMax`); numeric cells use
    /// the shared [`format_stat`] formatting (silx-style significant digits, `-`
    /// for an empty selection), coordinate cells use `format_coord`.
    pub fn ui(&mut self, ui: &mut egui::Ui) {
        egui::Grid::new("roi_stats_grid")
            .striped(true)
            .show(ui, |ui| {
                ui.strong("ROI");
                ui.strong("N");
                ui.strong("min");
                ui.strong("max");
                ui.strong("mean");
                ui.strong("sum");
                ui.strong("integral");
                ui.strong("COM");
                ui.strong("coord min");
                ui.strong("coord max");
                ui.end_row();

                for row in &self.rows {
                    ui.label(&row.label);
                    ui.label(row.stats.count.to_string());
                    ui.label(format_stat(row.stats.min));
                    ui.label(format_stat(row.stats.max));
                    ui.label(format_stat(row.stats.mean));
                    ui.label(format_stat(Some(row.stats.sum)));
                    ui.label(format_stat(Some(row.stats.integral)));
                    ui.label(format_coord(row.stats.com));
                    ui.label(format_coord(row.stats.coord_min));
                    ui.label(format_coord(row.stats.coord_max));
                    ui.end_row();
                }
            });
    }
}