flow-plots 0.3.1

Package for drawing and interacting with plots in flow cytometry data
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

use crate::colormap::ColorMaps;
use crate::options::{AxisOptions, BasePlotOptions, PlotOptions};
use crate::plots::PlotType;
use derive_builder::Builder;

/// Options for density plots
///
/// Configuration for creating density plots, including base layout options,
/// axis configurations, and color map selection.
///
/// # Example
///
/// ```rust,no_run
/// use flow_plots::options::{DensityPlotOptions, BasePlotOptions};
/// use flow_plots::colormap::ColorMaps;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let options = DensityPlotOptions::new()
///     .base(BasePlotOptions::new().width(800u32).height(600u32).build()?)
///     .colormap(ColorMaps::Viridis)
///     .build()?;
/// # Ok(())
/// # }
/// ```
///
/// @deprecated The old PlotOptions struct has been removed. Use DensityPlotOptions with builder pattern instead.
#[derive(Builder, Clone, Debug)]
#[builder(setter(into, strip_option), default)]
pub struct DensityPlotOptions {
    /// Base plot options (layout, dimensions, etc.)
    #[builder(default)]
    pub base: BasePlotOptions,

    /// X-axis configuration
    #[builder(default)]
    pub x_axis: AxisOptions,

    /// Y-axis configuration
    #[builder(default)]
    pub y_axis: AxisOptions,

    /// Color map to use for density visualization
    #[builder(default = "ColorMaps::Viridis")]
    pub colormap: ColorMaps,

    /// Plot type (density, scatter, contour, etc.)
    #[builder(default)]
    pub plot_type: PlotType,

    /// Point size in pixels for scatter and density plots (0.1–4.0).
    /// For scatter: radius of each point; values below 0.5 draw single-pixel dots.
    /// For density: radius of each point's contribution to the heatmap.
    #[builder(default = "1.0")]
    pub point_size: f32,

    /// Contour line thickness in pixels (when plot_type is Contour)
    #[builder(default = "1.0")]
    pub contour_line_thickness: f32,

    /// Number of contour levels (when plot_type is Contour)
    #[builder(default = "5")]
    pub contour_level_count: u32,

    /// KDE bandwidth adjustment factor (when plot_type is Contour).
    /// Higher values = more smoothing. Default 1.0. Typical range 0.5–2.0.
    #[builder(default = "1.0")]
    pub contour_smoothing: f64,

    /// Draw scatter points outside contour regions as outliers (when plot_type is Contour)
    #[builder(default = "false")]
    pub draw_outliers: bool,

    /// Colors for discrete gate overlay (ScatterOverlay, ContourOverlay).
    /// gate_ids in data index into this slice. Default palette used if empty.
    #[builder(default)]
    pub gate_colors: Vec<(u8, u8, u8)>,

    /// Z-axis range for continuous coloring (ScatterColoredContinuous).
    /// If None, min/max of z_values is used.
    #[builder(default)]
    pub z_range: Option<(f32, f32)>,
}

impl Default for DensityPlotOptions {
    fn default() -> Self {
        Self {
            base: BasePlotOptions::default(),
            x_axis: AxisOptions::default(),
            y_axis: AxisOptions::default(),
            colormap: ColorMaps::Viridis,
            plot_type: PlotType::Density,
            point_size: 1.0,
            contour_line_thickness: 1.0,
            contour_level_count: 5,
            contour_smoothing: 1.0,
            draw_outliers: false,
            gate_colors: Vec::new(),
            z_range: None,
        }
    }
}

/// Default palette for gate overlay (green, orange, blue, etc.)
pub fn default_gate_colors() -> Vec<(u8, u8, u8)> {
    vec![
        (34, 139, 34),   // forest green
        (255, 165, 0),   // orange
        (31, 119, 180),  // blue
        (214, 39, 40),   // red
        (148, 103, 189), // purple
        (140, 86, 75),   // brown
        (227, 119, 194), // pink
        (127, 127, 127), // gray
    ]
}

impl PlotOptions for DensityPlotOptions {
    fn base(&self) -> &BasePlotOptions {
        &self.base
    }
}

impl DensityPlotOptions {
    /// Create a new builder for DensityPlotOptions
    pub fn new() -> DensityPlotOptionsBuilder {
        DensityPlotOptionsBuilder::default()
    }
}