"""DeHyperPol eCode"""
"""
Copyright (c) 2022, EPFL/Blue Brain Project
This file is part of BluePyEfe <https://github.com/BlueBrain/BluePyEfe>
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License version 3.0 as published
by the Free Software Foundation.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
details.
You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
import logging
import numpy
from ..recording import Recording
from .tools import scipy_signal2d
logger = logging.getLogger(__name__)
[docs]
class DeHyperPol(Recording):
"""DeHyperpol current stimulus
The hyperpolarizing step is usually fixed at 150% of rheobase, and the hyperpolarizing step
can usually vary from -40% to -160% of rheobase.
.. code-block:: none
hypamp hypamp+amp hypamp+amp2 hypamp
: : : :
: _________________ : :
: | | : :
: | | : :
|_______________| | : ___________
^ ^ | : | ^
: : | : | :
: : | : | :
: : |____________| :
: : ^ ^ :
: : : : :
: : : : :
t=0 ton tmid toff tend
"""
def __init__(
self,
config_data,
reader_data,
protocol_name="DeHyperPol",
efel_settings=None
):
super(DeHyperPol, self).__init__(
config_data, reader_data, protocol_name
)
self.ton = None
self.tmid = None
self.toff = None
self.tend = None
self.amp = None
self.amp2 = None
self.hypamp = None
self.dt = None
self.amp_rel = None
self.amp2_rel = None
self.hypamp_rel = None
if self.t is not None and self.current is not None:
self.interpret(
self.t, self.current, self.config_data, self.reader_data
)
if self.voltage is not None:
self.set_autothreshold()
self.compute_spikecount(efel_settings)
self.export_attr = ["ton", "tmid", "toff", "tend", "amp", "amp2", "hypamp",
"dt", "amp_rel", "amp2_rel", "hypamp_rel"]
[docs]
def get_stimulus_parameters(self):
"""Returns the eCode parameters"""
ecode_params = {
"delay": self.ton,
"tmid": self.tmid,
"toff": self.toff,
"amp": self.amp,
"amp2": self.amp2,
"thresh_perc": self.amp2_rel,
"duration": self.toff - self.ton,
"totduration": self.tend,
}
return ecode_params
[docs]
def interpret(self, t, current, config_data, reader_data):
"""Analyse a current array and extract from it the parameters
needed to reconstruct the array"""
self.dt = t[1]
# Smooth the current
smooth_current = scipy_signal2d(current, 85)
self.set_timing_ecode(["ton", "tmid", "toff"], config_data)
hypamp_value = numpy.median(
numpy.concatenate(
(smooth_current[: self.ton], smooth_current[self.toff :])
)
)
self.set_amplitudes_ecode("hypamp", config_data, reader_data, hypamp_value)
amp_value = numpy.median(smooth_current[self.ton : self.tmid]) - self.hypamp
self.set_amplitudes_ecode("amp", config_data, reader_data, amp_value)
amp2_value = numpy.median(smooth_current[self.tmid : self.toff]) - self.hypamp
self.set_amplitudes_ecode("amp2", config_data, reader_data, amp2_value)
# Converting back to ms
for name_timing in ["ton", "tmid", "toff"]:
self.index_to_ms(name_timing, t)
self.tend = len(t) * self.dt
[docs]
def generate(self):
"""Generate the current array from the parameters of the ecode"""
ton = int(self.ton / self.dt)
tmid = int(self.tmid / self.dt)
toff = int(self.toff / self.dt)
time = numpy.arange(0.0, self.tend, self.dt)
current = numpy.full(time.shape, numpy.float64(self.hypamp))
current[ton:tmid] += numpy.float64(self.amp)
current[tmid:toff] += numpy.float64(self.amp2)
return time, current
[docs]
def compute_relative_amp(self, amp_threshold):
self.amp_rel = 100.0 * self.amp / amp_threshold
self.amp2_rel = 100.0 * self.amp2 / amp_threshold
self.hypamp_rel = 100.0 * self.hypamp / amp_threshold
def get_plot_amplitude_title(self):
return " ({:.01f}%/{:.01f}%)".format(self.amp_rel, self.amp2_rel)