evaluation.py 10.7 KB
Newer Older
1 2 3 4 5 6 7
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Created on Wed Jan 22 13:57:28 2020

@author: luna
"""
8
import pickle
Josef Brandt's avatar
Josef Brandt committed
9
import sys
10
import os
11
import numpy as np
12
import matplotlib.pyplot as plt
13

14
from helpers import ParticleBinSorter
Josef Brandt's avatar
Josef Brandt committed
15 16 17 18
import methods as meth
import geometricMethods as gmeth
sys.path.append("C://Users//xbrjos//Desktop//Python")
from gepard import dataset
19

Josef Brandt's avatar
Josef Brandt committed
20

Josef Brandt's avatar
Josef Brandt committed
21 22 23 24 25 26 27
def get_name_from_directory(dirPath: str) -> str:
    return str(os.path.basename(dirPath).split('.')[0])


class TotalResults(object):
    methods: list = [meth.RandomSampling, meth.SizeBinFractioning, gmeth.CrossBoxSubSampling,
                     gmeth.SpiralBoxSubsampling]
28
    measuredFreactions: list = [0.05, 0.1, 0.15, 0.2, 0.5, 0.75, 0.9]
Josef Brandt's avatar
Josef Brandt committed
29 30 31 32 33

    def __init__(self):
        super(TotalResults, self).__init__()
        self.sampleResults: list = []

34
    def add_sample(self, filePath: str):
Josef Brandt's avatar
Josef Brandt committed
35 36 37 38 39
        """
        Adds a new sampleResult object, if a .pkl file is given and if the sample name is not already present.
        :param filePath:
        :return:
        """
40
        newResult: SampleResult = None
Josef Brandt's avatar
Josef Brandt committed
41 42 43 44
        sampleName: str = get_name_from_directory(filePath)
        presentSampleNames: list = [res.sampleName for res in self.sampleResults]
        if sampleName not in presentSampleNames:
            if os.path.basename(filePath).split('.')[-1] == 'pkl':
45 46 47 48
                newResult = SampleResult(filePath)
                self.sampleResults.append(newResult)

        return newResult
Josef Brandt's avatar
Josef Brandt committed
49

50
    def update_all(self, force: bool = False) -> None:
Josef Brandt's avatar
Josef Brandt committed
51 52
        """
        Updates all samples with all methods and all fractions
53
        :param force: Wether to force an update of an already existing method.
Josef Brandt's avatar
Josef Brandt committed
54 55
        :return:
        """
56
        for index, sample in enumerate(self.sampleResults):
Josef Brandt's avatar
Josef Brandt committed
57 58 59 60
            sample.load_dataset()
            for fraction in self.measuredFreactions:
                possibleMethods = self._get_methods_for_fraction(sample.dataset, fraction)
                for curMethod in possibleMethods:
61
                    # print(f'updating {sample.sampleName} with {curMethod.label} at fraction {fraction}')
62
                    sample.update_result_with_method(curMethod, force=force)
63
            print(f'processed {index+1} of {len(self.sampleResults)} samples')
Josef Brandt's avatar
Josef Brandt committed
64

65
    def get_error_vs_fraction_data(self, attributes: list = [], methods: list = []) -> dict:
66 67
        """
        Returns Dict: Key: Method Label, Value: (Dict: Key:Measured Fraction, Value: averaged MPCountError over all samples)
68 69
        :param attributes: A list of attributes that should be used for filtering the samples. Only samples with an
        attribute from within that list are considered.
