common_options.py 17.4 KB
Newer Older
1 2 3 4
'''Stores click common options for plots'''

import logging
import click
5
from click.types import INT, FLOAT
6 7
import matplotlib.pyplot as plt
from matplotlib.backends.backend_pdf import PdfPages
8
from bob.extension.scripts.click_helper import (bool_option, list_float_option)
9

10
LOGGER = logging.getLogger(__name__)
11

12
def scores_argument(min_arg=1, force_eval=False, **kwargs):
13 14 15 16 17
    """Get the argument for scores, and add `dev-scores` and `eval-scores` in
    the context when `--evaluation` flag is on (default)

    Parameters
    ----------
18 19 20
    min_arg : int
        the minimum number of file needed to evaluate a system. For example,
        PAD functionalities needs licit abd spoof and therefore min_arg = 2
21 22 23

    Returns
    -------
24 25
     callable
      A decorator to be used for adding score arguments for click commands
26
    """
27 28
    def custom_scores_argument(func):
        def callback(ctx, param, value):
29 30 31
            min_a = min_arg or 1
            mutli = 1
            error = ''
32
            if ('evaluation' in ctx.meta and ctx.meta['evaluation']) or force_eval:
33 34 35 36 37 38 39 40 41 42
                mutli += 1
                error += '- %d evaluation file(s) \n' % min_a
            if 'train' in ctx.meta and ctx.meta['train']:
                mutli += 1
                error += '- %d training file(s) \n' % min_a
            #add more test here if other inputs are needed

            min_a *= mutli
            ctx.meta['min_arg'] = min_a
            if len(value) < 1 or len(value) % ctx.meta['min_arg'] != 0:
43
                raise click.BadParameter(
44 45 46 47
                    'The number of provided scores must be > 0 and a multiple of %d '
                    'because the following files are required:\n'
                    '- %d development file(s)\n' % (min_a, min_arg or 1) +
                    error, ctx=ctx
48
                )
49
            ctx.meta['scores'] = value
50
            return value
51 52 53 54
        return click.argument(
            'scores', type=click.Path(exists=True),
            callback=callback, **kwargs
        )(func)
55 56
    return custom_scores_argument

57 58 59 60 61 62
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
    )
63

64 65
def sep_dev_eval_option(dflt=True, **kwargs):
    '''Get option flag to say if dev and eval plots should be in different
66
    plots'''
67
    return bool_option(
68 69
        'split', 's','If set, evaluation and dev curve in different plots',
        dflt
70 71
    )

72 73 74 75 76
def linestyles_option(dflt=False, **kwargs):
    ''' Get option flag to turn on/off linestyles'''
    return bool_option('line-linestyles', 'S', 'If given, applies a different '
                       'linestyles to each line.', dflt, **kwargs)

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

82
def semilogx_option(dflt=False, **kwargs):
83
    '''Option to use semilog X-axis'''
84 85
    return bool_option('semilogx', 'G', 'If set, use semilog on X axis', dflt,
                       **kwargs)
86

87
def print_filenames_option(dflt=True, **kwargs):
88
    '''Option to tell if filenames should be in the title'''
89 90
    return bool_option('show-fn', 'P', 'If set, show filenames in title', dflt,
                       **kwargs)
91 92 93

def const_layout_option(dflt=True, **kwargs):
    '''Option to set matplotlib constrained_layout'''
94 95 96 97 98 99 100 101 102 103
    def custom_layout_option(func):
        def callback(ctx, param, value):
            ctx.meta['clayout'] = value
            plt.rcParams['figure.constrained_layout.use'] = value
            return value
        return click.option(
            '-Y', '--clayout/--no-clayout', default=dflt, show_default=True,
            help='(De)Activate constrained layout',
            callback=callback, **kwargs)(func)
    return custom_layout_option
104

105
def axes_val_option(dflt=None, **kwargs):
106
    ''' Option for setting min/max values on axes '''
107 108
    return list_float_option(
        name='axlim', short_name='L',
109 110
        desc='min/max axes values separated by commas (e.g. ``--axlim '
        ' 0.1,100,0.1,100``)',
111 112 113 114
        nitems=4, dflt=dflt, **kwargs
    )

def thresholds_option(**kwargs):
115
    ''' Option to give a list of thresholds '''
116 117
    return list_float_option(
        name='thres', short_name='T',
118 119
        desc='Given threshold for metrics computations, e.g. '
        '0.005,0.001,0.056',
120 121
        nitems=None, dflt=None, **kwargs
    )
122

123 124 125 126
def lines_at_option(**kwargs):
    '''Get option to draw const far line'''
    return list_float_option(
        name='lines-at', short_name='la',
127
        desc='If given, draw vertical lines at the given axis positions',
128
        nitems=None, dflt='1e-3', **kwargs
129 130
    )

131 132 133 134 135 136 137 138 139 140 141 142 143
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

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
def legend_ncols_option(dflt=10, **kwargs):
    '''Get option for number of columns for legends'''
    def custom_legend_ncols_option(func):
        def callback(ctx, param, value):
            value = abs(value)
            ctx.meta['legends_ncol'] = value
            return value
        return click.option(
            '-lc', '--legends-ncol', type=click.INT, default=dflt, show_default=True,
            help='The number of columns of the legend layout.',
            callback=callback, **kwargs)(func)
    return custom_legend_ncols_option

