common_options.py 18.1 KB
Newer Older
1
2
'''Stores click common options for plots'''

3
import math
4
import pkg_resources  # to make sure bob gets imported properly
5
6
7
8
9
import logging
import click
from click.types import INT, FLOAT, Choice, File
import matplotlib.pyplot as plt
from matplotlib.backends.backend_pdf import PdfPages
10
11
from bob.extension.scripts.click_helper import (verbosity_option, bool_option,
                                                list_float_option)
12
13
14

logger = logging.getLogger(__name__)

15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def scores_argument(eval_mandatory=False, min_len=1, **kwargs):
    """Get the argument for scores, and add `dev-scores` and `eval-scores` in
    the context when `--evaluation` flag is on (default)

    Parameters
    ----------

    eval_mandatory :
        If evaluation files are mandatory
    min_len :
        The min lenght of inputs files that are needed. If eval_mandatory is
        True, this quantity is multiplied by 2.

    Returns
    -------
        Click option
    """
32
33
34
    def custom_scores_argument(func):
        def callback(ctx, param, value):
            length = len(value)
35
36
37
38
39
40
41
            min_arg = min_len or 1
            ctx.meta['min_arg'] = min_arg
            if length < min_arg:
                raise click.BadParameter(
                    'You must provide at least %d score files' % min_arg,
                    ctx=ctx
                )
42
43
            else:
                ctx.meta['scores'] = value
44
45
46
47
48
49
                step = 1
                if eval_mandatory or ctx.meta['evaluation']:
                    step = 2
                    if (length % (min_arg * 2)) != 0:
                        pref = 'T' if eval_mandatory else \
                                ('When `--evaluation` flag is on t')
50
51
                        raise click.BadParameter(
                            '%sest-score(s) must '
52
53
54
                            'be provided along with dev-score(s). '
                            'You must provide at least %d score files.' \
                            % (pref, min_arg * 2), ctx=ctx
55
                        )
56
57
58
59
60
61
62
63
64
65
66
                for arg in range(min_arg):
                    ctx.meta['dev_scores_%d' % arg] = [
                        value[i] for i in range(arg * step, length,
                                                min_arg * step)
                    ]
                    if step > 1:
                        ctx.meta['eval_scores_%d' % arg] = [
                            value[i] for i in range((arg * step + 1),
                                                    length, min_arg * step)
                        ]
                ctx.meta['n_sys'] = len(ctx.meta['dev_scores_0'])
67
                if 'titles' in ctx.meta and \
68
                   len(ctx.meta['titles']) != ctx.meta['n_sys']:
69
70
71
                    raise click.BadParameter(
                        '#titles not equal to #sytems', ctx=ctx
                    )
72
            return value
73
74
75
76
        return click.argument(
            'scores', type=click.Path(exists=True),
            callback=callback, **kwargs
        )(func)
77
78
    return custom_scores_argument

79
80
81
82
83
84
def eval_option(**kwargs):
    '''Get option flag to say if eval-scores are provided'''
    return bool_option(
        'evaluation', 'e', 'If set, evaluation scores must be provided',
        dflt=True
    )
85

86
87
def sep_dev_eval_option(dflt=True, **kwargs):
    '''Get option flag to say if dev and eval plots should be in different
88
    plots'''
89
    return bool_option(
90
91
        'split', 's','If set, evaluation and dev curve in different plots',
        dflt
92
93
94
95
96
    )

def cmc_option(**kwargs):
    '''Get option flag to say if cmc scores'''
    return bool_option('cmc', 'C', 'If set, CMC score files are provided')
97

98
def semilogx_option(dflt=False, **kwargs):
99
    '''Option to use semilog X-axis'''
100
    return bool_option('semilogx', 'G', 'If set, use semilog on X axis', dflt)
101

102
103
104
105
def show_dev_option(dflt=False, **kwargs):
    '''Option to tell if should show dev histo'''
    return bool_option('show-dev', 'D', 'If set, show dev histograms', dflt)

106
def print_filenames_option(dflt=True, **kwargs):
107
108
109
110
111
112
113
    '''Option to tell if filenames should be in the title'''
    return bool_option('show-fn', 'P', 'If set, show filenames in title', dflt)

def const_layout_option(dflt=True, **kwargs):
    '''Option to set matplotlib constrained_layout'''
    return bool_option('clayout', 'Y', '(De)Activate constrained layout', dflt)

