siplot 0.4.0

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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

//! Headless wgpu readback proving a scalar image's **per-pixel alpha map**
//! (silx `ImageData.setAlphaData`, `ImageSpec::with_alpha_map`) is sampled per
//! pixel by the image shader, not as a single global alpha.
//!
//! A uniform scalar field (every texel maps through viridis to the same
//! saturated teal) fills the `x∈[0,20] y∈[0,20]` view. The alpha map is opaque
//! (`1.0`) for the left half of the columns (`col < width/2`) and fully
//! transparent (`0.0`) for the right half. Against the white data background the
//! left half must therefore stay teal while the right half composites away to
//! background — and a control render with NO alpha map must show teal on BOTH
//! halves, proving the right-half disappearance is the alpha map at work and not
//! the image being absent there.
//!
//! The discriminator is a per-column count of teal pixels (green-dominant and
//! saturated — distinct from the white background, black axes/text, and grey
//! grid, so chrome never registers), summed over the left third vs the right
//! third of the frame. Margin-independent, mirroring `tests/roi_band_unbounded_render.rs`.
//! Needs a GPU (real or software).

use std::cell::RefCell;
use std::rc::Rc;

use egui_kittest::Harness;
use egui_kittest::wgpu::{WgpuTestRenderer, create_render_state, default_wgpu_setup};
use siplot::egui;
use siplot::{Colormap, ImageSpec, PlotWidget, YAxis};

const W: usize = 400;
const H: usize = 300;

// Image grid (data extent x∈[0,WD] y∈[0,HD], origin (0,0), scale (1,1)).
const WD: u32 = 20;
const HD: u32 = 20;

/// A green-dominant, saturated pixel: the colormapped teal of the image. White
/// background, black axes/text and grey grid are all unsaturated or not
/// green-dominant, so only the image registers.
fn is_teal(px: &[u8]) -> bool {
    let (r, g, b) = (px[0] as i32, px[1] as i32, px[2] as i32);
    let mx = r.max(g).max(b);
    let mn = r.min(g).min(b);
    g >= r && g >= b && (mx - mn) > 60
}

/// `(teal pixels in the left third of the frame, teal pixels in the right third)`.
fn teal_left_right(raw: &[u8]) -> (u32, u32) {
    let (mut left, mut right) = (0u32, 0u32);
    for (i, px) in raw.chunks_exact(4).enumerate() {
        if is_teal(px) {
            let col = i % W;
            if col < W / 3 {
                left += 1;
            } else if col >= 2 * W / 3 {
                right += 1;
            }
        }
    }
    (left, right)
}

/// Render the uniform teal image filling the pinned view, optionally with a
/// per-pixel alpha map, and return the `(left-third, right-third)` teal counts.
fn render(alpha_map: Option<Vec<f32>>) -> (u32, u32) {
    render_after(alpha_map, None)
}

/// As [`render`], but after adding the image optionally apply a colormap
/// level edit (`set_active_image_levels`) — a re-upload path that rebuilds the
/// `ImageSpec` via `ImageSpec::scalar` and must restore the retained alpha map
/// (the `(-1, 2)` levels keep the uniform `0.5` texel at the mid teal, so the
/// detector is unchanged and only the alpha map's survival is under test).
fn render_after(alpha_map: Option<Vec<f32>>, relevel: Option<(f64, f64)>) -> (u32, u32) {
    let rs = create_render_state(default_wgpu_setup());
    siplot::install(&rs);

    let mut plot = PlotWidget::new(&rs, 0);

    // Uniform field: every texel = 0.5, viridis over [0,1] → the same mid teal
    // for the whole image, so any left/right difference is the alpha map alone.
    let data = vec![0.5f32; (WD * HD) as usize];
    let colormap = Colormap::viridis(0.0, 1.0);
    let mut spec = ImageSpec::scalar(WD, HD, &data, colormap);
    if let Some(am) = alpha_map.as_ref() {
        spec = spec.with_alpha_map(am);
    }
    plot.add_image_spec(spec);

    // The first added item is the active item, so a level edit re-uploads it.
    if let Some((vmin, vmax)) = relevel {
        assert!(
            plot.set_active_image_levels(vmin, vmax),
            "level edit must re-upload the active scalar image"
        );
    }

    // Pin the view to the image extent so the image fills the data area, and
    // drop the colormap colorbar — its viridis ramp would otherwise paint teal
    // in the right margin (chrome, alpha-independent) and pollute the count.
    plot.set_show_colorbar(false);
    plot.set_auto_reset_zoom(false);
    plot.set_graph_x_limits(0.0, WD as f64);
    plot.set_graph_y_limits(0.0, HD as f64, YAxis::Left);

    let app = Rc::new(RefCell::new(plot));
    let app_ui = app.clone();
    let renderer = WgpuTestRenderer::from_render_state(rs);
    let mut harness = Harness::builder()
        .with_size(egui::vec2(W as f32, H as f32))
        .with_pixels_per_point(1.0)
        .renderer(renderer)
        .build_ui(move |ui| {
            app_ui.borrow_mut().show(ui);
        });

    harness.step();
    harness.step();
    let image = harness.render().expect("headless wgpu render");
    teal_left_right(image.as_raw())
}

/// A row-major alpha map: opaque (`1.0`) for the left half of the columns
/// (`col < WD/2`), fully transparent (`0.0`) for the right half.
fn left_opaque_right_transparent() -> Vec<f32> {
    (0..(WD * HD))
        .map(|i| {
            let col = i % WD;
            if col < WD / 2 { 1.0 } else { 0.0 }
        })
        .collect()
}

#[test]
fn per_pixel_alpha_map_makes_only_the_masked_half_transparent() {
    let (masked_left, masked_right) = render(Some(left_opaque_right_transparent()));
    let (control_left, control_right) = render(None);

    // Control (no alpha map): the uniform image is opaque on BOTH halves.
    assert!(
        control_left > 200 && control_right > 200,
        "without an alpha map the uniform image must be teal on both halves: \
         left={control_left} right={control_right}"
    );

    // Masked: the left half (alpha=1) stays teal, matching the control's left.
    assert!(
        masked_left > 200,
        "the opaque (alpha=1) left half must stay teal: masked_left={masked_left}"
    );

    // Masked: the right half (alpha=0) composites away to background — no teal.
    assert_eq!(
        masked_right, 0,
        "the transparent (alpha=0) right half must show no teal (was {control_right} \
         when opaque): masked_right={masked_right}"
    );
}

#[test]
fn per_pixel_alpha_map_survives_a_level_edit_reupload() {
    // A colormap level edit re-uploads the image through `ImageSpec::scalar`
    // (which defaults the alpha map to `None`); the retained alpha map must be
    // restored via the single-owner `ImageDisplayAttrs::apply` so the masked
    // right half stays transparent after the re-upload — the regression guard
    // for the `RetainedItemData::Image` field-drop family extended to the map.
    let (masked_left, masked_right) =
        render_after(Some(left_opaque_right_transparent()), Some((-1.0, 2.0)));

    assert!(
        masked_left > 200,
        "after a re-upload the opaque left half must still be teal: masked_left={masked_left}"
    );
    assert_eq!(
        masked_right, 0,
        "after a re-upload the alpha map must still mask the right half: \
         masked_right={masked_right}"
    );
}