Contributions:RHX - Revision history

Rlellis: /* Parameters */

2025-08-13T20:51:42Z

Parameters

← Older revision		Revision as of 20:51, 13 August 2025
Line 55:		Line 55:

	Phase 3 Duration: Specifies the duration for the third phase of stimulation. The expected format is the same as Trigger Delay. This parameter only needs to be defined for a triphasic waveform, otherwise can be left blank.		Phase 3 Duration: Specifies the duration for the third phase of stimulation. The expected format is the same as Trigger Delay. This parameter only needs to be defined for a triphasic waveform, otherwise can be left blank.

			Amp Settle End: Specifies the duration after the final phase of stimulation at which the amplifier settle circuitry is deactivated. The expected format is the same as Trigger Delay.

			Num Pulses: Specifies the number of stimulation pulses after a trigger event.

			Pulse Period: Specifies the period of the stimulation waveform. The trigger delay is not factored. For example, a biphasic waveform with a phase 1 duration of 100us, a phase 2 duration of 100us, and a pulse period of 300us will look like a biphasic waveform with a 100us delay following the second phase before repeating (regardless of the trigger delay).

			Post Stim Recovery Delay: Specifies the duration after the last phase of the final pulse at which the charge recovery circuitry will be activated. The expected format is the same as Trigger Delay.

			Post Stim Recovery Duration: Specifies the duration for which charge recovery will be active. The expected format is the same as Trigger Delay.

			Refractory Duration: Specifies the duration after either charge recovery is deactivated (if this charge recovery parameters were set), or after the end of stimulation (otherwise).

Rlellis: /* Parameters */

2025-08-13T20:04:55Z

Parameters

← Older revision		Revision as of 20:04, 13 August 2025
Line 24:		Line 24:
	SampleBlockSize: The API provided by Intan only reads data in chunks of 128. Therefore, values that are multiples of 128 must be used for this parameter.		SampleBlockSize: The API provided by Intan only reads data in chunks of 128. Therefore, values that are multiples of 128 must be used for this parameter.

	~~ConnectionType~~: ~~Determines type~~ of ~~connection~~ to be ~~used~~. For ~~devices with~~ a ~~XEM7310 module (which can be found via the connected device list given~~ in the ~~Intan RHX application or by looking at~~ the ~~specifications for~~ the ~~device in use)~~, ~~use ControllerStimRecord~~. ~~Otherwise~~, ~~depending on the USB connection~~, ~~choose USB2 or USB3~~.		RHSAmpChannels: A list of headtsage channels which will be recorded from. The value of the first channel on headstage A is taken to be 0, and the final channel on headstage D is taken to be 127. Accepted formats are of the following form:
			For a range of sequential channels, an input of "A-B" will result in the configuration being uploaded to channels A,A+1...B. For a single channel, one may simply input the channel number as "A".
			For channels that are not sequential, one may input "{A-B,C,D-E,..}". This will upload the configuration to channels A,A+1..B,C,D,D+1...E... . Lists of this form must use commas to separate channel values/ranges.

			For example, an entry of {0-8,32-35} will record from the first 9 channels on headstage A, and the first 4 channels on headstage B.



	Stimulation Configuration Parameters:		Stimulation Configuration Parameters (note: all text is case insensitive, and any non-applicable parameters can be left empty. Further, all values are rounded to multiples of the sampling period and stimulation step size!):

	Channels: Specifies the channels which the configuration applies to. ~~Accepted~~ formats are of the ~~following:~~		Channels: Specifies the channels which the configuration applies to. The accepted formats are the same as for RHSAmpChannels.
	~~For a range of sequential channels, an input of "A-B" will result in the configuration being uploaded to channels A,A+1...B. For a single channel, one may simply input the channel number~~ as ~~"A".~~
	For channels that are not sequential, one may input "{A-B,C,D-E,..}". This will upload the configuration to channels A,A+1..B,C,D,D+1...E... . Lists of this form must use commas to separate channel values/ranges.

	Trigger: Specifies the source which triggers stimulation. This can either be one of the digital or analog inputs, or a state. Accepted input is: "digx", "anax", or "state", where x is an integer between 1 and 8 (all independent of capitalization). If "state" is used, "State Trigger Value" must be specified.		Trigger: Specifies the source which triggers stimulation. This can either be one of the digital or analog inputs, or a state. Accepted input is: "digx", "anax", or "state", where x is an integer between 1 and 8 (all independent of capitalization). If "state" is used, "State Trigger Value" must be specified.

	State Trigger Value: If using a state as a trigger, this section determines the condition for the state to trigger stimulation.		Trigger State: The name of the expression to trigger stimulation. This does not necessarily have to be a state, for example the "KeyDown" is a valid entry. If not using a state trigger, this can be left empty.

			State Trigger Value: If using a state as a trigger, this section determines the condition for the state to trigger stimulation. If not, this can be left as empty.

			Edge/Level: Specifies whether stimulation is edge or level triggered. Supported entries are "edge" or "level".

			High/Low: Specifies whether stimulation is triggered on high or low. Supported entries are "high" or "low".

			Trigger Delay: Specifies the duration of time between the trigger and first phase of stimulation. The expected format is a value along with a unit, for example "10ms", "10 ms", "100 us". Accepted units are ns,us,ms,s. If no unit is provided, the default is us.

			Amp Settle Start: Specifies the time before the first phase of stimulation in which the amplifier settle circuitry is activated. This value must not exceed Trigger Delay. The expected format is the same as Trigger Delay.

			Phase 1 Duration: Specifies the duration for the first phase of stimulation. The expected format is the same as Trigger Delay.

			Phase 2 Duration: Specifies the duration for the second phase of stimulation. The expected format is the same as Trigger Delay.

			Phase 3 Duration: Specifies the duration for the third phase of stimulation. The expected format is the same as Trigger Delay. This parameter only needs to be defined for a triphasic waveform, otherwise can be left blank.