114
115
116
117
118
119
120
121
122
123
124
125
126
def axes_val_option(dflt=None, **kwargs):
    return list_float_option(
        name='axlim', short_name='L',
        desc='min/max axes values separated by commas (min_x, max_x, min_y, max_y)',
        nitems=4, dflt=dflt, **kwargs
    )

def thresholds_option(**kwargs):
    return list_float_option(
        name='thres', short_name='T',
        desc='Given threshold for metrics computations',
        nitems=None, dflt=None, **kwargs
    )
127

128
129
130
131
132
133
134
135
def lines_at_option(**kwargs):
    '''Get option to draw const far line'''
    return list_float_option(
        name='lines-at', short_name='la',
        desc='If given, draw a veritcal lines on ROC plots',
        nitems=None, dflt=None, **kwargs
    )

136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def axis_fontsize_option(dflt=8, **kwargs):
    '''Get option for axis font size'''
    def custom_axis_fontsize_option(func):
        def callback(ctx, param, value):
            value = abs(value)
            ctx.meta['fontsize'] = value
            return value
        return click.option(
            '-F', '--fontsize', type=click.INT, default=dflt, show_default=True,
            help='Axis fontsize',
            callback=callback, **kwargs)(func)
    return custom_axis_fontsize_option

def x_rotation_option(dflt=0, **kwargs):
    '''Get option for rotartion of the x axis lables'''
    def custom_x_rotation_option(func):
        def callback(ctx, param, value):
            value = abs(value)
            ctx.meta['x_rotation'] = value
            return value
        return click.option(
            '-r', '--x-rotation', type=click.INT, default=dflt, show_default=True,
            help='X axis labels ration',
            callback=callback, **kwargs)(func)
    return custom_x_rotation_option

162

163
164
165
166
167
168
169
170
171
172
173
174
175
176
def cost_option(**kwargs):
    '''Get option to get cost for FAR'''
    def custom_cost_option(func):
        def callback(ctx, param, value):
            if value < 0 or value > 1:
                raise click.BadParameter("Cost for FAR must be betwen 0 and 1")
            ctx.meta['cost'] = value
            return value
        return click.option(
            '-C', '--cost', type=float, default=0.99, show_default=True,
            help='Cost for FAR in minDCF',
            callback=callback, **kwargs)(func)
    return custom_cost_option

177
178
179
180
181
182
183
184
185
def n_sys_option(**kwargs):
    '''Get the number of systems to be processed'''
    def custom_n_sys_option(func):
        def callback(ctx, param, value):
            ctx.meta['n_sys'] = value
            return value
        return click.option(
            '--n-sys', type=INT, default=1, show_default=True,
            help='The number of systems to be processed',
186
            callback=callback, is_eager=True , **kwargs)(func)
187
188
189
190
191
192
193
194
195
196
197
    return custom_n_sys_option

def points_curve_option(**kwargs):
    '''Get the number of points use to draw curves'''
    def custom_points_curve_option(func):
        def callback(ctx, param, value):
            if value < 2:
                raise click.BadParameter(
                    'Number of points to draw curves must be greater than 1'
                    , ctx=ctx
                )
198
            ctx.meta['points'] = value
199
200
201
202
203
204
205
206
207
208
209
            return value
        return click.option(
            '-n', '--points', type=INT, default=100, show_default=True,
            help='The number of points use to draw curves in plots',
            callback=callback, **kwargs)(func)
    return custom_points_curve_option

def n_bins_option(**kwargs):
    '''Get the number of bins in the histograms'''
    def custom_n_bins_option(func):
        def callback(ctx, param, value):
210
211
212
            if value is None:
                value = 'auto'
            elif value < 2:
213
214
215
216
217
218
219
                raise click.BadParameter(
                    'Number of bins must be greater than 1'
                    , ctx=ctx
                )
            ctx.meta['n_bins'] = value
            return value
        return click.option(
220
221
            '-b', '--nbins', type=INT, default=None,
            help='The number of bins in the histogram(s). Default: `auto`',
222
223
224
225
226
227
228
229
230
231
232
233
            callback=callback, **kwargs)(func)
    return custom_n_bins_option

