driver.py 5.18 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
# Laurent El Shafey <laurent.el-shafey@idiap.ch>
#
# Copyright (C) 2011-2013 Idiap Research Institute, Martigny, Switzerland
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.


"""Commands the PAD Filelists database can respond to.
"""

import os
import sys
from bob.db.base.driver import Interface as BaseInterface


def dumplist(args):
    """Dumps lists of files based on your criteria"""

    from .query import FileListPadDatabase
    db = FileListPadDatabase(args.list_directory, 'pad_filelist')

    r = db.objects(
        purposes=args.purpose,
        groups=args.group,
        protocol=args.protocol
    )

    output = sys.stdout
    if args.selftest:
        from bob.db.base.utils import null
        output = null()

    for f in r:
        output.write('%s\n' % f.make_path(directory=args.directory, extension=args.extension))

    return 0


def checkfiles(args):
    """Checks existence of files based on your criteria"""

    from .query import FileListPadDatabase
    db = FileListPadDatabase(args.list_directory, 'pad_filelist')

    r = db.objects(protocol=args.protocol)

    # go through all files, check if they are available on the filesystem
    good = []
    bad = []
    for f in r:
        if os.path.exists(f.make_path(args.directory, args.extension)):
            good.append(f)
        else:
            bad.append(f)

    # report
    output = sys.stdout
    if args.selftest:
        from bob.db.base.utils import null
        output = null()

    if bad:
        for f in bad:
            output.write('Cannot find file "%s"\n' % f.make_path(args.directory, args.extension))
        output.write('%d files (out of %d) were not found at "%s"\n' % (len(bad), len(r), args.directory))

    return 0


class Interface(BaseInterface):
    def name(self):
        return 'pad_filelist'

    def version(self):
        import pkg_resources  # part of setuptools
        return pkg_resources.require('bob.pad.base')[0].version

    def files(self):
        return ()

    def type(self):
        return 'text'

    def add_commands(self, parser):
        from . import __doc__ as docs

        subparsers = self.setup_parser(parser,
                                       "Presentation Attack Detection File Lists database", docs)

        import argparse

        # the "dumplist" action
        parser = subparsers.add_parser('dumplist', help=dumplist.__doc__)
        parser.add_argument('-l', '--list-directory', required=True,
                            help="The directory which contains the file lists.")
        parser.add_argument('-d', '--directory', default='',
                            help="if given, this path will be prepended to every entry returned.")
        parser.add_argument('-e', '--extension', default='',
                            help="if given, this extension will be appended to every entry returned.")
        parser.add_argument('-u', '--purpose',
                            help="if given, this value will limit the output files to those designed "
                                 "for the given purposes.",
                            choices=('real', 'attack', ''))
        parser.add_argument('-g', '--group',
                            help="if given, this value will limit the output files to those belonging to a "
                                 "particular protocolar group.",
                            choices=('dev', 'eval', 'train', ''))
        parser.add_argument('-p', '--protocol', default=None,
                            help="If set, the protocol is appended to the directory that contains the file lists.")
        parser.add_argument('--self-test', dest="selftest", action='store_true', help=argparse.SUPPRESS)
        parser.set_defaults(func=dumplist)  # action

        # the "checkfiles" action
        parser = subparsers.add_parser('checkfiles', help=checkfiles.__doc__)
        parser.add_argument('-l', '--list-directory', required=True,
                            help="The directory which contains the file lists.")
        parser.add_argument('-d', '--directory', dest="directory", default='',
                            help="if given, this path will be prepended to every entry returned.")
        parser.add_argument('-e', '--extension', dest="extension", default='',
                            help="if given, this extension will be appended to every entry returned.")
        parser.add_argument('-p', '--protocol', default=None,
                            help="If set, the protocol is appended to the directory that contains the file lists.")
        parser.add_argument('--self-test', dest="selftest", action='store_true', help=argparse.SUPPRESS)

        parser.set_defaults(func=checkfiles)  # action