kshana 0.33.0

Open, reproducible PNT-resilience simulator with quantum-sensor performance models
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

// SPDX-License-Identifier: AGPL-3.0-only
//! Shared SVG charting helpers used by the per-pack chart renderers.

use crate::palette::chart::{AXIS, BG, FONT_SANS, GRID, INK_2, MUTED};

/// Format a y-axis tick value at a precision sensible for its magnitude.
fn fmt_tick(v: f64) -> String {
    let a = v.abs();
    if a == 0.0 {
        "0".to_string()
    } else if a >= 10.0 {
        format!("{v:.0}")
    } else if a >= 1.0 {
        format!("{v:.1}")
    } else {
        format!("{v:.2}")
    }
}

/// SVG for a labelled y-axis: five horizontal gridlines from 0 to `y_max` with
/// numeric tick labels, plus a rotated axis title. The plot area starts at
/// (`ml`, `mt`) and spans `pw` × `ph` pixels. Emit this after the background and
/// before the data polylines so the gridlines sit behind the data.
pub fn y_axis(ml: f64, mt: f64, pw: f64, ph: f64, y_max: f64, title: &str) -> String {
    let mut s = String::new();
    let ticks = 4;
    for i in 0..=ticks {
        let frac = i as f64 / ticks as f64;
        let y = mt + ph - frac * ph;
        let val = y_max * frac;
        s.push_str(&format!(
            "<line x1=\"{ml:.0}\" y1=\"{y:.1}\" x2=\"{:.0}\" y2=\"{y:.1}\" stroke=\"{GRID}\"/>",
            ml + pw
        ));
        s.push_str(&format!(
            "<text x=\"{:.0}\" y=\"{:.1}\" text-anchor=\"end\" fill=\"{MUTED}\" font-size=\"11\">{}</text>",
            ml - 6.0,
            y + 4.0,
            fmt_tick(val)
        ));
    }
    let yc = mt + ph / 2.0;
    s.push_str(&format!(
        "<text x=\"16\" y=\"{yc:.1}\" text-anchor=\"middle\" fill=\"{MUTED}\" font-size=\"12\" transform=\"rotate(-90 16 {yc:.1})\">{title}</text>"
    ));
    s
}

/// Opening of a dark two-panel chart: the `<svg>` element, its background, a bold title
/// and a one-line subtitle. Both strings are written verbatim, so any markup in them must
/// already be escaped.
pub fn frame_open(w: f64, h: f64, title: &str, subtitle: &str) -> String {
    format!(
        "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"{w:.0}\" height=\"{h:.0}\" \
         font-family=\"{FONT_SANS}\" font-size=\"12\" fill=\"{INK_2}\">\
         <rect width=\"{w:.0}\" height=\"{h:.0}\" fill=\"{BG}\"/>\
         <text x=\"24\" y=\"24\" font-size=\"15\" font-weight=\"bold\">{title}</text>\
         <text x=\"24\" y=\"40\" font-size=\"11\" fill=\"{MUTED}\">{subtitle}</text>"
    )
}

/// A panel's caption, set 8 px above its top-left corner, and its left and bottom axis
/// lines. The panel's left edge is `x`, it spans `width`, and its axes run from `top`
/// down to `bottom`.
pub fn panel_axes(x: f64, top: f64, width: f64, bottom: f64, caption: &str) -> String {
    format!(
        "<text x=\"{x:.0}\" y=\"{:.0}\" font-size=\"12\" fill=\"{MUTED}\">{caption}</text>\
         <line x1=\"{x:.0}\" y1=\"{top:.0}\" x2=\"{x:.0}\" y2=\"{bottom:.0}\" stroke=\"{AXIS}\"/>\
         <line x1=\"{x:.0}\" y1=\"{bottom:.0}\" x2=\"{:.0}\" y2=\"{bottom:.0}\" stroke=\"{AXIS}\"/>",
        top - 8.0,
        x + width
    )
}