harmonic_stimulus_CM

class nrv.optim.optim_utils.harmonic_stimulus_CM(stim_ID: int = 0, start: float = 1, amplitude: float = 100, t_pulse: float = 0.06, dt: float = 0, stim_gen: callable = None, stim_gen_kwargs: dict = {}, extracel_context: bool = True, intracel_context: bool = False, rec_context: bool = False)[source]

Context modifier which generate a stimulus harmonic stimulus from the input tuning parameters.

Parameters:

  • stim_ID (int, optional) – ID of the electrode which should be adapted, by default 0

  • start (float or str) – starting time of the waveform, in ms

  • amplitude (float, optional) – _description_, by default 100

  • t_pulse (float, optional) – _description_, by default 60e-3

  • dt (float, optional) – _description_, by default 0

  • stim_gen (callable, optional) – _description_, by default None

  • stim_gen_kwargs (dict, optional) – _description_, by default {}

  • extracel_context (bool) – specifies whether to load extracel_context with the static context

  • intracel_context (bool) – specifies whether to load intracel_context with the static context

  • rec_context (bool) – specifies whether to load rec_context with the static context

Methods

harmonic_stimulus_CM.__init__([stim_ID, ...])

Init method for NRV_class

harmonic_stimulus_CM.get_parameters()

Generic method returning all the atributes of an NRV_class instance

harmonic_stimulus_CM.interpolate(X)

interpolate the input vector with the interpolator.

harmonic_stimulus_CM.load(data[, blacklist])

Generic loading method for NRV_class instance

harmonic_stimulus_CM.save([save, fname, ...])

Generic saving method for NRV_class instance.

harmonic_stimulus_CM.set_parameters(**kawrgs)

Generic method to set any attribute of NRV_class instance

harmonic_stimulus_CM.stimulus_generator(X_interp)

generated from interpolated values with stim_gen function.