dbs_annotator.models.stimulation.StimulationParameters

class dbs_annotator.models.stimulation.StimulationParameters(left_frequency=None, left_cathode=None, left_anode=None, left_amplitude=None, left_pulse_width=None, right_frequency=None, right_cathode=None, right_anode=None, right_amplitude=None, right_pulse_width=None)[source]

Bases: object

Represents DBS stimulation parameters for both left and right sides.

left_frequency

Left stimulation frequency in Hz

Type:: str | None

left_cathode

Left electrode cathode configuration

Type:: str | None

left_anode

Left electrode anode configuration

Type:: str | None

left_amplitude

Left stimulation amplitude in mA

Type:: str | None

left_pulse_width

Left pulse width in µs

Type:: str | None

right_frequency

Right stimulation frequency in Hz

Type:: str | None

right_cathode

Right electrode cathode configuration

Type:: str | None

right_anode

Right electrode anode configuration

Type:: str | None

right_amplitude

Right stimulation amplitude in mA

Type:: str | None

right_pulse_width

Right pulse width in µs

Type:: str | None

Methods

`copy`()	Create a copy of the stimulation parameters.
`from_dict`(data)	Create StimulationParameters from a dictionary.
`to_dict`()	Convert stimulation parameters to a dictionary.

Attributes

`left_amplitude`
`left_anode`
`left_cathode`
`left_frequency`
`left_pulse_width`
`right_amplitude`
`right_anode`
`right_cathode`
`right_frequency`
`right_pulse_width`