evaluation.py 10.8 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
import methods as meth
import geometricMethods as gmeth
17
import chemometricMethods as cmeth
Josef Brandt's avatar
Josef Brandt committed
18 19
sys.path.append("C://Users//xbrjos//Desktop//Python")
from gepard import dataset
20

Josef Brandt's avatar
Josef Brandt committed
21

Josef Brandt's avatar
Josef Brandt committed
22 23 24 25 26 27 28
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]
29
    measuredFreactions: list = [0.01, 0.05, 0.1, 0.15, 0.2, 0.5, 0.75, 0.9]
Josef Brandt's avatar
Josef Brandt committed
30 31 32 33 34

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

35
    def add_sample(self, filePath: str):
Josef Brandt's avatar
Josef Brandt committed
36 37 38 39 40
        """
        Adds a new sampleResult object, if a .pkl file is given and if the sample name is not already present.
        :param filePath:
        :return:
        """
41
        newResult: SampleResult = None
Josef Brandt's avatar
Josef Brandt committed
42 43 44 45
        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':
46 47 48 49
                newResult = SampleResult(filePath)
                self.sampleResults.append(newResult)

        return newResult
Josef Brandt's avatar
Josef Brandt committed
50

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

66
    def get_error_vs_fraction_data(self, attributes: list = [], methods: list = []) -> dict:
67 68
        """
        Returns Dict: Key: Method Label, Value: (Dict: Key:Measured Fraction, Value: averaged MPCountError over all samples)
69 70
        :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.
71 72 73 74
        :return:
        """
        result: dict = {}
        for sample in self.sampleResults:
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
            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)
91 92 93 94 95 96 97

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

        return result
98

Josef Brandt's avatar
Josef Brandt committed
99 100 101 102 103 104 105 106 107 108 109 110
    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)
111 112
        if fraction <= 0.1:
            methods.append(cmeth.ChemometricSubsampling(particleContainer, fraction))
Josef Brandt's avatar
Josef Brandt committed
113 114 115 116
        return methods


class SampleResult(object):
117 118 119 120
    """
    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
121
        super(SampleResult, self).__init__()
122
        self.filepath: str = filepath
Josef Brandt's avatar
Josef Brandt committed
123 124
        self.dataset: dataset.DataSet = None
        self.results: list = []
125
        self.attributes: list = []
126 127 128

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

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

Josef Brandt's avatar
Josef Brandt committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
    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()

155 156 157 158 159 160 161 162 163 164
    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}')

165 166 167 168 169 170 171 172
    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

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

Josef Brandt's avatar
Josef Brandt committed
177 178 179 180 181 182 183
    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:
184
            if method.equals(result.method):
Josef Brandt's avatar
Josef Brandt committed
185 186 187 188 189 190 191 192 193 194
                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:
195
            if method.equals(result.method):
Josef Brandt's avatar
Josef Brandt committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
                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
213 214
        # TODO: UPDATE PATTERNS -> ARE THESE REASONABLE???
        self.mpPatterns = ['poly', 'rubber', 'pb', 'pr', 'pg', 'py', 'pv']
215

Josef Brandt's avatar
Josef Brandt committed
216 217 218 219 220 221 222 223 224 225 226
    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
227

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

Josef Brandt's avatar
Josef Brandt committed
233
    def _get_mp_count_error_per_bin(self, allParticles: list, subParticles: list, fractionMeasured: float) -> tuple:
234 235 236 237 238 239 240 241
        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
242
    def _get_mp_count_error(self, allParticles: list, subParticles: list, fractionMeasured: float) -> float:
243 244 245 246 247 248 249 250
        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
251
            raise Exception  # >0 particles in subsample, whereas none in entire sample. This cannot be!
252 253 254
            
        return mpCountError
    
Josef Brandt's avatar
Josef Brandt committed
255
    def _get_error_from_values(self, exact: float, estimate: float) -> float:
256
        assert(exact != 0)
257
        return abs(exact - estimate) / exact * 100
258
    
Josef Brandt's avatar
Josef Brandt committed
259
    def _get_number_of_MP_particles(self, particleList: list) -> int:
260 261 262
        numMPParticles = 0
        for particle in particleList:
            assignment = particle.getParticleAssignment()
263
            for pattern in self.mpPatterns:
264 265 266 267
                if assignment.lower().find(pattern) != -1:
                    numMPParticles += 1
                    break

268
        return numMPParticles