def table_option(**kwargs):
    '''Get table option for tabulate package
    More informnations: https://pypi.python.org/pypi/tabulate
    '''
    def custom_table_option(func):
        def callback(ctx, param, value):
            ctx.meta['tablefmt'] = value
            return value
        return click.option(
234
            '--tablefmt', type=click.STRING, default='rst',
235
            show_default=True, help='Format for table display: `plain`, '
236
            '`simple`, `grid`, `fancy_grid`, `pipe`, `orgtbl`, '
237
238
            '`jira`, `presto`, `psql`, `rst`, `mediawiki`, `moinmoin`, '
            '`youtrack`, `html`, `latex`, '
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
            '`latex_raw`, `latex_booktabs`, `textile`',
            callback=callback,**kwargs)(func)
    return custom_table_option

def output_plot_file_option(default_out='plots.pdf', **kwargs):
    '''Get options for output file for plots'''
    def custom_output_plot_file_option(func):
        def callback(ctx, param, value):
            ''' Save ouput file  and associated pdf in context list,
            print the path of the file in the log'''
            ctx.meta['output'] = value
            ctx.meta['PdfPages'] = PdfPages(value)
            logger.debug("Plots will be output in %s", value)
            return value
        return click.option(
            '-o', '--output',
            default=default_out, show_default=True,
            help='The file to save the plots in.',
            callback=callback, **kwargs)(func)
    return custom_output_plot_file_option

def output_plot_metric_option(**kwargs):
    '''Get options for output file for metrics'''
    def custom_output_plot_file_option(func):
        def callback(ctx, param, value):
            ''' Save ouput file  and associated pdf in context list,
            print the path of the file in the log'''
            if value is not None:
                logger.debug("Metrics will be output in %s", value)
            ctx.meta['log'] = value
            return value
        return click.option(
            '-l', '--log', default=None, type=click.STRING,
            help='If provided, computed numbers are written to '
              'this file instead of the standard output.',
            callback=callback, **kwargs)(func)
    return custom_output_plot_file_option

277
278
279
280
281
282
283
284
285
def criterion_option(lcriteria=['eer', 'hter', 'far'], **kwargs):
    """Get option flag to tell which criteriom is used (default:eer)

    Parameters
    ----------

    lcriteria : :any:`list`
        List of possible criteria
    """
286
287
    def custom_criterion_option(func):
        def callback(ctx, param, value):
288
289
            list_accepted_crit = lcriteria if lcriteria is not None else \
                    ['eer', 'hter', 'far']
290
291
292
293
294
295
296
297
298
299
300
301
            if value not in list_accepted_crit:
                raise click.BadParameter('Incorrect value for `--criter`. '
                                         'Must be one of [`%s`]' %
                                         '`, `'.join(list_accepted_crit))
            ctx.meta['criter'] = value
            return value
        return click.option(
            '--criter', default='eer', help='Criterion to compute plots and '
            'metrics: `eer` (default), `hter`',
            callback=callback, is_eager=True ,**kwargs)(func)
    return custom_criterion_option

302
303
304
305

def far_option(**kwargs):
    '''Get option to get far value'''
    def custom_far_option(func):
306
        def callback(ctx, param, value):
307
            if value is not None and (value > 1 or value < 0):
308
309
                raise click.BadParameter("FAR value should be between 0 and 1")
            ctx.meta['far_value'] = value
310
311
            return value
        return click.option(
312
            '-f', '--far-value', type=click.FLOAT, default=None,
313
            help='The FAR value for which to compute metrics',
314
            callback=callback, show_default=True,**kwargs)(func)
315
    return custom_far_option
316

Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
317
318
319
320
321
322
323
324
325
326
327
328
def rank_option(**kwargs):
    '''Get option for rank parameter'''
    def custom_rank_option(func):
        def callback(ctx, param, value):
            value = 1 if value < 0 else value
            ctx.meta['rank'] = value
            return value
        return click.option(
            '--rank', type=click.INT, default=1,
            help='Given threshold for metrics computations',
            callback=callback, show_default=True,**kwargs)(func)
    return custom_rank_option
329

330
def label_option(name_option='x_label', **kwargs):
331
332
333
334
335
336
337
338
339
340
    '''Get labels options based on the given name.

    Parameters:
    ----------
    name_option: str, optional
        Name of the label option (e.g. x-lable, y1-label)
    '''
    def custom_label_option(func):
        def callback(ctx, param, value):
            ''' Get and save labels list in the context list '''
341
            ctx.meta[name_option.replace('-', '_')] = value if value is None else \
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
                    [int(i) for i in value.split(',')]
            return value
        return click.option(
            '--' + name_option,
            help='The id of figures which should have x_label separated by '
            'comma. For example ``--%s 1,2,4``.' % name_option,
            callback=callback, **kwargs)(func)
    return custom_label_option

def figsize_option(**kwargs):
    '''Get option for matplotlib figsize'''
    def custom_figsize_option(func):
        def callback(ctx, param, value):
            ctx.meta['figsize'] = value if value is None else \
                    [float(x) for x in value.split(',')]
            plt.figure(figsize=ctx.meta['figsize'])
            return value
        return click.option(
            '--figsize', help='If given, will run \
            ``plt.figure(figsize=figsize)(f)``. Example: --fig-size 4,6',
            callback=callback, **kwargs)(func)
    return custom_figsize_option

def legend_ncols_option(**kwargs):
    '''Get the number of columns to set in the legend of the plot'''
    def custom_legend_ncols_option(func):
        def callback(ctx, param, value):
            ctx.meta['legend_ncol'] = value
            return value
        return click.option(
            '--legend-ncol', default=3, show_default=True,
            type=INT, help='The number of columns of the legend layout.',
            callback=callback, **kwargs)(func)
    return custom_legend_ncols_option

def legend_loc_option(**kwargs):
    '''Get tthe legend location of the plot'''
    def custom_legend_loc_option(func):
        def callback(ctx, param, value):
            ctx.meta['legend_loc'] = value
            return value
        return click.option(
            '--legend-location', default=0, show_default=True,
            type=INT, help='The lengend location code',
            callback=callback, **kwargs)(func)
    return custom_legend_loc_option

def line_width_option(**kwargs):
    '''Get line width option for the plots'''
    def custom_line_width_option(func):
        def callback(ctx, param, value):
            ctx.meta['line_width'] = value
            return value
        return click.option(
            '--line-width',
            type=FLOAT, help='The line width of plots',
            callback=callback, **kwargs)(func)
    return custom_line_width_option

def marker_style_option(**kwargs):
    '''Get marker style otpion for the plots'''
    def custom_marker_style_option(func):
        def callback(ctx, param, value):
            ctx.meta['marker_style'] = value
            return value
        return click.option(
            '--marker-style',
            type=FLOAT, help='The marker style of the plots',
            callback=callback, **kwargs)(func)
    return custom_marker_style_option

def titles_option(**kwargs):
414
    '''Get the titles option for the different systems'''
415
416
    def custom_titles_option(func):
        def callback(ctx, param, value):
417
418
419
            if value is not None:
                value = value.split(',')
            ctx.meta['titles'] = value
420
421
            return value
        return click.option(
422
            '-ts', '--titles', type=click.STRING, default=None,
423
            help='The title for each system comma separated. '
424
425
426
427
            'Example: --titles ISV,CNN',
            callback=callback, **kwargs)(func)
    return custom_titles_option

428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
def title_option(**kwargs):
    '''Get the title option for the different systems'''
    def custom_title_option(func):
        def callback(ctx, param, value):
            ctx.meta['title'] = value
            return value
        return click.option(
            '-t', '--title', type=click.STRING, default=None,
            help='The title of the plots',
            callback=callback, **kwargs)(func)
    return custom_title_option

def x_label_option(dflt=None, **kwargs):
    '''Get the label option for X axis '''
    def custom_x_label_option(func):
        def callback(ctx, param, value):
            ctx.meta['x_label'] = value
            return value
        return click.option(
            '-xl', '--x-lable', type=click.STRING, default=dflt,
            help='Label for x-axis',
            callback=callback, **kwargs)(func)
    return custom_x_label_option

def y_label_option(dflt=None, **kwargs):
    '''Get the label option for Y axis '''
    def custom_y_label_option(func):
        def callback(ctx, param, value):
            ctx.meta['y_label'] = value
            return value
        return click.option(
            '-yl', '--y-lable', type=click.STRING, default=dflt,
            help='Label for y-axis',
            callback=callback, **kwargs)(func)
    return custom_y_label_option

464
465
466
467
468
469
470
471
472
473
474
475
476
def style_option(**kwargs):
    '''Get option for matplotlib style'''
    def custom_style_option(func):
        def callback(ctx, param, value):
            ctx.meta['style'] = value
            plt.style.use(value)
            return value
        return click.option(
            '--style', multiple=True, type=click.types.Choice(plt.style.available),
            help='The matplotlib style to use for plotting. You can provide '
            'multiple styles by repeating this option',
            callback=callback, **kwargs)(func)
    return custom_style_option