Rlellis: /* Synopsis */

2025-08-12T20:57:57Z

Synopsis

← Older revision		Revision as of 20:57, 12 August 2025
Line 7:		Line 7:
	The expansion board includes up to 16 digital input and output channels and 8 analog input (ADC) and output channels (DAC). The digital and analog outputs can be programmed for stimulation, and the data from the digital and analog inputs can be recorded.		The expansion board includes up to 16 digital input and output channels and 8 analog input (ADC) and output channels (DAC). The digital and analog outputs can be programmed for stimulation, and the data from the digital and analog inputs can be recorded.

	The digital input and output data is recorded in two streams ("DigIn" and "DigOut", respectively). These streams consist of 16 bit unsigned integers with each bit representing the logic input/output. These values are computed in MSb format, with the greatest bit being controlled by channel 0. For example, a logic pulse recorded by channel 0 would result in a value of 2^15 (=1000 0000 0000 0000), while a logic pulse recorded from channel 15 would result in a value of 2^0 (=0000 0000 0000 0001).		The digital input and output data are recorded in two streams ("DigIn" and "DigOut", respectively). These streams consist of 16 bit unsigned integers with each bit representing the logic input/output. These values are computed in MSb format, with the greatest bit being controlled by channel 0. For example, a logic pulse recorded by channel 0 would result in a value of 2^15 (=1000 0000 0000 0000), while a logic pulse recorded from channel 15 would result in a value of 2^0 (=0000 0000 0000 0001).

	Similarly, stimulation information from each headstage is recorded in the streams:		Similarly, stimulation information from each headstage is recorded in the streams:

Rlellis: /* Synopsis */

2025-08-12T20:57:36Z

Synopsis

