figure.py 27.7 KB
Newer Older
1 2 3 4
'''Runs error analysis on score sets, outputs metrics and plots'''

from __future__ import division, print_function
from abc import ABCMeta, abstractmethod
5
import math
6
import sys
7
import os.path
8 9 10 11 12
import click
import matplotlib
import matplotlib.pyplot as mpl
from matplotlib.backends.backend_pdf import PdfPages
from tabulate import tabulate
13
from .. import (far_threshold, plot, utils, ppndf)
14

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
15

16 17 18 19 20 21 22 23 24 25 26 27
def check_list_value(values, desired_number, name, name2='systems'):
    if values is not None and len(values) != desired_number:
        if len(values) == 1:
            values = values * desired_number
        else:
            raise click.BadParameter(
                '#{} ({}) must be either 1 value or the same as '
                '#{} ({} values)'.format(name, values, name2, desired_number))

    return values


28 29 30 31 32 33 34 35 36 37
class MeasureBase(object):
    """Base class for metrics and plots.
    This abstract class define the framework to plot or compute metrics from a
    list of (positive, negative) scores tuples.

    Attributes
    ----------
    func_load:
        Function that is used to load the input files
    """
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
38 39
    __metaclass__ = ABCMeta  # for python 2.7 compatibility

40
    def __init__(self, ctx, scores, evaluation, func_load):
41 42 43 44 45 46 47
        """
        Parameters
        ----------
        ctx : :py:class:`dict`
            Click context dictionary.

        scores : :any:`list`:
48 49 50 51
            List of input files (e.g. dev-{1, 2, 3}, {dev,eval}-scores1
            {dev,eval}-scores2)
        eval : :py:class:`bool`
            True if eval data are used
52 53 54 55 56
        func_load : Function that is used to load the input files
        """
        self._scores = scores
        self._ctx = ctx
        self.func_load = func_load
57
        self._legends = ctx.meta.get('legends')
58
        self._eval = evaluation
59
        self._min_arg = ctx.meta.get('min_arg', 1)
60 61 62 63 64
        if len(scores) < 1 or len(scores) % self._min_arg != 0:
            raise click.BadParameter(
                'Number of argument must be a non-zero multiple of %d' % self._min_arg
            )
        self.n_systems = int(len(scores) / self._min_arg)
65 66
        if self._legends is not None and len(self._legends) != self.n_systems:
            raise click.BadParameter("Number of legends must be equal to the "
67
                                     "number of systems")
68 69 70 71 72 73 74 75 76 77

    def run(self):
        """ Generate outputs (e.g. metrics, files, pdf plots).
        This function calls abstract methods
        :func:`~bob.measure.script.figure.MeasureBase.init_process` (before
        loop), :py:func:`~bob.measure.script.figure.MeasureBase.compute`
        (in the loop iterating through the different
        systems) and :py:func:`~bob.measure.script.figure.MeasureBase.end_process`
        (after the loop).
        """
78
        # init matplotlib, log files, ...
79
        self.init_process()
80 81
        # iterates through the different systems and feed `compute`
        # with the dev (and eval) scores of each system
82 83
        # Note that more than one dev or eval scores score can be passed to
        # each system
84
        for idx in range(self.n_systems):
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
85
            # load scores for each system: get the corresponding arrays and
86
            # base-name of files
87
            input_scores, input_names = self._load_files(
88 89 90 91 92 93
                # Scores are given as followed:
                # SysA-dev SysA-eval ... SysA-XX  SysB-dev SysB-eval ... SysB-XX
                # ------------------------------  ------------------------------
                #   First set of `self._min_arg`     Second set of input files
                #     input files starting at               for SysB
                #    index idx * self._min_arg
94
                self._scores[idx * self._min_arg:(idx + 1) * self._min_arg]
95 96
            )
            self.compute(idx, input_scores, input_names)
97
        # setup final configuration, plotting properties, ...
98 99
        self.end_process()

100
    # protected functions that need to be overwritten
101 102
    def init_process(self):
        """ Called in :py:func:`~bob.measure.script.figure.MeasureBase`.run
103
        before iterating through the different systems.
104 105 106
        Should reimplemented in derived classes"""
        pass

107
    # Main computations are done here in the subclasses
108
    @abstractmethod
109
    def compute(self, idx, input_scores, input_names):
