#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
"""Dataset interface allowing the user to query the UTFVP database"""
import six
from .models import *
from .driver import Interface
from sqlalchemy import and_, not_
import bob.db.base
SQLITE_FILE = Interface().files()[0]
[docs]class Database(bob.db.base.SQLiteDatabase):
"""The dataset class opens and maintains a connection opened to the Database.
It provides many different ways to probe for the characteristics of the data
and for the data itself inside the database.
"""
def __init__(self, original_directory=None, original_extension=None):
super(Database, self).__init__(SQLITE_FILE, File,
original_directory, original_extension)
[docs] def protocol_names(self):
"""Returns a list of all supported protocols"""
return tuple([k.name for k in self.query(Protocol).order_by(Protocol.name)])
[docs] def purposes(self):
"""Returns a list of all supported purposes"""
return Subset.purpose_choices
[docs] def groups(self):
"""Returns a list of all supported groups"""
return Subset.group_choices
[docs] def genders(self):
"""Returns a list of all supported gender values"""
return Client.gender_choices
[docs] def finger_names(self):
"""Returns a list of all supported finger name values"""
return Finger.name_choices
[docs] def sessions(self):
"""Returns a list of all supported session values"""
return File.session_choices
[docs] def file_from_model_id(self, model_id):
"""Returns the file in the database given a ``model_id``"""
return self.query(File).filter(File.model_id == model_id).one()
[docs] def finger_name_from_model_id(self, model_id):
"""Returns the unique finger name in the database given a ``model_id``"""
return self.file_from_model_id(model_id).unique_finger_name
[docs] def model_ids(self, protocol=None, groups=None):
"""Returns a set of models for a given protocol/group
Parameters:
protocol (:py:class:`str`, :py:class:`list`, optional): One or more of
the supported protocols. If not set, returns data from all protocols
groups (:py:class:`str`, :py:class:`list`, optional): One or more of the
supported groups. If not set, returns data from all groups. Notice this
parameter should either not set or set to ``dev``. Otherwise, this
method will return an empty list given we don't have a test set, only a
development set.
Returns:
list: A list of string corresponding model identifiers with the specified
filtering criteria
"""
protocols = None
if protocol:
valid_protocols = self.protocol_names()
protocols = self.check_parameters_for_validity(protocol, "protocol",
valid_protocols)
if groups:
valid_groups = self.groups()
groups = self.check_parameters_for_validity(groups, "group",
valid_groups)
retval = self.query(File)
joins = []
filters = []
subquery = self.query(Subset)
subfilters = []
if protocols:
subquery = subquery.join(Protocol)
subfilters.append(Protocol.name.in_(protocols))
if groups:
subfilters.append(Subset.group.in_(groups))
subfilters.append(Subset.purpose == 'enroll')
subsets = subquery.filter(*subfilters)
filters.append(File.subsets.any(Subset.id.in_([k.id for k in subsets])))
retval = retval.join(*joins).filter(*filters).distinct().order_by('id')
return sorted(set([k.model_id for k in retval.distinct()]))
[docs] def objects(self, protocol=None, groups=None, purposes=None,
model_ids=None, genders=None, finger_names=None, sessions=None):
"""Returns objects filtered by criteria
Parameters:
protocol (:py:class:`str`, :py:class:`list`, optional): One or more of
the supported protocols. If not set, returns data from all protocols
groups (:py:class:`str`, :py:class:`list`, optional): One or more of the
supported groups. If not set, returns data from all groups
purposes (:py:class:`str`, :py:class:`list`, optional): One or more of
the supported purposes. If not set, returns data for all purposes
model_ids (:py:class:`str`, :py:class:`list`, optional): If set, limit
output using the provided model identifiers
genders (:py:class:`str`, :py:class:`list`, optional): If set, limit
output using the provided gender identifiers
finger_names (:py:class:`str`, :py:class:`list`, optional): If set, limit
output using the provided finger name identifier
sessions (:py:class:`str`, :py:class:`list`, optional): If set, limit
output using the provided session identifiers
Returns:
list: A list of :py:class:`File` objects corresponding to the filtering
criteria.
"""
protocols = None
if protocol:
valid_protocols = self.protocol_names()
protocols = self.check_parameters_for_validity(protocol, "protocol",
valid_protocols)
if groups:
valid_groups = self.groups()
groups = self.check_parameters_for_validity(
groups, "group", valid_groups)
if purposes:
valid_purposes = self.purposes()
purposes = self.check_parameters_for_validity(purposes, "purpose",
valid_purposes)
# if only asking for 'probes', then ignore model_ids as all of our
# protocols do a full probe-model scan
if purposes and len(purposes) == 1 and 'probe' in purposes:
model_ids = None
if model_ids:
valid_model_ids = self.model_ids(protocol, groups)
model_ids = self.check_parameters_for_validity(model_ids, "model_ids",
valid_model_ids)
if genders:
valid_genders = self.genders()
genders = self.check_parameters_for_validity(genders, "genders",
valid_genders)
if finger_names:
valid_finger_names = self.finger_names()
finger_names = self.check_parameters_for_validity(finger_names,
"finger_names", valid_finger_names)
if sessions:
valid_sessions = self.sessions()
sessions = self.check_parameters_for_validity(sessions, "sessions",
valid_sessions)
retval = self.query(File)
joins = []
filters = []
if protocols or groups or purposes:
subquery = self.query(Subset)
subfilters = []
if protocols:
subquery = subquery.join(Protocol)
subfilters.append(Protocol.name.in_(protocols))
if groups:
subfilters.append(Subset.group.in_(groups))
if purposes:
subfilters.append(Subset.purpose.in_(purposes))
subsets = subquery.filter(*subfilters)
filters.append(File.subsets.any(Subset.id.in_([k.id for k in subsets])))
if genders or finger_names:
joins.append(Finger)
if genders:
fingers = self.query(Finger).join(
Client).filter(Client.gender.in_(genders))
filters.append(Finger.id.in_([k.id for k in fingers]))
if finger_names:
filters.append(Finger.name.in_(finger_names))
if sessions:
filters.append(File.session.in_(sessions))
if model_ids:
filters.append(File.model_id.in_(model_ids))
# special case for 1vsall protocol: if only one model id given, returns
# all but the sample for the model id in the list
if model_ids and len(model_ids) == 1 and \
protocols and len(protocols) == 1 and \
protocols[0] == '1vsall':
filters.append(~self.file_from_model_id(model_ids[0]))
retval = retval.join(*joins).filter(*filters).distinct().order_by('id')
return list(retval)