br_stimpy._bstimulator

br_stimpy._bstimulator: CereStim Python SDK. Wrap of BStimulator.h using pybind11.

Classes

CallbackType

Once a connection with the stimulator has been made over the USB and a stimulator object is created, that object needs to be notified of any events that take place.

Config

The stimulator is capable of storing up to 16 stimulus waveforms that can then be used in any stimulus.

DeviceInfo

The stimulator has several different micro controllers that it uses.

ElectrodeChannelMap

The stimulator is capable of sending stimulation up to 96 different electrodes.

EventType

Since the stimulator is a HID, it can be plugged in and unplugged from the Host PC at will.

GroupStimulus

The stimulator allows for a group of simultaneous stimulations to occur.

InterfaceType

The Stimulator was originally designed to be communicated via USB or RS232, and will be functional on multiple platforms.

MaxOutputVoltage

The Stimulator is capable of measuring what its current output compliance voltage level is using a known impedance and stimulus parameters.

MaximumValues

The stimulator has an administrative interface that allows the primary researcher to set additional safety levels depending on there stimulation protocols and parameters.

ModuleStatus

The stimulator is capable of housing up to 16 current modules.

OCVolt

The Stimulator is capable of setting different output compliance voltage levels based on the users needs and safety considerations.

OutputMeasurement

The stimulator is capable of sending out a stimulus using known values and measure the voltage that is returned at five locations during the course of that stimulation.

PartNumbers

There are many versions of the stimulator.

ReadEEPROMOutput

The EEprom on the microcontroller stores the information that should be preserved over time even when the device is off or unplugged.

ReadHardwareValuesOutput

The stimulators various models have some different hardware configurations, so it is beneficial to get those hardware values of that particuliar CereStim 96.

ResultType

A stimulator object creates a USB connection with the actual CereStim 96 and calls are made to it through the stimulator object.

SeqType

The Stimulator has internal states, and based on those states the stimulator is allowed to perform different functions.

SequenceStatus

The stimulator can always be queried to determine what state it is in.

Stimulator

The stimulator class encapsulates all the functionallity of the stimulator and allows the user the ability to interface directly with Blackrock Microsystems CereStim 96 device.

StimulatorType

Members:

StimulusConfiguration

The stimulator is capable of custom configuring a biphasic stimulus.

TestElectrodes

The stimulator allows for diagnosising the status of the electrodes attached to it.

TestModules

The stimulator uses current modules to deliver stimulus through electrodes.

TriggerType

The stimulator is able to begin stimulating based on an external TTL logic.

USBParams

The USB parameters that need to be configured in order to have the stimulator object actually connect with the CereStim 96 over usb.

Version

Gives the current version of the API that is being used.

WFType

The Stimulator is capable of outputting a biphasic current pulse.

vector_UINT32

Overloaded function.