110
        """Compute metrics or plots from the given scores provided by
111 112 113 114 115 116 117
        :py:func:`~bob.measure.script.figure.MeasureBase.run`.
        Should reimplemented in derived classes

        Parameters
        ----------
        idx : :obj:`int`
            index of the system
118 119 120 121
        input_scores: :any:`list`
            list of scores returned by the loading function
        input_names: :any:`list`
            list of base names for the input file of the system
122 123 124
        """
        pass

125
    # Things to do after the main iterative computations are done
126 127
    @abstractmethod
    def end_process(self):
128
        """ Called in :py:func:`~bob.measure.script.figure.MeasureBase`.run
129
        after iterating through the different systems.
130
        Should reimplemented in derived classes"""
131 132
        pass

133
    # common protected functions
134

135 136
    def _load_files(self, filepaths):
        ''' Load the input files and return the base names of the files
137 138 139

        Returns
        -------
140 141 142 143 144
            scores: :any:`list`:
                A list that contains the output of
                ``func_load`` for the given files
            basenames: :any:`list`:
                A list of basenames for the given files
145
        '''
146 147 148 149 150 151
        scores = []
        basenames = []
        for filename in filepaths:
            basenames.append(os.path.basename(filename).split(".")[0])
            scores.append(self.func_load(filename))
        return scores, basenames
152

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
153

154 155 156 157 158 159 160 161
class Metrics(MeasureBase):
    ''' Compute metrics from score files

    Attributes
    ----------
    log_file: str
        output stream
    '''
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
162

163 164
    def __init__(self, ctx, scores, evaluation, func_load):
        super(Metrics, self).__init__(ctx, scores, evaluation, func_load)
165 166 167 168
        self._tablefmt = ctx.meta.get('tablefmt')
        self._criterion = ctx.meta.get('criterion')
        self._open_mode = ctx.meta.get('open_mode')
        self._thres = ctx.meta.get('thres')
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
169
        if self._thres is not None:
170
            if len(self._thres) == 1:
171 172
                self._thres = self._thres * self.n_systems
            elif len(self._thres) != self.n_systems:
173
                raise click.BadParameter(
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
174
                    '#thresholds must be the same as #systems (%d)'
175
                    % len(self.n_systems)
176
                )
177 178
        self._far = ctx.meta.get('far_value')
        self._log = ctx.meta.get('log')
179 180 181 182
        self.log_file = sys.stdout
        if self._log is not None:
            self.log_file = open(self._log, self._open_mode)

183
    def compute(self, idx, input_scores, input_names):
184
        ''' Compute metrics thresholds and tables (FAR, FMR, FNMR, HTER) for
185
        given system inputs'''
186 187 188 189 190 191 192
        neg_list, pos_list, fta_list = utils.get_fta_list(input_scores)
        dev_neg, dev_pos, dev_fta = neg_list[0], pos_list[0], fta_list[0]
        dev_file = input_names[0]
        if self._eval:
            eval_neg, eval_pos, eval_fta = neg_list[1], pos_list[1], fta_list[1]
            eval_file = input_names[1]

193
        threshold = utils.get_thres(self._criterion, dev_neg, dev_pos, self._far) \
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
194
            if self._thres is None else self._thres[idx]
195
        title = self._legends[idx] if self._legends is not None else None
196
        if self._thres is None:
197
            far_str = ''
198
            if self._criterion == 'far' and self._far is not None:
199
                far_str = str(self._far)
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
200
            click.echo("[Min. criterion: %s %s] Threshold on Development set `%s`: %e"
201 202 203
                       % (self._criterion.upper(),
                          far_str, title or dev_file,
                          threshold),
204 205
                       file=self.log_file)
        else:
206
            click.echo("[Min. criterion: user provided] Threshold on "
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
207
                       "Development set `%s`: %e"
208
                       % (dev_file or title, threshold), file=self.log_file)
209 210 211 212 213 214 215 216 217 218 219 220

        from .. import farfrr
        dev_fmr, dev_fnmr = farfrr(dev_neg, dev_pos, threshold)
        dev_far = dev_fmr * (1 - dev_fta)
        dev_frr = dev_fta + dev_fnmr * (1 - dev_fta)
        dev_hter = (dev_far + dev_frr) / 2.0

        dev_ni = dev_neg.shape[0]  # number of impostors
        dev_fm = int(round(dev_fmr * dev_ni))  # number of false accepts
        dev_nc = dev_pos.shape[0]  # number of clients
        dev_fnm = int(round(dev_fnmr * dev_nc))  # number of false rejects

