Source code for currentscape.voltages

"""Voltages class."""

# Copyright 2023 Blue Brain Project / EPFL

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# pylint: disable=wrong-import-position, super-with-arguments
import numpy as np

import matplotlib.pyplot as plt

from currentscape.datasets import DataSet
from currentscape.plotting import remove_ticks_and_frame, show_xgridlines



[docs]
class Voltages(DataSet):
    """Class containing voltage data."""

    def __init__(self, data, c, time):
        """Constructor.

        Args:
            data (list): data
            c (dict): config
            time (list): time of the data
        """
        # DataSet expect a list of lists as data
        super(Voltages, self).__init__(
            data=[data], names=None, time=time, xticks=c["xaxis"]["xticks"]
        )


[docs]
    def plot(self, c, row, rows_tot):
        """Plot voltage trace.

        Args:
            c (dict): config
            row (int): row of subplot
            rows_tot (int): total number of subplots in the figure
        """
        ax = plt.subplot2grid((rows_tot, 1), (row, 0), rowspan=2)

        ax.plot(self.time, self.data[0], color=c["voltage"]["color"], lw=c["lw"])

        ax.plot(
            self.time,
            np.ones(self.x_size) * c["voltage"]["ticks"][0],
            ls="dashed",
            color="black",
            lw=0.75,
        )

        ax.vlines(
            1, c["voltage"]["ticks"][0], c["voltage"]["ticks"][-1], lw=1, color="black"
        )

        ax.set_ylim(c["voltage"]["ylim"])
        ax.set_xlim([self.time[0], self.time[-1]])

        # show x axis gridline
        if c["show"]["xgridlines"]:
            show_xgridlines(ax, c, self.xticks, c["voltage"]["ylim"])

        if c["show"]["ylabels"]:
            ax.set_ylabel(c["voltage"]["units"], labelpad=c["labelpad"])
        if c["show"]["yticklabels"]:
            ax.set_yticks(c["voltage"]["ticks"])

        remove_ticks_and_frame(ax)