Struct Figure

pub struct Figure<'a> { /* private fields */ }

Creates a figure that will wait to receive samples, then draw them onto the plot.

Implementations

impl<'a> Figure<'a>

pub fn new(queue_size: usize) -> Self

Create a figure with default settings.

pub fn new_with_config(config: FigureConfig<'a>, queue_size: usize) -> Self

Create a figure from an existing configuration. Useful if you don’t want to use the builder pattern to initialize a figure from scratch.

pub fn xlim(self, xlim: [f32; 2]) -> Self

Sets the x min and max limits for plotting.

pub fn ylim(self, ylim: [f32; 2]) -> Self

Sets the y min and max limits for plotting.

pub fn xlabel(self, xlabel: &'a str) -> Self

Sets the x label to display.

pub fn ylabel(self, ylabel: &'a str) -> Self

Sets the y label to display.

pub fn color(self, r: u8, g: u8, b: u8) -> Self

Sets the color of the line to draw.

pub fn plot_type(self, plot_type: PlotType) -> Self

Sets the type of plot to generate.

pub fn should_close_window(&mut self) -> bool

Checks events to see if the figure should close or not. Returns true if the window received a close event, false otherwise. In most cases, you don’t need to handle events yourself; use Figure::display() instead.

pub fn plot_xy<T>(&mut self, points: &[(T, T)])

where T: Into<f32> + Copy,

Take an array of 2D points and draw them to the plot. This overrides any samples in the queue.

pub fn plot_y<T>(&mut self, y_coords: &[T])

where T: Into<f32> + Copy,

Takes a series of real samples and draws them onto the plot. This overrides any samples in the queue. The x-axis will be interpolated.

pub fn plot_stream<T>(&mut self, y_coords: &[T])

where T: Into<f32> + Copy,

Takes a series of real samples and draws them onto the plot. Samples received from the stream are appended to the queue and any samples exceeding the queue size are removed. The x-axis will be interpolated.

pub fn plot_complex_stream<T>(&mut self, points: &[Complex<T>])

where T: Into<f32> + Copy,

Takes a slice of complex samples and draws them onto the plot. Samples received from the stream are appended to the queue and any samples exceeding the queue size are removed.

pub fn plot_complex<T>(&mut self, coords: &[Complex<T>])

where T: Into<f32> + Copy,

Takes a slice of complex samples and draws them onto the plot. This overrides any existing samples in the queue.

pub fn display(figure: &mut Figure<'_>, plot_fn: impl FnMut(&mut Figure<'_>))

Hijacks the current thread to run the plotting and event loop.

Trait Implementations

impl<'a> Default for Figure<'a>

fn default() -> Figure<'a>

Returns the “default value” for a type.