221 222 223 224 225 226 227 228 229
        dev_fta_str = "%.1f%%" % (100 * dev_fta)
        dev_fmr_str = "%.1f%% (%d/%d)" % (100 * dev_fmr, dev_fm, dev_ni)
        dev_fnmr_str = "%.1f%% (%d/%d)" % (100 * dev_fnmr, dev_fnm, dev_nc)
        dev_far_str = "%.1f%%" % (100 * dev_far)
        dev_frr_str = "%.1f%%" % (100 * dev_frr)
        dev_hter_str = "%.1f%%" % (100 * dev_hter)
        headers = ['' or title, 'Development %s' % dev_file]
        raws = [['FtA', dev_fta_str],
                ['FMR', dev_fmr_str],
230 231 232 233 234
                ['FNMR', dev_fnmr_str],
                ['FAR', dev_far_str],
                ['FRR', dev_frr_str],
                ['HTER', dev_hter_str]]

235
        if self._eval:
236 237 238 239 240 241 242 243 244
            # computes statistics for the eval set based on the threshold a priori
            eval_fmr, eval_fnmr = farfrr(eval_neg, eval_pos, threshold)
            eval_far = eval_fmr * (1 - eval_fta)
            eval_frr = eval_fta + eval_fnmr * (1 - eval_fta)
            eval_hter = (eval_far + eval_frr) / 2.0

            eval_ni = eval_neg.shape[0]  # number of impostors
            eval_fm = int(round(eval_fmr * eval_ni))  # number of false accepts
            eval_nc = eval_pos.shape[0]  # number of clients
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
245 246
            # number of false rejects
            eval_fnm = int(round(eval_fnmr * eval_nc))
247 248

            eval_fta_str = "%.1f%%" % (100 * eval_fta)
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
249 250 251 252
            eval_fmr_str = "%.1f%% (%d/%d)" % (100 *
                                               eval_fmr, eval_fm, eval_ni)
            eval_fnmr_str = "%.1f%% (%d/%d)" % (100 *
                                                eval_fnmr, eval_fnm, eval_nc)
253 254 255 256 257 258 259 260 261 262 263 264

            eval_far_str = "%.1f%%" % (100 * eval_far)
            eval_frr_str = "%.1f%%" % (100 * eval_frr)
            eval_hter_str = "%.1f%%" % (100 * eval_hter)

            headers.append('Eval. % s' % eval_file)
            raws[0].append(eval_fta_str)
            raws[1].append(eval_fmr_str)
            raws[2].append(eval_fnmr_str)
            raws[3].append(eval_far_str)
            raws[4].append(eval_frr_str)
            raws[5].append(eval_hter_str)
265 266 267 268 269 270 271 272

        click.echo(tabulate(raws, headers, self._tablefmt), file=self.log_file)

    def end_process(self):
        ''' Close log file if needed'''
        if self._log is not None:
            self.log_file.close()

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
273

274 275 276 277
class PlotBase(MeasureBase):
    ''' Base class for plots. Regroup several options and code
    shared by the different plots
    '''
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
278

279 280
    def __init__(self, ctx, scores, evaluation, func_load):
        super(PlotBase, self).__init__(ctx, scores, evaluation, func_load)
281 282 283 284 285 286
        self._output = ctx.meta.get('output')
        self._points = ctx.meta.get('points', 100)
        self._split = ctx.meta.get('split')
        self._axlim = ctx.meta.get('axlim')
        self._disp_legend = ctx.meta.get('disp_legend', True)
        self._legend_loc = ctx.meta.get('legend_loc')
287 288 289
        self._min_dig = None
        if 'min_far_value' in ctx.meta:
            self._min_dig = int(math.log10(ctx.meta['min_far_value']))
290
        elif self._axlim is not None and self._axlim[0] is not None:
291 292
            self._min_dig = int(math.log10(self._axlim[0])
                                if self._axlim[0] != 0 else 0)
293 294
        self._clayout = ctx.meta.get('clayout')
        self._far_at = ctx.meta.get('lines_at')
295 296 297 298
        self._trans_far_val = self._far_at
        if self._far_at is not None:
            self._eval_points = {line: [] for line in self._far_at}
            self._lines_val = []
299 300
        self._print_fn = ctx.meta.get('show_fn', True)
        self._x_rotation = ctx.meta.get('x_rotation')
301 302
        if 'style' in ctx.meta:
            mpl.style.use(ctx.meta['style'])