← Older revision		Revision as of 20:57, 12 August 2025
Line 1:		Line 1:
	==Synopsis==		==Synopsis==

	The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which ~~sends data to a FPGA. These ports communicate with the chips located on supported headstages. Each port has four output signals responsible for communication with the amplifier chips~~, ~~two of which (MISO1~~,~~MISO2) are used to transmit~~ data. Each chip controls 16 channels, ~~and each chip transmits data over a single MISO line~~. Over all four ports, ~~this means there are~~ 8 ~~lines over which data~~ can be ~~sent~~.		The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which can program, stimulate, and record data from connected RHS chips. Each chip controls 16 channels, with up to two chips per port. Over all four ports, a total of 8 chips (128 channels) can be simultaneously controlled.
	<gallery mode="packed" widths=75px heights=75px>		<gallery mode="packed" widths=75px heights=75px>
	File:Intanheadstage.jpg\|RHS2116 Amplifier chip on 32 channel headstage		File:Intanheadstage.jpg\|RHS2116 Amplifier chip on 32 channel headstage
	</gallery>		</gallery>
	~~Attatched~~ to ~~the FPGA is an Opal Kelly XEM6010 USB/FPGA interface which~~ can be ~~used to read~~ data in the ~~FPGA via USB~~. ~~This module has 128MByte SDRAM~~		The expansion board includes up to 16 digital input and output channels and 8 analog input (ADC) and output channels (DAC). The digital and analog outputs can be programmed for stimulation, and the data from the digital and analog inputs can be recorded.

			The digital input and output data is recorded in two streams ("DigIn" and "DigOut", respectively). These streams consist of 16 bit unsigned integers with each bit representing the logic input/output. These values are computed in MSb format, with the greatest bit being controlled by channel 0. For example, a logic pulse recorded by channel 0 would result in a value of 2^15 (=1000 0000 0000 0000), while a logic pulse recorded from channel 15 would result in a value of 2^0 (=0000 0000 0000 0001).

			Similarly, stimulation information from each headstage is recorded in the streams:
			"HeadstageAStim": The bit for the corresponding channel is set to 1 if stimulating, 0 otherwise.
			"HeadstageAChargeRecov": The bit for the corresponding channel is set to 1 if charge recovery is active, 0 otherwise
			"HeadstageAStimPol": The bit for the corresponding channel is set to 1 if the stimulation current is positive, 0 if negative or inactive
			"HeadstageAAmpSettle": The bit for the corresponding channel is set to 1 if the amplifier settle circuitry is active, 0 otherwise.
			... (Repeated for headstages A-D)

			Each of these streams contains a 32 bit unsigned integer, with a similar format to the "DigIn" and "DigOut" streams--for example, if channel 0 on headstage A is currently stimulating, a value of 2^31 will be recorded to "HeadstageAStim", and if channel 31 on headstage A is currently stimulating a value of 2^0 will be recorded to "HeadstageAStim".

	==Parameters==		==Parameters==

Rlellis: /* Parameters */

2025-06-18T20:06:43Z

Parameters

@@ Line 19: / Line 19: @@
-~To be added~
+Stimulation Configuration Parameters:
-Trigger parameters:
+Channels: Specifies the channels which the configuration applies to. Accepted formats are of the following:
-TriggerEnable: enables or disables the trigger function
+Trigger: Specifies the source which triggers stimulation. This can either be one of the digital or analog inputs, or a state. Accepted input is: "digx", "anax", or "state", where x is an integer between 1 and 8 (all independent of capitalization). If "state" is used, "State Trigger Value" must be specified.
-TriggerType: Edge triggered: triggers stimulation upon change from inactive to active state. Level triggered: repeats stimulation while in an active state (i.e. can activate multiple times while the trigger condition is met, without needing to switch)
+State Trigger Value: If using a state as a trigger, this section determines the condition for the state to trigger stimulation.

Rlellis: /* Parameters */

2024-09-06T17:43:06Z

Parameters

← Older revision		Revision as of 17:43, 6 September 2024
Line 15:		Line 15:

	ConnectionType: Determines type of connection to be used. For devices with a XEM7310 module (which can be found via the connected device list given in the Intan RHX application or by looking at the specifications for the device in use), use ControllerStimRecord. Otherwise, depending on the USB connection, choose USB2 or USB3.		ConnectionType: Determines type of connection to be used. For devices with a XEM7310 module (which can be found via the connected device list given in the Intan RHX application or by looking at the specifications for the device in use), use ControllerStimRecord. Otherwise, depending on the USB connection, choose USB2 or USB3.




			~To be added~

	Trigger parameters:		Trigger parameters:

Rlellis: /* Parameters */

2024-09-06T17:42:48Z

Parameters

← Older revision		Revision as of 17:42, 6 September 2024
Line 9:		Line 9:

	==Parameters==		==Parameters==

			SamplingRate: Due to the RHS's ability to only take on discrete sampling rates, a value matching one of the following must be used for this parameter (given in Hz): 1000, 1250, 1500, 2000, 2500, 3000, 3333, 4000, 5000, 6250, 8000, 10000, 12500, 15000,20000 ,25000, 30000.

			SampleBlockSize: The API provided by Intan only reads data in chunks of 128. Therefore, values that are multiples of 128 must be used for this parameter.

			ConnectionType: Determines type of connection to be used. For devices with a XEM7310 module (which can be found via the connected device list given in the Intan RHX application or by looking at the specifications for the device in use), use ControllerStimRecord. Otherwise, depending on the USB connection, choose USB2 or USB3.

	Trigger parameters:		Trigger parameters:

Rlellis: /* Parameters */

2024-08-09T19:43:48Z

Parameters

← Older revision		Revision as of 19:43, 9 August 2024
Line 36:		Line 36:

	Waveform parameters:		Waveform parameters:
			A1: Magnitude of first phase current (nA)
			A2: Magnitude of second phase current (nA)
			Polarity: Anodic: supplies positive current first. Cathodic: supplies negative current first
			D1: Duration of first phase
			D2: Duration of second phase
			DP: Interphase delay duration (Only applicable for Biphasic with Delay stimulation shape)

			Shape:
			Biphasic: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2
			Biphasic with delay: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies no current for time specified by DP, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2
			Triphasic: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2, then repeats the first phase (current of initial polarity for duration D1 and amplitude A1)

Rlellis: /* Synopsis */

2024-08-07T22:23:32Z

Synopsis

← Older revision		Revision as of 22:23, 7 August 2024
Line 6:		Line 6:
	</gallery>		</gallery>
	Attatched to the FPGA is an Opal Kelly XEM6010 USB/FPGA interface which can be used to read data in the FPGA via USB. This module has 128MByte SDRAM		Attatched to the FPGA is an Opal Kelly XEM6010 USB/FPGA interface which can be used to read data in the FPGA via USB. This module has 128MByte SDRAM


			==Parameters==

			Trigger parameters:

			TriggerEnable: enables or disables the trigger function

			TriggerType: Edge triggered: triggers stimulation upon change from inactive to active state. Level triggered: repeats stimulation while in an active state (i.e. can activate multiple times while the trigger condition is met, without needing to switch)

			TriggerState: Allows the user to enter a state that will be used as a trigger condition (i.e. can use KeyboardMonitor)

			TriggerValue: The value in which TriggerCondition will be compared to.

			TriggerCondition: The condition which TriggerState must satisfy in relation to TriggerValue in order to switch to an active state.


			Pulse train parameters:

			PulseTrainEnable: True: enables pulse train. False: sets stimulation to only a single pulse of the waveform.

			PulseTrainNumPulses: Number of pulses to be executed upon trigger activation

			PulseTrainPeriod: time elapsed between the start of two subsequent pulses (i.e. stimulus duration+interstimulus interval)

			PostTriggerDelay: Time between trigger activation and execution of pulse train

			RefractoryPeriod: Rest period after pulse train finishes executing during which stimulation will not execute

			Waveform parameters:

Rlellis: Created page with "==Synopsis== The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which sends data to a FPGA. These ports communicate with the chips located on supported headstages. Each port has four output signals responsible for communication with the amplifier chips, two of which (MISO1,MISO2) are used to transmit data. Each chip controls 16 channels, and each chip transmits data over a single MISO line. Over all four ports, this means there are 8 lines over which dat..."

2024-08-06T21:35:35Z

Created page with "==Synopsis== The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which sends data to a FPGA. These ports communicate with the chips located on supported headstages. Each port has four output signals responsible for communication with the amplifier chips, two of which (MISO1,MISO2) are used to transmit data. Each chip controls 16 channels, and each chip transmits data over a single MISO line. Over all four ports, this means there are 8 lines over which dat..."

New page

==Synopsis==

The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which sends data to a FPGA. These ports communicate with the chips located on supported headstages. Each port has four output signals responsible for communication with the amplifier chips, two of which (MISO1,MISO2) are used to transmit data. Each chip controls 16 channels, and each chip transmits data over a single MISO line. Over all four ports, this means there are 8 lines over which data can be sent.
<gallery mode="packed" widths=75px heights=75px>
File:Intanheadstage.jpg|RHS2116 Amplifier chip on 32 channel headstage
</gallery>
Attatched to the FPGA is an Opal Kelly XEM6010 USB/FPGA interface which can be used to read data in the FPGA via USB. This module has 128MByte SDRAM