Class MatVisualizer<TWaveformView>

Namespace

Bonsai.Dsp.Design

Assembly

Bonsai.Dsp.Design.dll

Provides a base class for displaying data as a waveform graph.

public class MatVisualizer<TWaveformView> : BufferedVisualizer where TWaveformView : WaveformView, new()

Type Parameters

TWaveformView

A type derived from WaveformView which will control how data is displayed.

Inheritance

object

DialogTypeVisualizer

BufferedVisualizer

MatVisualizer<TWaveformView>

Derived

MatVisualizer

SpikeWaveformCollectionVisualizer<TWaveformView>

Inherited Members

BufferedVisualizer.Visualize(IObservable<IObservable<object>>, IServiceProvider)

BufferedVisualizer.Show(DateTime, object)

DialogTypeVisualizer.SequenceCompleted()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

AutoScaleX

Gets or sets a value indicating whether to compute the range of the x-axis automatically based on the range of the data that is included in the graph.

public bool AutoScaleX { get; set; }

Property Value

bool

AutoScaleY

Gets or sets a value indicating whether to compute the range of the y-axis automatically based on the range of the data that is included in the graph.

public bool AutoScaleY { get; set; }

Property Value

bool

ChannelOffset

Gets or sets a value which will be added to the samples of each channel, proportional to channel index, for the purposes of visualization.

public double ChannelOffset { get; set; }

Property Value

double

ChannelsPerPage

Gets or sets the maximum number of channels which should be included in a single page.

public int ChannelsPerPage { get; set; }

Property Value

int

Graph

Gets the graph control used to display the data.

protected TWaveformView Graph { get; }

Property Value

TWaveformView

HistoryLength

Gets or sets a value specifying how many previous data buffers to store and display in the graph.

public int HistoryLength { get; set; }

Property Value

int

Remarks

Each buffer can contain multiple samples, which means the total number of samples displayed in the graph will be HistoryLength * BufferLength, where BufferLength is the number of samples per buffer.

OverlayChannels

Gets or sets a value indicating whether to overlay the traces of all the channels in the page into a single waveform graph. If this value is false, channels will be displayed individually in separate graph panes.

public bool OverlayChannels { get; set; }

Property Value

bool

SelectedChannels

Gets or sets the indices of the channels to display when the visualizer is in overlay mode.

public int[] SelectedChannels { get; set; }

Property Value

int[]

SelectedPage

Gets or sets the currently selected channel page. Channels in the currently selected page will be the ones displayed in the graph.

public int SelectedPage { get; set; }

Property Value

int

TargetInterval

Gets or sets the target interval, in milliseconds, between visualizer updates.

protected override int TargetInterval { get; }

Property Value

int

WaveformBufferLength

Gets or sets a value specifying how many previous traces to overlay for each channel.

public int WaveformBufferLength { get; set; }

Property Value

int

Remarks

This allows overlaying historical traces rather than appending them in time.

XMax

Gets or sets the upper bound of the x-axis displayed in the graph.

public double XMax { get; set; }

Property Value

double

XMin

Gets or sets the lower bound of the x-axis displayed in the graph.

public double XMin { get; set; }

Property Value

double

YMax

Gets or sets the upper bound of the y-axis displayed in the graph.

public double YMax { get; set; }

Property Value

double

YMin

Gets or sets the lower bound of the y-axis displayed in the graph.

public double YMin { get; set; }

Property Value

double

Methods

Load(IServiceProvider)

Loads type visualizer resources using the specified service provider.

public override void Load(IServiceProvider provider)

Parameters

provider IServiceProvider

A service provider object which can be used to obtain visualization, runtime inspection, or other editing services.

Show(object)

Updates the type visualizer to display the specified value object.

public override void Show(object value)

Parameters

value object

The value to visualize.

ShowBuffer(IList<Timestamped<object>>)

Updates the type visualizer with a new buffer of timestamped values.

protected override void ShowBuffer(IList<Timestamped<object>> values)

Parameters

values IList<Timestamped<object>>

A buffer of timestamped values where each timestamp indicates the time at which the value was received.

Unload()

Unloads all type visualizer resources.

public override void Unload()