extracellular_context

class nrv.fmod.extracellular_context

extracellular_context is a class to handle the computation of the extracellular voltage field induced by the electrical stimulation. This class should not be used directly by user, but user friendly classes (for Analitycal or FEM based computations) inherits from extracellular_context.

Methods

extracellular_context.__init__()	Instrantiation an extracellular_context object, empty shell to store electrodes and stimuli
extracellular_context.add_electrode(...)	Add a stimulation electrode and its stimulus to the stimulation.
extracellular_context.change_stimulus_from_electrode(...)	Change the stimulus of the ID_elec electrods
extracellular_context.clear_electrodes_footprints()	clear the footprints for all electrodes from existing array
extracellular_context.compute_vext(time_index)	Compute the external potential on a array of coordinate for a time sample of all synchronised stimuli with all electrodes.
extracellular_context.get_parameters()	Generic method returning all the atributes of an NRV_class instance
extracellular_context.is_empty()	check if a stimulation object is empty (No electrodes and stimuli, no external field can be computed).
extracellular_context.load(data[, blacklist])	Generic loading method for NRV_class instance
extracellular_context.load_extracel_context([data])
extracellular_context.plot(axes[, color])
extracellular_context.reset_electrodes()
extracellular_context.reset_stimuli()
extracellular_context.save([save, fname, ...])	Generic saving method for NRV_class instance.
extracellular_context.save_extracel_context([...])
extracellular_context.set_electrodes_footprints(...)	set the footprints for all electrodes from existing array
extracellular_context.set_parameters(**kawrgs)	Generic method to set any attribute of NRV_class instance
extracellular_context.synchronise_stimuli([...])	Synchronise all stimuli before simulation.
extracellular_context.translate([x, y, z])	Move extracellular context electrodes by group translation