stim_energy_CE

class nrv.optim.optim_utils.stim_energy_CE(id_elec: None | int | list[int] = None, dt_res: float = 0.0001)

Create a callable object which return a value proportionnal to the stimulus energy, assuming the electrode impedance is a constant.

\[cost = \sum_{e}\sum_{t_k}{i_{e,stim}^2(t_k)}\]

with \(t_k\) is the discrete time step of the simulation

Parameters:

• id_elec (None | int | list[int]) – id or list id of the electrode of the to from which the energy should be computed. If None,

• dt_res (float) – resolotion time step use to compute the cost value

Methods

stim_energy_CE.__init__([id_elec, dt_res])	Initialize a cost evaluator proportional to stimulus energy.
stim_energy_CE.call_method(results, **kwargs)	Compute the total energy-based cost from the extracellular stimuli stored in simulation results.
stim_energy_CE.compute_stimulus_cost(stim)	Compute the integrated squared-amplitude cost of one stimulus.
stim_energy_CE.get_parameters()	Generic method returning all the atributes of an NRV_class instance
stim_energy_CE.load(data[, blacklist])	Generic loading method for NRV_class instance
stim_energy_CE.save([save, fname, blacklist])	Generic saving method for NRV_class instance.
stim_energy_CE.set_parameters(**kawrgs)	Generic method to set any attribute of NRV_class instance