303
        self._nb_figs = 2 if self._eval and self._split else 1
304
        self._colors = utils.get_colors(self.n_systems)
305
        self._line_linestyles = ctx.meta.get('line_linestyles', False)
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
306 307
        self._linestyles = utils.get_linestyles(
            self.n_systems, self._line_linestyles)
308
        self._titles = ctx.meta.get('titles', []) * 2
309 310 311 312 313
        # for compatibility
        self._title = ctx.meta.get('title')
        if not self._titles and self._title is not None:
            self._titles = [self._title] * 2

314 315
        self._x_label = ctx.meta.get('x_label')
        self._y_label = ctx.meta.get('y_label')
316 317 318 319 320 321 322 323 324 325
        self._grid_color = 'silver'
        self._pdf_page = None
        self._end_setup_plot = True

    def init_process(self):
        ''' Open pdf and set axis font size if provided '''
        if not hasattr(matplotlib, 'backends'):
            matplotlib.use('pdf')

        self._pdf_page = self._ctx.meta['PdfPages'] if 'PdfPages'in \
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
326
            self._ctx.meta else PdfPages(self._output)
327

328
        for i in range(self._nb_figs):
329
            fs = self._ctx.meta.get('figsize')
330 331
            fig = mpl.figure(i + 1, figsize=fs)
            fig.set_constrained_layout(self._clayout)
332
            fig.clear()
333 334

    def end_process(self):
335 336
        ''' Set title, legend, axis labels, grid colors, save figures, drow
        lines and close pdf if needed '''
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
337
        # draw vertical lines
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
        if self._far_at is not None:
            for (line, line_trans) in zip(self._far_at, self._trans_far_val):
                mpl.figure(1)
                mpl.plot(
                    [line_trans, line_trans], [-100.0, 100.], "--",
                    color='black'
                )
                if self._eval and self._split:
                    mpl.figure(2)
                    x_values = [i for i, _ in self._eval_points[line]]
                    y_values = [j for _, j in self._eval_points[line]]
                    sort_indice = sorted(
                        range(len(x_values)), key=x_values.__getitem__
                    )
                    x_values = [x_values[i] for i in sort_indice]
                    y_values = [y_values[i] for i in sort_indice]
                    mpl.plot(x_values,
                             y_values, '--',
                             color='black')
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
357
        # only for plots
358 359 360
        if self._end_setup_plot:
            for i in range(self._nb_figs):
                fig = mpl.figure(i + 1)
361 362
                title = '' if not self._titles else self._titles[i]
                mpl.title(title if title.replace(' ', '') else '')
363 364 365
                mpl.xlabel(self._x_label)
                mpl.ylabel(self._y_label)
                mpl.grid(True, color=self._grid_color)
366 367
                if self._disp_legend:
                    mpl.legend(loc=self._legend_loc)
368
                self._set_axis()
369 370 371
                mpl.xticks(rotation=self._x_rotation)
                self._pdf_page.savefig(fig)

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
372
        # do not want to close PDF when running evaluate
373 374 375 376
        if 'PdfPages' in self._ctx.meta and \
           ('closef' not in self._ctx.meta or self._ctx.meta['closef']):
            self._pdf_page.close()

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
377
    # common protected functions
378 379

    def _label(self, base, name, idx):
380 381
        if self._legends is not None and len(self._legends) > idx:
            return self._legends[idx]
382
        if self.n_systems > 1:
383 384 385
            return base + (" %d (%s)" % (idx + 1, name))
        return base + (" (%s)" % name)

386
    def _set_axis(self):
387
        if self._axlim is not None:
388
            mpl.axis(self._axlim)
389

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
390

391
class Roc(PlotBase):
392
    ''' Handles the plotting of ROC'''
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
393

394 395
    def __init__(self, ctx, scores, evaluation, func_load):
        super(Roc, self).__init__(ctx, scores, evaluation, func_load)
396
        self._titles = self._titles or ['ROC dev', 'ROC eval']
397
        self._x_label = self._x_label or 'False Positive Rate'
398
        self._y_label = self._y_label or "1 - False Negative Rate"
399 400 401
        self._semilogx = ctx.meta.get('semilogx', True)
        best_legend = 'lower right' if self._semilogx else 'upper right'
        self._legend_loc = self._legend_loc or best_legend
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
402
        # custom defaults
403
        if self._axlim is None:
404
            self._axlim = [None, None, -0.05, 1.05]
405

406
    def compute(self, idx, input_scores, input_names):
407 408
        ''' Plot ROC for dev and eval data using
        :py:func:`bob.measure.plot.roc`'''
409 410
        neg_list, pos_list, _ = utils.get_fta_list(input_scores)
        dev_neg, dev_pos = neg_list[0], pos_list[0]
411 412
        dev_file = input_names[0]
        if self._eval:
413
            eval_neg, eval_pos = neg_list[1], pos_list[1]
414 415
            eval_file = input_names[1]

416
        mpl.figure(1)
417
        if self._eval:
418 419
            plot.roc_for_far(
                dev_neg, dev_pos,
420
                far_values=plot.log_values(self._min_dig or -4),
421
                CAR=self._semilogx,
422
                color=self._colors[idx], linestyle=self._linestyles[idx],
423
                label=self._label('dev', dev_file, idx)
424 425 426 427
            )
            if self._split:
                mpl.figure(2)

428
            linestyle = '--' if not self._split else self._linestyles[idx]
429
            plot.roc_for_far(
430 431
                eval_neg, eval_pos, linestyle=linestyle,
                far_values=plot.log_values(self._min_dig or -4),
432
                CAR=self._semilogx,
433
                color=self._colors[idx],
434
                label=self._label('eval', eval_file, idx)
435
            )
436
            if self._far_at is not None:
437
                from .. import farfrr
438
                for line in self._far_at:
439
                    thres_line = far_threshold(dev_neg, dev_pos, line)
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
440 441
                    eval_fmr, eval_fnmr = farfrr(
                        eval_neg, eval_pos, thres_line)
442
                    eval_fnmr = 1 - eval_fnmr
443 444
                    mpl.scatter(eval_fmr, eval_fnmr, c=self._colors[idx], s=30)
                    self._eval_points[line].append((eval_fmr, eval_fnmr))
445
        else:
446 447
            plot.roc_for_far(
                dev_neg, dev_pos,
448
                far_values=plot.log_values(self._min_dig or -4),
449
                CAR=self._semilogx,
450
                color=self._colors[idx], linestyle=self._linestyles[idx],
451
                label=self._label('dev', dev_file, idx)
452 453
            )

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
454

455 456
class Det(PlotBase):
    ''' Handles the plotting of DET '''
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
457

458 459
    def __init__(self, ctx, scores, evaluation, func_load):
        super(Det, self).__init__(ctx, scores, evaluation, func_load)
460
        self._titles = self._titles or ['DET dev', 'DET eval']
461 462
        self._x_label = self._x_label or 'False Positive Rate (%)'
        self._y_label = self._y_label or 'False Negative Rate (%)'
463
        self._legend_loc = self._legend_loc or 'upper right'
464 465
        if self._far_at is not None:
            self._trans_far_val = [ppndf(float(k)) for k in self._far_at]
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
466
        # custom defaults here
467 468
        if self._x_rotation is None:
            self._x_rotation = 50
469

470 471 472 473 474 475
        if self._axlim is None:
            self._axlim = [0.01, 99, 0.01, 99]

        if self._min_dig is not None:
            self._axlim[0] = math.pow(10, self._min_dig) * 100

476
    def compute(self, idx, input_scores, input_names):
477 478
        ''' Plot DET for dev and eval data using
        :py:func:`bob.measure.plot.det`'''
479 480
        neg_list, pos_list, _ = utils.get_fta_list(input_scores)
        dev_neg, dev_pos = neg_list[0], pos_list[0]
481 482
        dev_file = input_names[0]
        if self._eval:
483
            eval_neg, eval_pos = neg_list[1], pos_list[1]
484 485
            eval_file = input_names[1]

486
        mpl.figure(1)
487
        if self._eval and eval_neg is not None:
488 489
            plot.det(
                dev_neg, dev_pos, self._points, color=self._colors[idx],
490
                linestyle=self._linestyles[idx],
491
                label=self._label('development', dev_file, idx)
492 493 494
            )
            if self._split:
                mpl.figure(2)
495
            linestyle = '--' if not self._split else self._linestyles[idx]
496
            plot.det(
497
                eval_neg, eval_pos, self._points, color=self._colors[idx],
498
                linestyle=linestyle,
499
                label=self._label('eval', eval_file, idx)
500
            )
