stimulation

class nrv.fmod.stimulation(material='endoneurium_ranck')[source]

Stimulation object are designed to connect all other objects requierd to analyticaly compute the external potential voltage for axons : - the material surrounding the axon (only one) - a list of electrode(s) - a list of corresponding current stimuli This class inherits from extracellular_context.

Methods

stimulation.__init__([material])

Implement a stimulation object.

stimulation.add_electrode(electrode, stimulus)

Add a stimulation electrode and its stimulus to the stimulation, only if the electrode is analytically described.

stimulation.change_stimulus_from_electrode(...)

Change the stimulus of the ID_elec electrods

stimulation.clear_electrodes_footprints()

clear the footprints for all electrodes from existing array

stimulation.compute_electrodes_footprints(x, y, z)

Compute the footprints for all electrodes

stimulation.compute_vext(time_index)

Compute the external potential on a array of coordinate for a time sample of all synchronised stimuli with all electrodes.

stimulation.get_parameters()

Generic method returning all the atributes of an NRV_class instance

stimulation.is_empty()

check if a stimulation object is empty (No electrodes and stimuli, no external field can be computed).

stimulation.load(data[, blacklist])

Generic loading method for NRV_class instance

stimulation.load_extracel_context([data])

stimulation.plot(axes[, color])

stimulation.reset_electrodes()

stimulation.reset_stimuli()

stimulation.save([save, fname, blacklist])

Generic saving method for NRV_class instance.

stimulation.save_extracel_context([save, fname])

stimulation.set_electrodes_footprints(footprints)

set the footprints for all electrodes from existing array

stimulation.set_parameters(**kawrgs)

Generic method to set any attribute of NRV_class instance

stimulation.synchronise_stimuli([snap_time, ...])

Synchronise all stimuli before simulation.

stimulation.translate([x, y, z])

Move extracellular context electrodes by group translation