def subplot_option(dflt=111, **kwargs):
    '''Get option to set subplots'''
    def custom_subplot_option(func):
        def callback(ctx, param, value):
            value = abs(value)
            nrows = value // 10
            nrows, ncols = divmod(nrows, 10)
            ctx.meta['n_col'] = ncols
            ctx.meta['n_row'] = nrows
            return value
        return click.option(
            '-sp', '--subplot', type=click.INT, default=dflt, show_default=True,
            help='The order of subplots.',
            callback=callback, **kwargs)(func)
    return custom_subplot_option

173 174 175 176 177 178 179 180 181 182 183 184 185 186
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

187 188 189 190 191 192 193 194 195
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
                )
196
            ctx.meta['points'] = value
197 198 199 200 201 202 203 204 205 206 207
            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):
208 209
            if value is None:
                value = 'auto'
210 211 212 213 214 215
            else:
                tmp = value.split(',')
                try:
                    value = [int(i) if i != 'auto' else i for i in tmp]
                except Exception:
                    raise click.BadParameter('Incorrect number of bins inputs')
216 217 218
            ctx.meta['n_bins'] = value
            return value
        return click.option(
219 220 221 222
            '-b', '--nbins', type=click.STRING, default='auto',
            help='The number of bins for the different histograms in the '
            ' figure, seperated by commas. For example, if three histograms '
            'are in the plots, input something like `100,auto,50`',
223 224 225 226 227 228 229 230 231 232 233 234
            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(
235
            '--tablefmt', type=click.STRING, default='rst',
236
            show_default=True, help='Format for table display: `plain`, '
237
            '`simple`, `grid`, `fancy_grid`, `pipe`, `orgtbl`, '
238 239
            '`jira`, `presto`, `psql`, `rst`, `mediawiki`, `moinmoin`, '
            '`youtrack`, `html`, `latex`, '
240 241 242 243 244 245 246 247 248 249 250 251
            '`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)
252
            LOGGER.debug("Plots will be output in %s", value)
253 254 255 256 257 258 259 260
            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

261
def output_log_metric_option(**kwargs):
262
    '''Get options for output file for metrics'''
263
    def custom_output_log_file_option(func):
264 265
        def callback(ctx, param, value):
            if value is not None:
266
                LOGGER.debug("Metrics will be output in %s", value)
267 268 269 270 271 272 273
            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)
274
    return custom_output_log_file_option
275

276 277 278 279 280 281 282 283
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
    """
284 285
    def custom_criterion_option(func):
        def callback(ctx, param, value):
286 287
            list_accepted_crit = lcriteria if lcriteria is not None else \
                    ['eer', 'hter', 'far']
288
            if value not in list_accepted_crit:
Theophile GENTILHOMME's avatar
Theophile GENTILHOMME committed
289
                raise click.BadParameter('Incorrect value for `--criterion`. '
290 291
                                         'Must be one of [`%s`]' %
                                         '`, `'.join(list_accepted_crit))
292
            ctx.meta['criterion'] = value
293 294
            return value
        return click.option(
295 296
            '-c', '--criterion', default='eer',
            help='Criterion to compute plots and '
297 298 299 300
            'metrics: `eer` (default), `hter`',
            callback=callback, is_eager=True ,**kwargs)(func)
    return custom_criterion_option

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

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
def min_far_option(dflt=1e-4, **kwargs):
    '''Get option to get min far value'''
    def custom_min_far_option(func):
        def callback(ctx, param, value):
            if value is not None and (value > 1 or value < 0):
                raise click.BadParameter("FAR value should be between 0 and 1")
            ctx.meta['min_far_value'] = value
            return value
        return click.option(
            '-M', '--min-far-value', type=click.FLOAT, default=dflt,
            help='Select the minimum FAR value used in ROC and DET plots; '
            'should be a power of 10.',
            callback=callback, show_default=True,**kwargs)(func)
    return custom_min_far_option

330 331 332 333 334 335 336 337 338 339 340 341 342 343
def figsize_option(dflt='4,3', **kwargs):
    """Get option for matplotlib figsize

    Parameters
    ----------
    dflt : str
        matplotlib default figsize for the command. must be a a list of int
        separated by commas.

    Returns
    -------
    callable
        A decorator to be used for adding score arguments for click commands
    """
344 345 346 347
    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(',')]
348 349
            if value is not None:
                plt.rcParams['figure.figsize'] = ctx.meta['figsize']
350 351
            return value
        return click.option(
352
            '--figsize', default=dflt, help='If given, will run '
353
            '``plt.rcParams[\'figure.figsize\']=figsize)``. Example: --fig-size 4,6',
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
            callback=callback, **kwargs)(func)
    return custom_figsize_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

393 394 395
def legends_option(**kwargs):
    '''Get the legends option for the different systems'''
    def custom_legends_option(func):
396
        def callback(ctx, param, value):
397 398
            if value is not None:
                value = value.split(',')
399
            ctx.meta['legends'] = value
400 401
            return value
        return click.option(
402
            '-Z', '--legends', type=click.STRING, default=None,
403
            help='The title for each system comma separated. '
404
            'Example: --legends ISV,CNN',
405
            callback=callback, **kwargs)(func)
406
    return custom_legends_option
407

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
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

444 445 446 447 448 449 450 451
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(
452
            '--style', multiple=True, type=click.types.Choice(sorted(plt.style.available)),
453 454 455 456
            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