501 502 503 504
            if self._far_at is not None:
                from .. import farfrr
                for line in self._far_at:
                    thres_line = far_threshold(dev_neg, dev_pos, line)
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
505 506
                    eval_fmr, eval_fnmr = farfrr(
                        eval_neg, eval_pos, thres_line)
507 508 509
                    eval_fmr, eval_fnmr = ppndf(eval_fmr), ppndf(eval_fnmr)
                    mpl.scatter(eval_fmr, eval_fnmr, c=self._colors[idx], s=30)
                    self._eval_points[line].append((eval_fmr, eval_fnmr))
510 511 512
        else:
            plot.det(
                dev_neg, dev_pos, self._points, color=self._colors[idx],
513
                linestyle=self._linestyles[idx],
514
                label=self._label('development', dev_file, idx)
515 516
            )

517
    def _set_axis(self):
518
        plot.det_axis(self._axlim)
519

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
520

521 522
class Epc(PlotBase):
    ''' Handles the plotting of EPC '''
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
523

524 525
    def __init__(self, ctx, scores, evaluation, func_load):
        super(Epc, self).__init__(ctx, scores, evaluation, func_load)
526
        if self._min_arg != 2:
527
            raise click.UsageError("EPC requires dev and eval score files")
528
        self._titles = self._titles or ['EPC'] * 2
529 530
        self._x_label = self._x_label or r'$\alpha$'
        self._y_label = self._y_label or 'HTER (%)'
531
        self._legend_loc = self._legend_loc or 'upper center'
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
532
        self._eval = True  # always eval data with EPC
533
        self._split = False
534
        self._nb_figs = 1
535
        self._far_at = None
536

537
    def compute(self, idx, input_scores, input_names):
538
        ''' Plot EPC using :py:func:`bob.measure.plot.epc` '''
539 540
        neg_list, pos_list, _ = utils.get_fta_list(input_scores)
        dev_neg, dev_pos = neg_list[0], pos_list[0]
541 542
        dev_file = input_names[0]
        if self._eval:
543
            eval_neg, eval_pos = neg_list[1], pos_list[1]
544 545
            eval_file = input_names[1]

546
        plot.epc(
547
            dev_neg, dev_pos, eval_neg, eval_pos, self._points,
548
            color=self._colors[idx], linestyle=self._linestyles[idx],
549
            label=self._label(
550
                'curve', dev_file + "_" + eval_file, idx
551
            )
552 553
        )

Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
554

555
class Hist(PlotBase):
556
    ''' Functional base class for histograms'''
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
557

558
    def __init__(self, ctx, scores, evaluation, func_load, nhist_per_system=2):
559
        super(Hist, self).__init__(ctx, scores, evaluation, func_load)
560 561 562 563 564
        self._nbins = ctx.meta.get('n_bins', ['doane'])
        self._nhist_per_system = nhist_per_system
        self._nbins = check_list_value(
            self._nbins, self.n_systems * nhist_per_system, 'n_bins',
            'histograms')
565
        self._thres = ctx.meta.get('thres')
566 567
        self._thres = check_list_value(
            self._thres, self.n_systems, 'thresholds')
568
        self._criterion = ctx.meta.get('criterion')
569
        self._no_line = ctx.meta.get('no_line', False)
570 571
        self._nrows = ctx.meta.get('n_row', 1)
        self._ncols = ctx.meta.get('n_col', 1)
572 573 574
        self._hide_dev = ctx.meta.get('hide_dev', False)
        # dev hist are displayed next to eval hist
        self._ncols *= 1 if self._hide_dev else 2
575
        self._nlegends = ctx.meta.get('legends_ncol', 10)
576
        self._legend_loc = self._legend_loc or 'upper center'
577
        self._step_print = int(self._nrows * self._ncols)
578
        self._title_base = 'Scores'
579
        self._y_label = 'Probability density'
580
        self._x_label = 'Scores values'
581 582
        self._end_setup_plot = False

583
    def compute(self, idx, input_scores, input_names):
584
        ''' Draw histograms of negative and positive scores.'''
585
        dev_neg, dev_pos, eval_neg, eval_pos, threshold = \
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
586
            self._get_neg_pos_thres(idx, input_scores, input_names)
