Source code for bmtk.simulator.bionet.seclamp

# Copyright 2017. Allen Institute. All rights reserved
#
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
# following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
# disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
# products derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
from neuron import h


class SEClamp(object):
    def __init__(self, amplitudes, durations, rs=None):
        self._seclamp_amps = amplitudes
        self._seclamp_durs = durations
        self._seclamp_rs = rs
        self._stim = None

    def attach_current(self, cell):
        self._stim = h.SEClamp(cell.hobj.soma[0](0.5))
        self._stim.dur1 = self._seclamp_durs[0]
        self._stim.dur2 = self._seclamp_durs[1]
        self._stim.dur3 = self._seclamp_durs[2]

        self._stim.amp1 = self._seclamp_amps[0]
        self._stim.amp2 = self._seclamp_amps[1]
        self._stim.amp3 = self._seclamp_amps[2]

        if self._seclamp_rs != None:
            self._stim.rs = self._seclamp_rs

        return self._stim