Documentation for GPO trigger and stimulator reports #289
Conversation
|
@cjsha couple things I noticed;
|
- Add note GPO trigger on example workflow page
|
Also: - Add dotnet xrefmap in docfx.json so I can use `<xref:System.Double>`. - Remove include for now, the long-term solution will be to add a template. - Remove `Condition` operator from Headstage64GpoTrigger branch This node's unnecessary bc only True values trigger stimulus anyway.
|
Note to self: make sure the stimuli waveforms have reasonable parameters. |
|
Note to self: make sure there is note about 0.7.0 doesn't support hs 64 firmware version <0.4 |
| <onix1:DeviceAddress>256</onix1:DeviceAddress> | ||
| <onix1:Enable>true</onix1:Enable> | ||
| <onix1:DspCutoff>Off</onix1:DspCutoff> | ||
| <onix1:DspCutoff>Dsp146mHz</onix1:DspCutoff> |
There was a problem hiding this comment.
I think we should leave the DSP off for these workflows.
There was a problem hiding this comment.
Is it worth changing the default value in the node too?
public Rhd2164DspCutoff DspCutoff { get; set; } = Rhd2164DspCutoff.Dsp146mHz;
If so, I can spawn an issue in the bonsai-onix1 repo before resolving this.
| operator, the enumerated values appear in the `HasFlags`'s `Value` property's dropdown menu. Because `HasFlags`'s | ||
| `Value` is set to "Circle", its output is "True" when the selected `BreakoutButtonState` bit field contains the | ||
| "Circle" flag. | ||
| <xref:OpenEphys.Onix1.BreakoutButtonState> is selected from the |
There was a problem hiding this comment.
This link should be [Buttons](xref:OpenEphys.Onix1.BreakoutButtonState)
| "Circle" flag. | ||
| <xref:OpenEphys.Onix1.BreakoutButtonState> is selected from the | ||
| `DigitalInputDataFrame`. It is an enumerator with values that correspond to bit | ||
| positions of the breakout board's digital port. When this type is connected to a |
There was a problem hiding this comment.
I think this sentence can be simplified and we need to be careful when we use jargon (should we use it and is it used correctly). "type" is both not necessary and used incorrectly here.
Buttons is selected from the DigitalInputDataFrame and passed to a HasFlags operator, which filters the sequence based on the presence of particular button using the Value property's dropdown menu. In this case, HasFlags's Value is set to "Circle", so its
output is "True" when its input contains a "Circle" flag.
| operator emits a <xref:System.Double> determined by `Double`'s `Value` property | ||
| whenever it receives an item in its input sequence. Each double in the input | ||
| sequence received by <xref:OpenEphys.Onix1.Headstage64OpticalStimulatorTrigger> | ||
| triggers an optical stimulus. The value of the double determines the delay |
There was a problem hiding this comment.
value of the double determines the delay in microseconds, executed on the hardware,
| "Headstage64/Headstage64ElectricalStimulator". This links the | ||
| `Headstage64ElectricalStimulatorData` operator to the corresponding | ||
| configuration operator. Frames from this operators are saved to a file named | ||
| "estim_.csv" using a <xref:Bonsai.IO.CsvWriter>. |
| - Automatically commutates the tether if there is a proper commutator connection. | ||
| - Applies electrical stimulation triggered by pressing the breakout board's △ key. | ||
| - Applies optical stimulation triggered by pressing the breakout board's ◯ key. | ||
| - Applies either electrical or optical stimulation (depending on which stimulators |
There was a problem hiding this comment.
Just armed, enable determines if they produce frames.
Fix #286 Fix #287