70 71 72 73
        :return:
        """
        result: dict = {}
        for sample in self.sampleResults:
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
            sample: SampleResult = sample
            if attributes == [] or sample.has_any_attribute(attributes):
                for res in sample.results:
                    res: SubsamplingResult = res
                    method: meth.SubsamplingMethod = res.method
                    if methods == [] or method.matches_any_pattern(methods):
                        label: str = method.label
                        frac: float = method.fraction
                        error: float = res.mpCountError

                        if label not in result.keys():
                            result[label] = {frac: [error]}
                        elif frac not in result[label].keys():
                            result[label][frac] = [error]
                        else:
                            result[label][frac].append(error)
90 91 92 93 94 95 96

        for method in result.keys():
            methodRes: dict = result[method]
            for fraction in methodRes.keys():
                methodRes[fraction] = np.mean(methodRes[fraction])

        return result
97

Josef Brandt's avatar
Josef Brandt committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    def _get_methods_for_fraction(self, dataset: dataset.DataSet, fraction: float) -> list:
        """
        :param fraction: The desired fraction to measure
        :return: list of measurement Objects that are applicable
        """
        particleContainer = dataset.particleContainer
        methods: list = [meth.RandomSampling(particleContainer, fraction),
                         meth.SizeBinFractioning(particleContainer, fraction)]

        boxCreator: gmeth.BoxSelectionCreator = gmeth.BoxSelectionCreator(dataset)
        methods += boxCreator.get_crossBoxSubsamplers_for_fraction(fraction)
        methods += boxCreator.get_spiralBoxSubsamplers_for_fraction(fraction)
        return methods


class SampleResult(object):
114 115 116 117
    """
    An object the actually stores all generated results per sample and can update and report on them.
    """
    def __init__(self, filepath: str):
Josef Brandt's avatar
Josef Brandt committed
118
        super(SampleResult, self).__init__()
119
        self.filepath: str = filepath
Josef Brandt's avatar
Josef Brandt committed
120 121
        self.dataset: dataset.DataSet = None
        self.results: list = []
122
        self.attributes: list = []
123 124 125

    @property
    def sampleName(self) -> str:
Josef Brandt's avatar
Josef Brandt committed
126
        return get_name_from_directory(self.filepath)
127

Josef Brandt's avatar
Josef Brandt committed
128 129
    def load_dataset(self) -> None:
        self.dataset = dataset.loadData(self.filepath)
130
        assert self.dataset is not None
131

Josef Brandt's avatar
Josef Brandt committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
    def update_result_with_method(self, method: meth.SubsamplingMethod, force: bool = False) -> None:
        """
        Updates result with the given method (contains desiredFraction already)
        :param method: The SubsamplingMethod Object
        :param force: Wether to force an update. If False, the result is not updated, if it is already present.
        :return:
        """

        if not self._result_is_already_present(method) or force:
            if force:
                self._remove_result_of_method(method)

            if self.dataset is None:
                self.load_dataset()

            method.particleContainer = self.dataset.particleContainer
            newResult: SubsamplingResult = SubsamplingResult(method)
            self.results.append(newResult)
            newResult.update()

152 153 154 155 156 157 158 159 160 161
    def set_attribute(self, newAttribute: str) -> None:
        """
        Adds a new attribute to the sample, if it does not contain the attribute already
        :param newAttribute:
        :return:
        """
        if not self.has_attribute(newAttribute):
            self.attributes.append(newAttribute)
            print(f'sample {self.filepath} has now attribute {newAttribute}')

162 163 164 165 166 167 168 169
    def has_any_attribute(self, listOfAttributes: list) -> bool:
        hasAttr: bool = False
        for attr in listOfAttributes:
            if self.has_attribute(attr):
                hasAttr = True
                break
        return hasAttr

170
    def has_attribute(self, attribute: str) -> bool:
171 172
        attributes: list = [attr.lower() for attr in self.attributes]
        return attribute.lower() in attributes
173

Josef Brandt's avatar
Josef Brandt committed
174 175 176 177 178 179 180
    def _remove_result_of_method(self, method: meth.SubsamplingMethod) -> None:
        """
        Removes the specified result from the list
        :param method:
        :return:
        """
        for result in self.results:
181
            if method.equals(result.method):
Josef Brandt's avatar
Josef Brandt committed
182 183 184 185 186 187 188 189 190 191
                self.results.remove(result)

    def _result_is_already_present(self, method: meth.SubsamplingMethod) -> bool:
        """
        Checks, if a result with the given method (method type AND measured fraction) is already present.
        :param method: The method object, specifying the subsampling method and the measured fraction
        :return:
        """
        isPresent: bool = False
        for result in self.results:
192
            if method.equals(result.method):
Josef Brandt's avatar
Josef Brandt committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
                isPresent = True
                break
        return isPresent


class SubsamplingResult(object):
    """
    Stores all interesting results from a subsampling experiment
    """
    def __init__(self, subsamplingMethod: meth.SubsamplingMethod):
        super(SubsamplingResult, self).__init__()
        self.method: meth.SubsamplingMethod = subsamplingMethod
        self.fraction = self.method.fraction
        self.origParticleCount: int = None
        self.subSampledParticleCount: int = None
        self.mpCountError: float = None
        self.mpCountErrorPerBin: tuple = None
210 211
        # TODO: UPDATE PATTERNS -> ARE THESE REASONABLE???
        self.mpPatterns = ['poly', 'rubber', 'pb', 'pr', 'pg', 'py', 'pv']
212

Josef Brandt's avatar
Josef Brandt committed
213 214 215 216 217 218 219 220 221 222 223
    def update(self) -> None:
        """
        Updates all results from the method.
        :return:
        """
        assert self.method.particleContainer is not None
        origParticles: list = self.method.particleContainer.particles
        self.origParticleCount = len(origParticles)
        subParticles: list = self.method.apply_subsampling_method()
        self.subSampledParticleCount = len(subParticles)
        fraction: float = self.method.fraction
224

Josef Brandt's avatar
Josef Brandt committed
225
        self.mpCountError = self._get_mp_count_error(origParticles, subParticles, fraction)
226
        # print(f'{self.origParticleCount} particles, thereof {self.subSampledParticleCount} measured, error: {self.mpCountError}')
Josef Brandt's avatar
Josef Brandt committed
227
        self.mpCountErrorPerBin = self._get_mp_count_error_per_bin(origParticles, subParticles, fraction)
228
        # print(f'method {self.method.label} updated, result is {self.mpCountError}')
229

Josef Brandt's avatar
Josef Brandt committed
230
    def _get_mp_count_error_per_bin(self, allParticles: list, subParticles: list, fractionMeasured: float) -> tuple:
231 232 233 234 235 236 237 238
        binSorter = ParticleBinSorter()
        allParticlesInBins = binSorter.sort_particles_into_bins(allParticles)
        subParticlesInBins = binSorter.sort_particles_into_bins(subParticles)
        mpCountErrorsPerBin = []
        for allParticleBin, subParticleBin in zip(allParticlesInBins, subParticlesInBins):
            mpCountErrorsPerBin.append(self._get_mp_count_error(allParticleBin, subParticleBin, fractionMeasured))
        return binSorter.bins, mpCountErrorsPerBin
        
Josef Brandt's avatar
Josef Brandt committed
239
    def _get_mp_count_error(self, allParticles: list, subParticles: list, fractionMeasured: float) -> float:
240 241 242 243 244 245 246 247
        numMPOrig = self._get_number_of_MP_particles(allParticles)
        numMPEstimate = self._get_number_of_MP_particles(subParticles) / fractionMeasured
        
        if numMPOrig != 0:
            mpCountError = self._get_error_from_values(numMPOrig, numMPEstimate)
        elif numMPEstimate == 0:
            mpCountError = 0
        else:
Josef Brandt's avatar
Josef Brandt committed
248
            raise Exception  # >0 particles in subsample, whereas none in entire sample. This cannot be!
249 250 251
            
        return mpCountError
    
Josef Brandt's avatar
Josef Brandt committed
252
    def _get_error_from_values(self, exact: float, estimate: float) -> float:
253
        assert(exact != 0)
254
        return abs(exact - estimate) / exact * 100
255
    
Josef Brandt's avatar
Josef Brandt committed
256
    def _get_number_of_MP_particles(self, particleList: list) -> int:
257 258 259
        numMPParticles = 0
        for particle in particleList:
            assignment = particle.getParticleAssignment()
260
            for pattern in self.mpPatterns:
261 262 263 264
                if assignment.lower().find(pattern) != -1:
                    numMPParticles += 1
                    break

265
        return numMPParticles