Skip to content

Commit 8207420

Browse files
authored
Merge pull request #454 from open-ephys/issue-453
Document Rhs2116Trigger's input double as delay
2 parents ded8683 + 9aeb90e commit 8207420

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

OpenEphys.Onix1/Rhs2116StimulusTrigger.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,12 @@ public class Rhs2116StimulusTrigger : Sink<double>
2020
public string DeviceName { get; set; }
2121

2222
/// <summary>
23-
/// Start an electrical stimulus sequence.
23+
/// Start an electrical stimulus sequence with an optional hardware delay.
2424
/// </summary>
25-
/// <param name="source">A sequence of double values that start the stimulus sequence when received.</param>
25+
/// <param name="source">A sequence of double values that serve as a combined stimulus trigger and
26+
/// delay in microseconds. A value of 0 results in immediate stimulus delivery. A value of 100 results in
27+
/// stimulus delivery following a 100 microsecond delay. Delays are implemented in hardware and are
28+
/// exact. </param>
2629
/// <returns>A sequence of double values that is identical to <paramref name="source"/></returns>
2730
public override IObservable<double> Process(IObservable<double> source)
2831
{

0 commit comments

Comments
 (0)