Class WaveformScope

Namespace

OpenEphys.EphysVisualization.Design

Assembly

OpenEphys.EphysVisualization.Design.dll

Provides a sink that shows a sequence of channel-by-sample matrices as a live multi-channel waveform viewer.

[TypeVisualizer(typeof(WaveformScopeVisualizer))]
public class WaveformScope : WaveformScopeBuilder<Mat>, IExpressionBuilder

Inheritance

object

ExpressionBuilder

SingleArgumentExpressionBuilder

WaveformScopeBuilder

WaveformScopeBuilder<Mat>

WaveformScope

Implements

IExpressionBuilder

Inherited Members

WaveformScopeBuilder<Mat>.Build(IEnumerable<Expression>)

WaveformScopeBuilder.Timebase

WaveformScopeBuilder.RangeAmplitude

WaveformScopeBuilder.RangeHeatmap

WaveformScopeBuilder.ChannelHeight

WaveformScopeBuilder.FitChannels

WaveformScopeBuilder.Palette

WaveformScopeBuilder.CustomColor

WaveformScopeBuilder.CustomColorHtml

WaveformScopeBuilder.ShowHeatmap

WaveformScopeBuilder.ColorThreshold

WaveformScopeBuilder.ShowClipping

WaveformScopeBuilder.Maximized

WaveformScopeBuilder.Channels

SingleArgumentExpressionBuilder.ArgumentRange

ExpressionBuilder.ToString()

ExpressionBuilder.Unwrap(ExpressionBuilder)

ExpressionBuilder.GetWorkflowElement(ExpressionBuilder)

ExpressionBuilder.GetVisualizerElement(ExpressionBuilder)

ExpressionBuilder.GetVisualizerMappings(ExpressionBuilder)

ExpressionBuilder.FromWorkflowElement(object, ElementCategory)

ExpressionBuilder.GetElementDisplayName(Type)

ExpressionBuilder.GetElementDisplayName(object)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

Each row of a matrix is a channel and each column a sample. What is drawn is (sample - Offset) * Scale, in whatever unit that makes it, while clipping is checked on the samples as they arrive.

Properties

ColorGrouping

Gets or sets the number of neighboring channels sharing a color when grouping is enabled.

ColorGroupingEnabled

Gets or sets a value specifying whether neighboring channels share a color in groups of ColorGrouping.

HistorySize

Gets or sets the memory, in megabytes, given to the data retained behind the display.

Offset

Gets or sets the value subtracted from each sample before it is scaled.

SampleRate

Gets or sets the rate, in Hz, at which each channel is sampled.

SaturationHigh

Gets or sets the sample value at or above which a channel is marked as clipping, in the units the samples arrive in.

SaturationLow

Gets or sets the sample value at or below which a channel is marked as clipping, in the units the samples arrive in.

Scale

Gets or sets the factor each sample is multiplied by, after subtracting the offset, to give the value displayed.