587 588 589 590 591 592 593 594 595 596 597 598 599
        idx *= 1 if self._hide_dev or not self._eval else 2

        if not self._hide_dev or not self._eval:
            self._print_subplot(idx, dev_neg, dev_pos, threshold, False,
                                dflt_title="Dev scores")

        idx += 1 if self._eval and not self._hide_dev else 0
        if self._eval:
            self._print_subplot(idx, eval_neg, eval_pos, threshold,
                                not self._no_line, dflt_title="Eval scores")


    def _print_subplot(self, idx, neg, pos, threshold, draw_line, dflt_title):
600 601 602 603 604 605 606
        n = idx % self._step_print
        col = n % self._ncols
        sub_plot_idx = n + 1
        axis = mpl.subplot(self._nrows, self._ncols, sub_plot_idx)
        self._setup_hist(neg, pos)
        if col == 0:
            axis.set_ylabel(self._y_label)
607
        # rest to be printed
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
608 609
        rest_print = self.n_systems - \
            int(idx / self._step_print) * self._step_print
610
        if n + self._ncols >= min(self._step_print, rest_print):
611
            axis.set_xlabel(self._x_label)
612
        axis.set_title(self._get_title(idx, dflt_title))
613
        label = "%s threshold%s" % (
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
614
            '' if self._criterion is None else
615 616
            self._criterion.upper(), ' (dev)' if self._eval else ''
        )
617
        if draw_line:
618
            self._lines(threshold, label, neg, pos, idx)
619
        if sub_plot_idx == 1:
620
            self._plot_legends()
621 622
        mult = 2 if self._eval and not self._hide_dev else 1
        if self._step_print == sub_plot_idx or idx == self.n_systems * mult - 1:
623
            mpl.tight_layout()
624
            self._pdf_page.savefig(mpl.gcf(), bbox_inches='tight')
625 626
            mpl.clf()
            mpl.figure()
627

628 629 630
    def _get_title(self, idx, dflt=None):
        title = self._legends[idx] if self._legends is not None \
        and idx < len(self._legends) else dflt
631
        title = title or self._title_base
632 633
        title = '' if title is not None and not title.replace(
            ' ', '') else title
634
        return title or ''
635 636 637 638 639 640 641 642

    def _plot_legends(self):
        lines = []
        labels = []
        for ax in mpl.gcf().get_axes():
            li, la = ax.get_legend_handles_labels()
            lines += li
            labels += la
643 644
        if self._disp_legend:
            mpl.gcf().legend(
645
                lines, labels, loc=self._legend_loc, fancybox=True,
646
                framealpha=0.5, ncol=self._nlegends,
647
                bbox_to_anchor=(0.55, 1.06),
648
            )
649

650
    def _get_neg_pos_thres(self, idx, input_scores, input_names):
651 652
        neg_list, pos_list, _ = utils.get_fta_list(input_scores)
        length = len(neg_list)
Amir MOHAMMADI's avatar
lint  
Amir MOHAMMADI committed
653
        # can have several files for one system
654 655
        dev_neg = [neg_list[x] for x in range(0, length, 2)]
        dev_pos = [pos_list[x] for x in range(0, length, 2)]
656 657
        eval_neg = eval_pos = None
        if self._eval:
658
            eval_neg = [neg_list[x] for x in range(1, length, 2)]
659 660
            eval_pos = [pos_list[x] for x in range(1, length, 2)]

661
        threshold = utils.get_thres(
662
            self._criterion, dev_neg[0], dev_pos[0]
663
        ) if self._thres is None else self._thres[idx]
664
        return dev_neg, dev_pos, eval_neg, eval_pos, threshold
665

666
    def _density_hist(self, scores, n, **kwargs):
667
        n, bins, patches = mpl.hist(
668
            scores, density=True,
669
            bins=self._nbins[n],
670
            **kwargs
671 672 673
        )
        return (n, bins, patches)

674 675
    def _lines(self, threshold, label=None, neg=None, pos=None,
               idx=None, **kwargs):
676
        label = label or 'Threshold'
677 678 679 680
        kwargs.setdefault('color', 'C3')
        kwargs.setdefault('linestyle', '--')
        kwargs.setdefault('label', label)
        # plot a vertical threshold line
681
        mpl.axvline(x=threshold, ymin=0, ymax=1, **kwargs)
682 683 684 685

    def _setup_hist(self, neg, pos):
        ''' This function can be overwritten in derived classes'''
        self._density_hist(
686 687
            neg[0], n=0,
            label='Negatives', alpha=0.5, color='C3'
688 689
        )
        self._density_hist(
690 691
            pos[0], n=1,
            label='Positives', alpha=0.5, color='C0'
692
        )