#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
# Tiago de Freitas Pereira <tiago.pereira@idiap.ch>
# Tue Aug 14 14:28:00 CEST 2015
#
# Copyright (C) 2012-2014 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/>.
import os
import six
from bob.db.base import utils
from .models import *
from .models import PROTOCOLS, GROUPS, PURPOSES
from .driver import Interface
import bob.db.base
SQLITE_FILE = Interface().files()[0]
class Database(bob.db.base.SQLiteDatabase):
"""Wrapper class for the CUHK-CUFS database for Heterogeneous face
recognition recognition
(http://mmlab.ie.cuhk_cufs.edu.hk/archive/facesketch.html).
"""
def __init__(self, original_directory=None, original_extension=None, arface_directory="", xm2vts_directory=""):
# call base class constructors to open a session to the database
super(Database, self).__init__(SQLITE_FILE, File,
original_directory, original_extension)
self.arface_directory = arface_directory
self.xm2vts_directory = xm2vts_directory
[docs] def protocols(self):
return PROTOCOLS
[docs] def purposes(self):
return PURPOSES
[docs] def original_file_name(self, file, check_existence=True):
"""
This function returns the original file name for the given File object.
**Parameters**
file: :py:class:`File`
The File objects for which the file name should be retrieved
check_existence: bool
Check if the original file exists? IGNORED: ALWAYS CHECK
**Return**
The original file name for the given File object
"""
# check if directory is set
original_directory = self.original_directory
if file.modality == "photo":
if file.client.original_database == "xm2vts":
original_directory = self.xm2vts_directory
elif file.client.original_database == "arface":
original_directory = self.arface_directory
if not original_directory or not self.original_extension:
raise ValueError(
"The original_directory and/or the original_extension were not specified in the constructor.")
# extract file name
file_name = ""
if type(self.original_extension) is list:
for e in self.original_extension:
file_name = file.make_path(original_directory, e)
if os.path.exists(file_name):
return file_name
else:
file_name = file.make_path(original_directory, self.original_extension)
if os.path.exists(file_name):
return file_name
raise ValueError("The file '%s' was not found. Please check the original directory '%s' and extension '%s'?" % (
file_name, original_directory, self.original_extension))
[docs] def annotations(self, file, annotation_type="eyes_center"):
"""
This function returns the annotations for the given file id as a dictionary.
**Parameters**
file: :py:class:`bob.db.base.File`
The File object you want to retrieve the annotations for,
**Return**
A dictionary of annotations, for face images usually something like {'leye':(le_y,le_x), 'reye':(re_y,re_x), ...},
or None if there are no annotations for the given file ID (which is the case in this base class implementation).
"""
return file.annotations(annotation_type=annotation_type)
[docs] def objects(self, groups=None, protocol=None, purposes=None, model_ids=None, **kwargs):
"""
This function returns lists of File objects, which fulfill the given restrictions.
"""
# Checking inputs
groups = self.check_parameters_for_validity(groups, "group", GROUPS)
protocols = self.check_parameters_for_validity(
protocol, "protocol", PROTOCOLS)
purposes = self.check_parameters_for_validity(
purposes, "purpose", PURPOSES)
# You need to select only one protocol
if (len(protocols) > 1):
raise ValueError(
"Please, select only one of the following protocols {0}".format(protocols))
# Querying
query = self.query(bob.db.cuhk_cufs.File, bob.db.cuhk_cufs.Protocol_File_Association).join(
bob.db.cuhk_cufs.Protocol_File_Association).join(bob.db.cuhk_cufs.Client)
# filtering
query = query.filter(
bob.db.cuhk_cufs.Protocol_File_Association.group.in_(groups))
query = query.filter(
bob.db.cuhk_cufs.Protocol_File_Association.protocol.in_(protocols))
query = query.filter(
bob.db.cuhk_cufs.Protocol_File_Association.purpose.in_(purposes))
if model_ids is not None and not 'probe' in purposes:
if type(model_ids) is not list and type(model_ids) is not tuple:
model_ids = [model_ids]
# if you provide a client object as input and not the ids
if type(model_ids[0]) is bob.db.cuhk_cufs.Client:
model_aux = []
for m in model_ids:
model_aux.append(m.id)
model_ids = model_aux
query = query.filter(bob.db.cuhk_cufs.Client.id.in_(model_ids))
raw_files = query.all()
files = []
for f in raw_files:
f[0].group = f[1].group
f[0].purpose = f[1].purpose
f[0].protocol = f[1].protocol
files.append(f[0])
return files
[docs] def clients(self, protocol=None, groups=None):
# Checking inputs
groups = self.check_parameters_for_validity(groups, "group", GROUPS)
protocols = self.check_parameters_for_validity(
protocol, "protocol", PROTOCOLS)
# You need to select only one protocol
if (len(protocols) > 1):
raise ValueError(
"Please, select only one of the following protocols {0}".format(protocols))
# Querying
query = self.query(bob.db.cuhk_cufs.Client).join(
bob.db.cuhk_cufs.File).join(bob.db.cuhk_cufs.Protocol_File_Association)
# filtering
query = query.filter(
bob.db.cuhk_cufs.Protocol_File_Association.group.in_(groups))
query = query.filter(
bob.db.cuhk_cufs.Protocol_File_Association.protocol.in_(protocols))
return query.all()
[docs] def model_ids(self, protocol=None, groups=None):
return [c.id for c in self.clients(protocol=protocol, groups=groups)]
[docs] def groups(self, protocol=None, **kwargs):
"""This function returns the list of groups for this database."""
return GROUPS
# score normalization methods
[docs] def zclients(self, protocol=None):
"""Returns a set of Z-Norm clients for the specific query by the user."""
return self.clients(protocol=protocol, groups="world")
[docs] def tclients(self, protocol=None):
"""Returns a set of T-Norm clients for the specific query by the user."""
return self.zclients(protocol=protocol)
[docs] def zobjects(self, protocol=None, groups=None):
"""Returns a set of Z-Norm objects for the specific query by the user."""
# Checking inputs
protocols = self.check_parameters_for_validity(
protocol, "protocol", PROTOCOLS)
# You need to select only one protocol
if (len(protocols) > 1):
raise ValueError(
"Please, select only one of the following protocols {0}".format(protocols))
# Querying
query = self.query(bob.db.cuhk_cufs.File).join(
bob.db.cuhk_cufs.Protocol_File_Association)
# filtering
query = query.filter(
bob.db.cuhk_cufs.Protocol_File_Association.protocol.in_(protocols))
query = query.filter(
bob.db.cuhk_cufs.Protocol_File_Association.group == "world")
# THE MOST IMPORTANT THING IN THE METHOD
# IF THE PROTOCOL IS PHOTO --> SKETCH, THE T-OBJECTS ARE PHOTOS
# IF THE PROTOCOL IS SKETCH --> PHOTO, THE T-OBJECTS ARE SKETCHES
if "p2s" in protocol:
query = query.filter(bob.db.cuhk_cufs.File.modality == "photo")
else:
query = query.filter(bob.db.cuhk_cufs.File.modality == "sketch")
return query.all()
[docs] def tobjects(self, protocol=None, model_ids=None, groups=None):
"""Returns a set of T-Norm objects for the specific query by the user."""
return self.zobjects(protocol=protocol)
[docs] def tmodel_ids(self, groups=None, protocol=None, **kwargs):
"""This function returns the ids of the T-Norm models of the given groups for the given protocol."""
return ["t_" + str(c.id) for c in self.tclients(protocol=protocol)]