Source code for bluepyopt.ephys.responses

"""Responses classes"""

"""
Copyright (c) 2016-2020, EPFL/Blue Brain Project

 This file is part of BluePyOpt <https://github.com/BlueBrain/BluePyOpt>

 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 pandas


[docs]class Response(object):

    """Response to stimulus"""

    def __init__(self, name):
        """Constructor

        Args:
            name (str): name of this object
        """

        self.response = None
        self.name = name

    def __str__(self):
        return '%s: %s' % (self.__class__.__name__, self.name)


[docs]class TimeVoltageResponse(Response):

    """Response to stimulus"""

    def __init__(self, name, time=None, voltage=None):
        """Constructor

        Args:
            name (str): name of this object
            time (list of floats): time series
            voltage (list of floats): voltage series
        """

        super(TimeVoltageResponse, self).__init__(name)

        self.response = pandas.DataFrame()
        self.response['time'] = pandas.Series(time)
        self.response['voltage'] = pandas.Series(voltage)

[docs]    def read_csv(self, filename):
        """Load response from csv file"""

        self.response = pandas.read_csv(filename)

[docs]    def to_csv(self, filename):
        """Write response to csv file"""

        self.response.to_csv(filename)

    def __getitem__(self, index):
        """Return item at index"""

        return self.response.__getitem__(index)

    # This plot has to be generalised to several subplots
[docs]    def plot(self, axes):
        """Plot the response"""

        axes.plot(
            self.response['time'],
            self.response['voltage'],
            label='%s' %
            self.name)


[docs]class TimeLFPResponse(TimeVoltageResponse):

    """Response to stimulus"""

    def __init__(self, name, time=None, lfp=None):
        """Constructor
        Args:
            name (str): name of this object
            time (list of floats): time series
            lfp (list of floats): voltage series
        """

        super(TimeLFPResponse, self).__init__(name, time=time, voltage=None)
        self.response = {}
        self.response["time"] = time
        self.response["voltage"] = lfp

[docs]    def plot(self, axes):
        raise NotImplementedError