Class MatrixReader

Namespace

Bonsai.Dsp

Assembly

Bonsai.Dsp.dll

Represents an operator that generates a sequence of signal sample buffers from the specified raw binary input stream.

public class MatrixReader : Source<Mat>

Inheritance

object

Source<Mat>

MatrixReader

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

BufferLength

Gets or sets the number of samples in each output buffer.

public int BufferLength { get; set; }

Property Value

int

ChannelCount

Gets or sets the number of channels in the stored signal.

public int ChannelCount { get; set; }

Property Value

int

Depth

Gets or sets the bit depth of each element in an output buffer.

public Depth Depth { get; set; }

Property Value

Depth

Layout

Gets or sets a value specifying the sequential memory layout used to store the sample buffers.

public MatrixLayout Layout { get; set; }

Property Value

MatrixLayout

Offset

Gets or sets the byte offset at which to start reading the raw binary file.

public long Offset { get; set; }

Property Value

long

Path

Gets or sets the identifier of the named stream from which to read the samples.

public string Path { get; set; }

Property Value

string

Remarks

If the identifier uses the named pipe prefix \.\pipe</code>, a corresponding NamedPipeClientStream object is created; otherwise a regular FileStream is used.

SampleRate

Gets or sets the sample rate of the stored signal, in Hz.

public int SampleRate { get; set; }

Property Value

int

Methods

Generate()

Generates an observable sequence of signal sample buffers from the specified raw binary input stream.

public override IObservable<Mat> Generate()

Returns

IObservable<Mat>

A sequence of Mat objects representing fixed-size buffers of samples from the signal stored in the specified file.

Generate<TSource>(IObservable<TSource>)

Generates an observable sequence of signal sample buffers from the specified raw binary input stream, where each new buffer is emitted only when an observable sequence emits a notification.

public IObservable<Mat> Generate<TSource>(IObservable<TSource> source)

Parameters

source IObservable<TSource>

The sequence containing the notifications used for emitting sample buffers.

Returns

IObservable<Mat>

A sequence of Mat objects representing fixed-size buffers of samples from the signal stored in the specified file.

Type Parameters

TSource

The type of the elements in the source sequence.