Source code for bluepyopt.ephys.objectives

"""Objective 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 bluepyopt


[docs]class EFeatureObjective(bluepyopt.objectives.Objective):

    """EPhys feature objective"""

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

        Args:
            name (str): name of this object
            features (list of eFeatures): features used in the Objective
        """

        super(EFeatureObjective, self).__init__(name)
        self.name = name
        self.features = features

[docs]    def calculate_feature_scores(self, responses):
        """Calculate the scores for the individual features"""

        scores = []
        for feature in self.features:
            scores.append(feature.calculate_score(responses))

        return scores

[docs]    def calculate_feature_values(self, responses):
        """Calculate the value of an individual features"""

        values = []
        for feature in self.features:
            values.append(feature.calculate_feature(responses))

        return values


[docs]class SingletonObjective(EFeatureObjective):

    """Single EPhys feature"""

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

        Args:
            name (str): name of this object
            features (EFeature): single eFeature inside this objective
        """

        super(SingletonObjective, self).__init__(name, [feature])

[docs]    def calculate_score(self, responses):
        """Objective score"""

        return self.calculate_feature_scores(responses)[0]

[docs]    def calculate_value(self, responses):
        """Objective value"""

        return self.calculate_feature_values(responses)[0]

    def __str__(self):
        """String representation"""

        return '( %s )' % self.features[0]


[docs]class SingletonWeightObjective(EFeatureObjective):

    """Single EPhys feature"""

    def __init__(self, name, feature, weight):
        """Constructor
        Args:
            name (str): name of this object
            features (EFeature): single eFeature inside this objective
            weight (float): weight to scale to the efeature with
        """

        super(SingletonWeightObjective, self).__init__(name, [feature])
        self.weight = weight

[docs]    def calculate_score(self, responses):
        """Objective score"""

        return self.calculate_feature_scores(responses)[0] * self.weight

    def __str__(self):
        """String representation"""

        return '( %s ), weight:%f' % (self.features[0], self.weight)


[docs]class MaxObjective(EFeatureObjective):

    """Max of list of EPhys feature"""

[docs]    def calculate_score(self, responses):
        """Objective score"""

        return max(self.calculate_feature_scores(responses))


[docs]class WeightedSumObjective(EFeatureObjective):

    """Weighted sum of list of eFeatures"""

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

        Args:
            name (str): name of this object
            features (list of EFeatures): eFeatures in the objective
            weights (list of float): weights of the eFeatures
        """

        super(WeightedSumObjective, self).__init__(name, features)
        if len(weights) != len(features):
            raise Exception(
                'WeightedSumObjective: number of weights must be equal to '
                'number of features')
        self.weights = weights

[docs]    def calculate_score(self, responses):
        """Objective score"""

        score = 0.0
        feature_scores = self.calculate_feature_scores(responses)

        for feature_score, weight in zip(feature_scores, self.weights):
            score += weight * feature_score

        return score