br_stimpy.group_stim_struct.GroupStimulusStruct

class GroupStimulusStruct(electrode=None, pattern=None)

Bases: object

Group Stimulus Structure

Structure to input to group_stimulus() function.

Optionally accepts electrode and pattern ID lists as input. Constructor will check that electrode and pattern IDs are valid and not longer than MAX_MODULES. Will zero-pad lists to length MAX_MODULES. User cannot modify these lengths after object creation.

Parameters:

• electrode (Optional[List[int]]) – List of electrodes to stimulate on, up to length MAX_MODULES. Defaults to None.

• pattern (Optional[List[int]]) – List of pattern config IDs to match to electrodes above. Must be same length as electrode list. Defaults to None.

Raises:

ValueError – Electrode and Pattern lists must be the same length and cannot be longer than MAX_MODULES.

Methods

Attributes

electrode	List of electrodes
number	Number of electrodes contained in the group
pattern	List of pattern IDs corresponding to electrode

property electrode: List[int]

List of electrodes

property number: int

Number of electrodes contained in the group

property pattern: List[int]

List of pattern IDs corresponding to electrode