Skip to content
Snippets Groups Projects
Commit f27b6449 authored by Manuel Günther's avatar Manuel Günther
Browse files

Removed Client and updated documentation

parent f8970c90
No related branches found
No related tags found
1 merge request!95Resolve "There is absolutely no need for having a "Client" class in the FileListDatabase implementation"
Pipeline #
Hide whitespace changes
Inline Side-by-side
bob/bio/base/database/__init__.py
+ 2
− 4
View file @ f27b6449
...@@ -2,8 +2,7 @@ from .file import BioFile ...@@ -2,8 +2,7 @@ from .file import BioFile
from .file import BioFileSet from .file import BioFileSet
from .database import BioDatabase from .database import BioDatabase
from .database import ZTBioDatabase from .database import ZTBioDatabase
from .filelist.query import FileListBioDatabase from .filelist import FileListBioDatabase
from .filelist.models import Client
from . import filelist from . import filelist
# gets sphinx autodoc done right - don't remove it # gets sphinx autodoc done right - don't remove it
...@@ -27,7 +26,6 @@ __appropriate__( ...@@ -27,7 +26,6 @@ __appropriate__(
BioFileSet, BioFileSet,
BioDatabase, BioDatabase,
ZTBioDatabase, ZTBioDatabase,
FileListBioDatabase, FileListBioDatabase
Client,
) )
__all__ = [_ for _ in dir() if not _.startswith('_')] __all__ = [_ for _ in dir() if not _.startswith('_')]
bob/bio/base/database/file.py
+ 17
− 14
View file @ f27b6449
...@@ -5,21 +5,24 @@ import bob.db.base ...@@ -5,21 +5,24 @@ import bob.db.base
class BioFile(bob.db.base.File): class BioFile(bob.db.base.File):
"""A simple base class that defines basic properties of File object for the use in verification experiments""" """A simple base class that defines basic properties of File object for the use in verification experiments
def __init__(self, client_id, path, file_id=None): Parameters
"""**Constructor Documentation** ----------
client_id : object
The id of the client this file belongs to.
Its type depends on your implementation.
If you use an SQL database, this should be an SQL type like Integer or String.
Initialize the File object with the minimum required data. file_id : object
see :py:class:`bob.db.base.File` constructor
Parameters: path : object
see :py:class:`bob.db.base.File` constructor
"""
client_id : various type def __init__(self, client_id, path, file_id=None):
The id of the client this file belongs to.
Its type depends on your implementation.
If you use an SQL database, this should be an SQL type like Integer or String.
For path and file_id, please refer to :py:class:`bob.db.base.File` constructor
"""
bob.db.base.File.__init__(self, path, file_id) bob.db.base.File.__init__(self, path, file_id)
# just copy the information # just copy the information
...@@ -34,18 +37,18 @@ class BioFileSet(BioFile): ...@@ -34,18 +37,18 @@ class BioFileSet(BioFile):
type :py:class:`bob.bio.base.database.BioFile` of the same client. type :py:class:`bob.bio.base.database.BioFile` of the same client.
The file set id can be anything hashable, but needs to be unique all over the database. The file set id can be anything hashable, but needs to be unique all over the database.
**Parameters:** Parameters
----------
file_set_id : str or int file_set_id : str or int
A unique ID that identifies the file set. A unique ID that identifies the file set.
files : [:py:class:`bob.bio.base.database.BioFile`] files : [:py:class:`bob.bio.base.database.BioFile`]
A non-empty list of BioFile objects that should be stored inside this file. A non-empty list of BioFile objects that should be stored inside this file.
All files of that list need to have the same client ID. All files of that list need to have the same client ID.
""" """
def __init__(self, file_set_id, files, path=None): def __init__(self, file_set_id, files, path=None):
"""The list of :py:class:`bob.bio.base.database.BioFile` objects stored in this file set"""
# don't accept empty file lists # don't accept empty file lists
assert len(files), "Cannot create an empty BioFileSet" assert len(files), "Cannot create an empty BioFileSet"
......
bob/bio/base/database/filelist/__init__.py
+ 1
− 3
View file @ f27b6449
from .models import ListReader, Client, FileListFile from .models import FileListFile
from .query import FileListBioDatabase from .query import FileListBioDatabase
from .driver import Interface from .driver import Interface
...@@ -20,8 +20,6 @@ def __appropriate__(*args): ...@@ -20,8 +20,6 @@ def __appropriate__(*args):
__appropriate__( __appropriate__(
ListReader,
Client,
FileListFile, FileListFile,
FileListBioDatabase, FileListBioDatabase,
Interface, Interface,
......
bob/bio/base/database/filelist/models.py
+ 5
− 12
View file @ f27b6449
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
""" """
This file defines simple Client and File interfaces that are comparable with other bob.db databases. This file defines a simple interface that are comparable with other bob.db databases.
""" """
import os import os
...@@ -26,16 +26,6 @@ import fileinput ...@@ -26,16 +26,6 @@ import fileinput
import re import re
class Client(object):
"""
The clients of this database contain ONLY client ids. Nothing special.
"""
def __init__(self, client_id):
self.id = client_id
"""The ID of the client, which is stored as a :py:class:`str` object."""
class FileListFile(object): class FileListFile(object):
""" """
Initialize the File object with the minimum required data. Initialize the File object with the minimum required data.
...@@ -43,16 +33,19 @@ class FileListFile(object): ...@@ -43,16 +33,19 @@ class FileListFile(object):
If the ``model_id`` is not specified, ``model_id`` and ``client_id`` are identical. If the ``model_id`` is not specified, ``model_id`` and ``client_id`` are identical.
If the ``claimed_id`` is not specified, it is expected to be the ``client_id``. If the ``claimed_id`` is not specified, it is expected to be the ``client_id``.
**Parameters** Parameters
----------
client_id : various type client_id : various type
The id of the client, this file belongs to. The id of the client, this file belongs to.
The type of it is dependent on your implementation. The type of it is dependent on your implementation.
If you use an SQL database, this should be an SQL type like Integer or String. If you use an SQL database, this should be an SQL type like Integer or String.
path : str path : str
The path of this file, relative to the basic directory. The path of this file, relative to the basic directory.
If you use an SQL database, this should be the SQL type String. If you use an SQL database, this should be the SQL type String.
Please do not specify any file extensions. Please do not specify any file extensions.
file_id : various type file_id : various type
The id of the file. The id of the file.
The type of it is dependent on your implementation. The type of it is dependent on your implementation.
......
bob/bio/base/database/filelist/query.py
+ 169
− 131
View file @ f27b6449
...@@ -8,13 +8,14 @@ import bob.db.base ...@@ -8,13 +8,14 @@ import bob.db.base
from .. import ZTBioDatabase from .. import ZTBioDatabase
from .. import BioFile from .. import BioFile
from . import ListReader, Client from .models import ListReader
class FileListBioDatabase(ZTBioDatabase): class FileListBioDatabase(ZTBioDatabase):
"""This class provides a user-friendly interface to databases that are given as file lists. """This class provides a user-friendly interface to databases that are given as file lists.
Keyword parameters: Parameters
----------
filelists_directory : str filelists_directory : str
The directory that contains the filelists defining the protocol(s). If you use the protocol The directory that contains the filelists defining the protocol(s). If you use the protocol
...@@ -27,65 +28,66 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -27,65 +28,66 @@ class FileListBioDatabase(ZTBioDatabase):
protocol : str protocol : str
The protocol of the database. This should be a folder inside ``filelists_directory``. The protocol of the database. This should be a folder inside ``filelists_directory``.
bio_file_class : class bio_file_class : ``class``
The class that should be used for return the files. The class that should be used to return the files.
This can be `BioFile`, `AudioBioFile`, `FaceBioFile`, or anything similar. This can be :py:class:`bob.bio.base.database.BioFile`, :py:class:`bob.bio.spear.database.AudioBioFile`, :py:class:`bob.bio.face.database.FaceBioFile`, or anything similar.
original_directory : str or ``None`` original_directory : str or ``None``
The directory, where the original data can be found The directory, where the original data can be found.
original_extension : str or [str] or ``None`` original_extension : str or [str] or ``None``
The filename extension of the original data, or multiple extensions The filename extension of the original data, or multiple extensions.
annotation_directory : str or ``None`` annotation_directory : str or ``None``
The directory, where additional annotation files can be found The directory, where additional annotation files can be found.
annotation_extension : str or ``None`` annotation_extension : str or ``None``
The filename extension of the annoation files The filename extension of the annotation files.
annotation_type : str or ``None`` annotation_type : str or ``None``
The type of annotation that can be read. The type of annotation that can be read.
Currently, options are 'eyecenter', 'named', 'idiap'. Currently, options are ``'eyecenter', 'named', 'idiap'``.
See :py:func:`bob.db.base.read_annotation_file` for details. See :py:func:`bob.db.base.read_annotation_file` for details.
dev_sub_directory : str or ``None`` dev_sub_directory : str or ``None``
Specify a custom subdirectory for the filelists of the development set (default is 'dev') Specify a custom subdirectory for the filelists of the development set (default is ``'dev'``)
eval_sub_directory : str or ``None`` eval_sub_directory : str or ``None``
Specify a custom subdirectory for the filelists of the development set (default is 'eval') Specify a custom subdirectory for the filelists of the development set (default is ``'eval'``)
world_filename : str or ``None`` world_filename : str or ``None``
Specify a custom filename for the training filelist (default is 'norm/train_world.lst') Specify a custom filename for the training filelist (default is ``'norm/train_world.lst'``)
optional_world_1_filename : str or ``None`` optional_world_1_filename : str or ``None``
Specify a custom filename for the (first optional) training filelist Specify a custom filename for the (first optional) training filelist
(default is 'norm/train_optional_world_1.lst') (default is ``'norm/train_optional_world_1.lst'``)
optional_world_2_filename : str or ``None`` optional_world_2_filename : str or ``None``
Specify a custom filename for the (second optional) training filelist Specify a custom filename for the (second optional) training filelist
(default is 'norm/train_optional_world_2.lst') (default is ``'norm/train_optional_world_2.lst'``)
models_filename : str or ``None`` models_filename : str or ``None``
Specify a custom filename for the model filelists (default is 'for_models.lst') Specify a custom filename for the model filelists (default is ``'for_models.lst'``)
probes_filename : str or ``None`` probes_filename : str or ``None``
Specify a custom filename for the probes filelists (default is 'for_probes.lst') Specify a custom filename for the probes filelists (default is ``'for_probes.lst'``)
scores_filename : str or ``None`` scores_filename : str or ``None``
Specify a custom filename for the scores filelists (default is 'for_scores.lst') Specify a custom filename for the scores filelists (default is ``'for_scores.lst'``)
tnorm_filename : str or ``None`` tnorm_filename : str or ``None``
Specify a custom filename for the T-norm scores filelists (default is 'for_tnorm.lst') Specify a custom filename for the T-norm scores filelists (default is ``'for_tnorm.lst'``)
znorm_filename : str or ``None`` znorm_filename : str or ``None``
Specify a custom filename for the Z-norm scores filelists (default is 'for_znorm.lst') Specify a custom filename for the Z-norm scores filelists (default is ``'for_znorm.lst'``)
use_dense_probe_file_list : bool or None use_dense_probe_file_list : bool or None
Specify which list to use among 'probes_filename' (dense) or 'scores_filename'. Specify which list to use among ``probes_filename`` (dense) or ``scores_filename``.
If ``None`` it is tried to be estimated based on the given parameters. If ``None`` it is tried to be estimated based on the given parameters.
keep_read_lists_in_memory : bool keep_read_lists_in_memory : bool
If set to true, the lists are read only once and stored in memory If set to ``True`` (the default), the lists are read only once and stored in memory.
Otherwise the lists will be re-read for every query (not recommended).
""" """
def __init__( def __init__(
...@@ -198,7 +200,26 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -198,7 +200,26 @@ class FileListBioDatabase(ZTBioDatabase):
def _make_bio(self, files): def _make_bio(self, files):
return [self.bio_file_class(client_id=f.client_id, path=f.path, file_id=f.id) for f in files] return [self.bio_file_class(client_id=f.client_id, path=f.path, file_id=f.id) for f in files]
def all_files(self, groups=['dev'], add_zt_files=True): def all_files(self, groups=['dev'], add_zt_files=True):
"""Returns all files for the given group. The internally stored protocol is used, throughout.
Parameters
----------
groups : [str]
A list of groups to retrieve the files for.
add_zt_files : bool
If selected, also files for ZT-norm scoring will be added.
Please select this option only if this dataset provides ZT-norm files, see :py:meth:`implements_zt`.
Returns
-------
[BioFile]
A list of all files that fulfill your query.
"""
files = self.objects(groups, self.protocol, **self.all_files_options) files = self.objects(groups, self.protocol, **self.all_files_options)
# add all files that belong to the ZT-norm # add all files that belong to the ZT-norm
for group in groups: for group in groups:
...@@ -211,11 +232,16 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -211,11 +232,16 @@ class FileListBioDatabase(ZTBioDatabase):
files += self.zobjects(group, self.protocol, **self.z_probe_options) files += self.zobjects(group, self.protocol, **self.z_probe_options)
return self.sort(self._make_bio(files)) return self.sort(self._make_bio(files))
def groups(self, protocol=None, add_world=True, add_subworld=True): def groups(self, protocol=None, add_world=True, add_subworld=True):
"""This function returns the list of groups for this database. """This function returns the list of groups for this database.
Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol for which the groups should be retrieved. The protocol for which the groups should be retrieved.
If ``None``, the internally stored protocol is used.
add_world : bool add_world : bool
Add the world groups? Add the world groups?
...@@ -223,9 +249,12 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -223,9 +249,12 @@ class FileListBioDatabase(ZTBioDatabase):
add_subworld : bool add_subworld : bool
Add the sub-world groups? Only valid, when ``add_world=True`` Add the sub-world groups? Only valid, when ``add_world=True``
Returns: a list of groups Returns
""" -------
[str]
A list of groups
"""
groups = [] groups = []
protocol = protocol or self.protocol protocol = protocol or self.protocol
if protocol is not None: if protocol is not None:
...@@ -256,18 +285,23 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -256,18 +285,23 @@ class FileListBioDatabase(ZTBioDatabase):
groups.append('optional_world_2') groups.append('optional_world_2')
return groups return groups
def implements_zt(self, protocol=None, groups=None): def implements_zt(self, protocol=None, groups=None):
"""Checks if the file lists for the ZT score normalization are available. """Checks if the file lists for the ZT score normalization are available.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol for which the groups should be retrieved. The protocol for which the groups should be retrieved.
groups : str or [str] or ``None`` groups : str or [str] or ``None``
The groups for which the ZT score normalization file lists should be checked ("dev", "eval"). The groups for which the ZT score normalization file lists should be checked ``('dev', 'eval')``.
Returns: Returns
-------
bool
``True`` if the all file lists for ZT score normalization exist, otherwise ``False``. ``True`` if the all file lists for ZT score normalization exist, otherwise ``False``.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
...@@ -336,20 +370,25 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -336,20 +370,25 @@ class FileListBioDatabase(ZTBioDatabase):
def client_id_from_model_id(self, model_id, group='dev'): def client_id_from_model_id(self, model_id, group='dev'):
"""Returns the client id that is connected to the given model id. """Returns the client id that is connected to the given model id.
Keyword parameters: Parameters
----------
model_id : str or ``None`` model_id : str or ``None``
The model id for which the client id should be returned. The model id for which the client id should be returned.
groups : str or [str] or ``None`` groups : str or [str] or ``None``
(optional) the groups, the client belongs to. (optional) the groups, the client belongs to.
Might be one or more of ('dev', 'eval', 'world', 'optional_world_1', 'optional_world_2'). Might be one or more of ``('dev', 'eval', 'world', 'optional_world_1', 'optional_world_2')``.
If groups are given, only these groups are considered. If groups are given, only these groups are considered.
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider.
Returns: The client id for the given model id, if found. Returns
-------
str
The client id for the given model id, if found.
""" """
protocol = self.protocol protocol = self.protocol
groups = self.check_parameters_for_validity(group, "group", groups = self.check_parameters_for_validity(group, "group",
...@@ -367,20 +406,22 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -367,20 +406,22 @@ class FileListBioDatabase(ZTBioDatabase):
def client_id_from_t_model_id(self, t_model_id, group='dev'): def client_id_from_t_model_id(self, t_model_id, group='dev'):
"""Returns the client id that is connected to the given T-Norm model id. """Returns the client id that is connected to the given T-Norm model id.
Keyword parameters: Parameters
----------
model_id : str or ``None`` model_id : str or ``None``
The model id for which the client id should be returned. The model id for which the client id should be returned.
groups : str or [str] or ``None`` groups : str or [str] or ``None``
(optional) the groups, the client belongs to. (optional) the groups, the client belongs to.
Might be one or more of ('dev', 'eval'). Might be one or more of ``('dev', 'eval')``.
If groups are given, only these groups are considered. If groups are given, only these groups are considered.
protocol : str or ``None`` Returns
The protocol to consider -------
Returns: The client id for the given model id of a T-Norm model, if found. str
The client id for the given model id of a T-Norm model, if found.
""" """
protocol = self.protocol protocol = self.protocol
groups = self.check_parameters_for_validity(group, "group", self.groups(protocol, add_world=False)) groups = self.check_parameters_for_validity(group, "group", self.groups(protocol, add_world=False))
...@@ -394,58 +435,6 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -394,58 +435,6 @@ class FileListBioDatabase(ZTBioDatabase):
raise ValueError( raise ValueError(
"The given T-norm model id '%s' cannot be found in one of the groups '%s'" % (t_model_id, groups)) "The given T-norm model id '%s' cannot be found in one of the groups '%s'" % (t_model_id, groups))
def clients(self, protocol=None, groups=None):
"""Returns a list of :py:class:`bob.bio.base.database.Client` objects for the specific query by the user.
Keyword Parameters:
protocol : str or ``None``
The protocol to consider
groups : str or [str] or ``None``
The groups to which the clients belong ("dev", "eval", "world", "optional_world_1", "optional_world_2").
Returns: A list containing all the :py:class:`bob.bio.base.database.Client` objects which have the given properties.
"""
protocol = protocol or self.protocol
client_ids = self.client_ids(protocol, groups)
return [Client(id) for id in client_ids]
def tclients(self, protocol=None, groups=None):
"""Returns a list of T-Norm :py:class:`bob.bio.base.database.Client` objects for the specific query by the user.
Keyword Parameters:
protocol : str or ``None``
The protocol to consider
groups : str or [str] or ``None``
The groups to which the clients belong ("dev", "eval").
Returns: A list containing all the T-Norm :py:class:`bob.bio.base.database.Client` objects which have the given properties.
"""
protocol = protocol or self.protocol
tclient_ids = self.tclient_ids(protocol, groups)
return [Client(id) for id in tclient_ids]
def zclients(self, protocol=None, groups=None):
"""Returns a list of Z-Norm Client objects for the specific query by the user.
Keyword Parameters:
protocol : str or ``None``
The protocol to consider
groups : str or [str] or ``None``
The groups to which the models belong ("dev", "eval").
Returns: A list containing all the Z-Norm Client objects which have the given properties.
"""
protocol = protocol or self.protocol
zclient_ids = self.zclient_ids(protocol, groups)
return [Client(id) for id in zclient_ids]
def __client_id_list__(self, groups, type, protocol=None): def __client_id_list__(self, groups, type, protocol=None):
ids = set() ids = set()
protocol = protocol or self.protocol protocol = protocol or self.protocol
...@@ -459,15 +448,20 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -459,15 +448,20 @@ class FileListBioDatabase(ZTBioDatabase):
def client_ids(self, protocol=None, groups=None): def client_ids(self, protocol=None, groups=None):
"""Returns a list of client ids for the specific query by the user. """Returns a list of client ids for the specific query by the user.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider
groups : str or [str] or ``None`` groups : str or [str] or ``None``
The groups to which the clients belong ("dev", "eval", "world", "optional_world_1", "optional_world_2"). The groups to which the clients belong ``('dev', 'eval', 'world', 'optional_world_1', 'optional_world_2')``.
Returns
-------
Returns: A list containing all the client ids which have the given properties. [str]
A list containing all the client ids which have the given properties.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
...@@ -480,7 +474,8 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -480,7 +474,8 @@ class FileListBioDatabase(ZTBioDatabase):
def tclient_ids(self, protocol=None, groups=None): def tclient_ids(self, protocol=None, groups=None):
"""Returns a list of T-Norm client ids for the specific query by the user. """Returns a list of T-Norm client ids for the specific query by the user.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider
...@@ -488,7 +483,11 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -488,7 +483,11 @@ class FileListBioDatabase(ZTBioDatabase):
groups : str or [str] or ``None`` groups : str or [str] or ``None``
The groups to which the clients belong ("dev", "eval"). The groups to which the clients belong ("dev", "eval").
Returns: A list containing all the T-Norm client ids which have the given properties. Returns
-------
[str]
A list containing all the T-Norm client ids which have the given properties.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
...@@ -499,7 +498,8 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -499,7 +498,8 @@ class FileListBioDatabase(ZTBioDatabase):
def zclient_ids(self, protocol=None, groups=None): def zclient_ids(self, protocol=None, groups=None):
"""Returns a list of Z-Norm client ids for the specific query by the user. """Returns a list of Z-Norm client ids for the specific query by the user.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider
...@@ -507,7 +507,11 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -507,7 +507,11 @@ class FileListBioDatabase(ZTBioDatabase):
groups : str or [str] or ``None`` groups : str or [str] or ``None``
The groups to which the clients belong ("dev", "eval"). The groups to which the clients belong ("dev", "eval").
Returns: A list containing all the Z-Norm client ids which have the given properties. Returns
-------
[str]
A list containing all the Z-Norm client ids which have the given properties.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
...@@ -527,15 +531,20 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -527,15 +531,20 @@ class FileListBioDatabase(ZTBioDatabase):
def model_ids_with_protocol(self, groups=None, protocol=None, **kwargs): def model_ids_with_protocol(self, groups=None, protocol=None, **kwargs):
"""Returns a list of model ids for the specific query by the user. """Returns a list of model ids for the specific query by the user.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider
groups : str or [str] or ``None`` groups : str or [str] or ``None``
The groups to which the models belong ("dev", "eval", "world", "optional_world_1", "optional_world_2"). The groups to which the models belong ``('dev', 'eval', 'world', 'optional_world_1', 'optional_world_2')``.
Returns: A list containing all the model ids which have the given properties. Returns
-------
[str]
A list containing all the model ids which have the given properties.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
groups = self.check_parameters_for_validity(groups, "group", self.groups(protocol=protocol)) groups = self.check_parameters_for_validity(groups, "group", self.groups(protocol=protocol))
...@@ -545,15 +554,20 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -545,15 +554,20 @@ class FileListBioDatabase(ZTBioDatabase):
def tmodel_ids_with_protocol(self, protocol=None, groups=None, **kwargs): def tmodel_ids_with_protocol(self, protocol=None, groups=None, **kwargs):
"""Returns a list of T-Norm model ids for the specific query by the user. """Returns a list of T-Norm model ids for the specific query by the user.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider
groups : str or [str] or ``None`` groups : str or [str] or ``None``
The groups to which the models belong ("dev", "eval"). The groups to which the models belong ``('dev', 'eval')``.
Returns
-------
Returns: A list containing all the T-Norm model ids belonging to the given group. [str]
A list containing all the T-Norm model ids belonging to the given group.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
groups = self.check_parameters_for_validity(groups, "group", self.groups(protocol, add_world=False)) groups = self.check_parameters_for_validity(groups, "group", self.groups(protocol, add_world=False))
...@@ -563,33 +577,40 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -563,33 +577,40 @@ class FileListBioDatabase(ZTBioDatabase):
def objects(self, groups=None, protocol=None, purposes=None, model_ids=None, classes=None, **kwargs): def objects(self, groups=None, protocol=None, purposes=None, model_ids=None, classes=None, **kwargs):
"""Returns a set of :py:class:`bob.bio.base.database.BioFile` objects for the specific query by the user. """Returns a set of :py:class:`bob.bio.base.database.BioFile` objects for the specific query by the user.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider
purposes : str or [str] or ``None`` purposes : str or [str] or ``None``
The purposes required to be retrieved ("enroll", "probe") or a tuple The purposes required to be retrieved ``('enroll', 'probe')`` or a tuple
with several of them. If 'None' is given (this is the default), it is with several of them. If ``None`` is given (this is the default), it is
considered the same as a tuple with all possible values. This field is considered the same as a tuple with all possible values. This field is
ignored for the data from the "world", "optional_world_1", "optional_world_2" groups. ignored for the data from the ``'world', 'optional_world_1', 'optional_world_2'`` groups.
model_ids : str or [str] or ``None`` model_ids : str or [str] or ``None``
Only retrieves the files for the provided list of model ids (claimed Only retrieves the files for the provided list of model ids (claimed
client id). If 'None' is given (this is the default), no filter over client id). If ``None`` is given (this is the default), no filter over
the model_ids is performed. the model_ids is performed.
groups : str or [str] or ``None`` groups : str or [str] or ``None``
One of the groups ("dev", "eval", "world", "optional_world_1", "optional_world_2") or a tuple with several of them. One of the groups ``('dev', 'eval', 'world', 'optional_world_1', 'optional_world_2')`` or a tuple with several of them.
If 'None' is given (this is the default), it is considered to be the existing subset of ``("world", "dev", "eval")``. If ``None`` is given (this is the default), it is considered to be the existing subset of ``('world', 'dev', 'eval')``.
classes : str or [str] or ``None`` classes : str or [str] or ``None``
The classes (types of accesses) to be retrieved ('client', 'impostor') The classes (types of accesses) to be retrieved ``('client', 'impostor')``
or a tuple with several of them. If 'None' is given (this is the or a tuple with several of them. If ``None`` is given (this is the
default), it is considered the same as a tuple with all possible values. default), it is considered the same as a tuple with all possible values.
Note: classes are not allowed to be specified when the 'probes_filename' is used.
Returns: A list of :py:class:`bob.bio.base.database.BioFile` objects considering all the filtering criteria. .. note::
Classes are not allowed to be specified when 'probes_filename' is used in the constructor.
Returns
-------
[BioFile]
A list of :py:class:`BioFile` objects considering all the filtering criteria.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
...@@ -673,20 +694,25 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -673,20 +694,25 @@ class FileListBioDatabase(ZTBioDatabase):
def tobjects(self, groups=None, protocol=None, model_ids=None, **kwargs): def tobjects(self, groups=None, protocol=None, model_ids=None, **kwargs):
"""Returns a list of :py:class:`bob.bio.base.database.BioFile` objects for enrolling T-norm models for score normalization. """Returns a list of :py:class:`bob.bio.base.database.BioFile` objects for enrolling T-norm models for score normalization.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider
model_ids : str or [str] or ``None`` model_ids : str or [str] or ``None``
Only retrieves the files for the provided list of model ids (claimed Only retrieves the files for the provided list of model ids (claimed
client id). If 'None' is given (this is the default), no filter over client id). If ``None`` is given (this is the default), no filter over
the model_ids is performed. the model_ids is performed.
groups : str or [str] or ``None`` groups : str or [str] or ``None``
The groups to which the models belong ("dev", "eval"). The groups to which the models belong ``('dev', 'eval')``.
Returns: A list of :py:class:`bob.bio.base.database.BioFile` objects considering all the filtering criteria. Returns
-------
[BioFile]
A list of :py:class:`BioFile` objects considering all the filtering criteria.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
groups = self.check_parameters_for_validity(groups, "group", self.groups(protocol, add_world=False)) groups = self.check_parameters_for_validity(groups, "group", self.groups(protocol, add_world=False))
...@@ -706,17 +732,22 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -706,17 +732,22 @@ class FileListBioDatabase(ZTBioDatabase):
return self._make_bio(retval) return self._make_bio(retval)
def zobjects(self, groups=None, protocol=None, **kwargs): def zobjects(self, groups=None, protocol=None, **kwargs):
"""Returns a list of :py:class:`bob.bio.base.database.BioFile` objects to perform Z-norm score normalization. """Returns a list of :py:class:`BioFile` objects to perform Z-norm score normalization.
Keyword Parameters: Parameters
----------
protocol : str or ``None`` protocol : str or ``None``
The protocol to consider The protocol to consider
groups : str or [str] or ``None`` groups : str or [str] or ``None``
The groups to which the clients belong ("dev", "eval"). The groups to which the clients belong ``('dev', 'eval')``.
Returns: A list of File objects considering all the filtering criteria. Returns
-------
[BioFile]
A list of File objects considering all the filtering criteria.
""" """
protocol = protocol or self.protocol protocol = protocol or self.protocol
...@@ -735,15 +766,17 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -735,15 +766,17 @@ class FileListBioDatabase(ZTBioDatabase):
def annotations(self, file): def annotations(self, file):
"""Reads the annotations for the given file id from file and returns them in a dictionary. """Reads the annotations for the given file id from file and returns them in a dictionary.
If you don't have a copy of the annotation files, you can download them under http://www.idiap.ch/resource/biometric. Parameters
----------
Keyword parameters:
file : :py:class:`bob.bio.base.database.BioFile` file : BioFile
The BioFile object for which the annotations should be read. The BioFile object for which the annotations should be read.
Return value Returns
The annotations as a dictionary: {'reye':(re_y,re_x), 'leye':(le_y,le_x)} -------
dict
The annotations as a dictionary, e.g.: ``{'reye':(re_y,re_x), 'leye':(le_y,le_x)}``
""" """
if self.annotation_directory is None: if self.annotation_directory is None:
return None return None
...@@ -754,6 +787,7 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -754,6 +787,7 @@ class FileListBioDatabase(ZTBioDatabase):
# return the annotations as read from file # return the annotations as read from file
return bob.db.base.read_annotation_file(annotation_file, self.annotation_type) return bob.db.base.read_annotation_file(annotation_file, self.annotation_type)
def original_file_name(self, file, check_existence=True): def original_file_name(self, file, check_existence=True):
"""Returns the original file name of the given file. """Returns the original file name of the given file.
...@@ -764,17 +798,21 @@ class FileListBioDatabase(ZTBioDatabase): ...@@ -764,17 +798,21 @@ class FileListBioDatabase(ZTBioDatabase):
these file names, and return the first one that actually exists. these file names, and return the first one that actually exists.
In this case, the ``check_existence`` flag is ignored. In this case, the ``check_existence`` flag is ignored.
**Keyword parameters** Parameters
----------
file : :py:class:`bob.bio.base.database.BioFile` file : BioFile
The BioFile object for which the file name should be returned. The BioFile object for which the file name should be returned.
check_existence : bool check_existence : bool
Should the existence of the original file be checked? Should the existence of the original file be checked?
(Ignored when multiple original extensions were specified in the contructor.) (Ignored when multiple original extensions were specified in the constructor.)
Returns
-------
**Returns** str
str : The full path of the original data file. The full path of the original data file.
""" """
if isinstance(self.original_extension, str): if isinstance(self.original_extension, str):
......
doc/implemented.rst
+ 2
− 0
View file @ f27b6449
...@@ -28,8 +28,10 @@ Implementations ...@@ -28,8 +28,10 @@ Implementations
bob.bio.base.algorithm.LDA bob.bio.base.algorithm.LDA
bob.bio.base.algorithm.PLDA bob.bio.base.algorithm.PLDA
bob.bio.base.algorithm.BIC bob.bio.base.algorithm.BIC
bob.bio.base.database.BioFile
bob.bio.base.database.BioDatabase bob.bio.base.database.BioDatabase
bob.bio.base.database.ZTBioDatabase bob.bio.base.database.ZTBioDatabase
bob.bio.base.database.FileListBioDatabase
Preprocessors Preprocessors
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment