Class PulseOnset

Namespace

Bonsai.PulsePal

Assembly

Bonsai.PulsePal.dll

Represents an operator that creates a sequence of custom pulse train onset times and voltages.

public class PulseOnset : Combinator<PulseOnset>

Inheritance

object

Combinator<PulseOnset>

PulseOnset

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Time

Gets or sets the pulse onset time, in seconds relative to the start of the pulse.

[Range(0, 3600)]
[Precision(4, 0.0001)]
public double Time { get; set; }

Property Value

double

Voltage

Gets or sets the pulse onset voltage, in volts.

[Range(-10, 10)]
[Precision(3, 0.001)]
public double Voltage { get; set; }

Property Value

double

Methods

Process()

Creates an observable sequence containing a single pulse train onset configured with the specified time and voltage.

public IObservable<PulseOnset> Process()

Returns

IObservable<PulseOnset>

A sequence containing the created PulseOnset object.

Process<TSource>(IObservable<TSource>)

Creates an observable sequence of pulse train onset times and voltages, where each pulse onset is emitted only when an observable sequence emits a notification.

public override IObservable<PulseOnset> Process<TSource>(IObservable<TSource> source)

Parameters

source IObservable<TSource>

The sequence containing the notifications used for emitting new pulse onset times and voltages.

Returns

IObservable<PulseOnset>

A sequence containing the created PulseOnset objects whenever the source emits notifications.

Type Parameters

TSource

The type of the elements in the source sequence.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.