Python API¶

bob.pad.db.get_config()[source]¶: Returns a string containing the configuration information.

class bob.pad.db.Client(client_id)¶

Bases: object

The clients of this database contain ONLY client ids. Nothing special.

class bob.pad.db.File(file_name, client_id, attack_type=None)¶

Bases: bob.pad.db.PadFile

Initialize the File object with the minimum required data.

Parameters

path: The path of this file, relative to the basic directory. Please do not specify any file extensions. This path will be used as an underlying file_id, as it is assumed to be unique
client_id: The id of the client, this file belongs to. 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.

load(directory=None, extension='.hdf5')[source]¶

Loads the data at the specified location and using the given extension. Override it if you need to load differently.

Keyword Parameters:

data: The data blob to be saved (normally a numpy.ndarray).
directory: [optional] If not empty or None, this directory is prefixed to the final file destination
extension: [optional] The extension of the filename - this will control the type of output and the codec for saving the input blob.

make_path(directory=None, extension=None)[source]¶

Wraps the current path so that a complete path is formed

Keyword Parameters:

directory: An optional directory name that will be prefixed to the returned result.
extension: An optional extension that will be suffixed to the returned filename. The extension normally includes the leading . character as in .jpg or .hdf5.

Returns a string containing the newly generated file path.

save(data, directory=None, extension='.hdf5', create_directories=True)[source]¶

Saves the input data at the specified location and using the given extension. Override it if you need to save differently.

Keyword Parameters:

data: The data blob to be saved (normally a numpy.ndarray).
directory: [optional] If not empty or None, this directory is prefixed to the final file destination
extension: [optional] The extension of the filename - this will control the type of output and the codec for saving the input blob.

class bob.pad.db.PadDatabase(name, all_files_options={}, check_original_files_for_existence=False, original_directory=None, original_extension=None, protocol='Default', **kwargs)¶

Bases: bob.bio.db.BioDatabase

This class represents the basic API for database access. Please use this class as a base class for your database access classes. Do not forget to call the constructor of this base class in your derived class.

Parameters:

name : str A unique name for the database.

all_files_options : dict Dictionary of options passed to the second-level database query when retrieving all data.

check_original_files_for_existence : bool Enables to test for the original data files when querying the database.

original_directory : str The directory where the original data of the database are stored.

original_extension : str The file name extension of the original data.

protocol : str or None The name of the protocol that defines the default experimental setup for this database.

kwargs : key=value pairs The arguments of the bob.bio.db.BioDatabase base class constructor.

all_files(groups=('train', 'dev', 'eval')) → files[source]¶

Returns all files of the database, respecting the current protocol. The files can be limited using the all_files_options in the constructor.

Parameters:

groups: The groups to get the data for.

Returns:

files: The sorted and unique list of all files of the database.

annotations(file)[source]¶: Annotations are not supported by PAD interface

arrange_by_client(files) → files_by_client¶

Arranges the given list of files by client id. This function returns a list of lists of File’s.

Parameters:

files: A list of files that should be split up by BioFile.client_id.

Returns:

files_by_client: The list of lists of files, where each sub-list groups the files with the same BioFile.client_id

check_parameter_for_validity(parameter, parameter_description, valid_parameters, default_parameter=None)¶

Checks the given parameter for validity

Ensures a given parameter is in the set of valid parameters. If the parameter is None or empty, the value in default_parameter will be returned, in case it is specified, otherwise a ValueError will be raised.

This function will return the parameter after the check tuple or list of parameters, or raise a ValueError.

Parameters:

parameter – str The single parameter to be checked. Might be a string or None.
parameter_description – str A short description of the parameter. This will be used to raise an exception in case the parameter is not valid.
valid_parameters – [str] A list/tuple of valid values for the parameters.
default_parameters – [str] or None The default parameter that will be returned in case parameter is None or empty. If omitted and parameter is empty, a ValueError is raised.

check_parameters_for_validity(parameters, parameter_description, valid_parameters, default_parameters=None)¶

Checks the given parameters for validity.

Checks a given parameter is in the set of valid parameters. It also assures that the parameters form a tuple or a list. If parameters is ‘None’ or empty, the default_parameters will be returned (if default_parameters is omitted, all valid_parameters are returned).

This function will return a tuple or list of parameters, or raise a ValueError.

Parameters:

parameters – str, [str] or None The parameters to be checked. Might be a string, a list/tuple of strings, or None.
parameter_description – str A short description of the parameter. This will be used to raise an exception in case the parameter is not valid.
valid_parameters – [str] A list/tuple of valid values for the parameters.
default_parameters – [str] or None The list/tuple of default parameters that will be returned in case parameters is None or empty. If omitted, all valid_parameters are used.

client_id_from_model_id(model_id, group='dev')¶: Return the client id associated with the given model id. In this base class implementation, it is assumed that only one model is enrolled for each client and, thus, client id and model id are identical. All key word arguments are ignored. Please override this function in derived class implementations to change this behavior.

convert_names_to_highlevel(names, low_level_names, high_level_names)¶

Converts group names from a low level to high level API

This is useful for example when you want to return db.groups() for the bob.bio.base. Your instance of the database should already have low_level_names and high_level_names initialized.

convert_names_to_lowlevel(names, low_level_names, high_level_names)¶: Same as convert_names_to_highlevel but on reverse

enroll_files(model_id, group = 'dev') → files¶

Returns a list of File objects that should be used to enroll the model with the given model id from the given group, respecting the current protocol. If the model_id is None (the default), enrollment files for all models are returned.

Parameters:

model_id: A unique ID that identifies the model.
group: The group to get the enrollment files for.

Returns:

files: The list of files used for to enroll the model with the given model id.

file_names(files, directory, extension) → paths¶

Returns the full path of the given File objects.

Parameters:

files: The list of file object to retrieve the file names for.
directory: The base directory, where the files can be found.
extension: The file name extension to add to all files.

Returns:

paths: The paths extracted for the files, in the same order. If this database provides file sets, a list of lists of file names is returned, one sub-list for each file set.

model_ids(group = 'dev') → ids¶

Returns a list of model ids for the given group, respecting the current protocol.

Parameters:

group: The group to get the model ids for.

Returns:

ids: The list of (unique) model ids for models of the given group.

model_ids_with_protocol(groups = None, protocol = None, **kwargs) → ids[source]¶: Client-based PAD is not implemented.

object_sets(groups=None, protocol=None, purposes=None, model_ids=None, **kwargs)¶

This function returns lists of FileSet objects, which fulfill the given restrictions.

Keyword parameters:

groups: The groups of which the clients should be returned. Usually, groups are one or more elements of (‘world’, ‘dev’, ‘eval’)
protocol: The protocol for which the clients should be retrieved. The protocol is dependent on your database. If you do not have protocols defined, just ignore this field.
purposes: The purposes for which File objects should be retrieved. Usually, purposes are one of (‘enroll’, ‘probe’).
model_ids: The model ids for which the File objects should be retrieved. What defines a ‘model id’ is dependent on the database. In cases, where there is only one model per client, model ids and client ids are identical. In cases, where there is one model per file, model ids and file ids are identical. But, there might also be other cases.

objects(groups=None, protocol=None, purposes=None, model_ids=None, **kwargs)[source]¶

This function returns lists of File objects, which fulfill the given restrictions.

Keyword parameters:

groups: The groups of which the clients should be returned. Usually, groups are one or more elements of (‘train’, ‘dev’, ‘eval’)
protocol: The protocol for which the clients should be retrieved. The protocol is dependent on your database. If you do not have protocols defined, just ignore this field.
purposes: The purposes for which File objects should be retrieved. Usually it is either ‘real’ or ‘attack’.
model_ids: This parameter is not suported in PAD databases yet

original_file_name(file)¶

This function returns the original file name for the given File object.

Keyword parameters:

file: The File objects for which the file name should be retrieved
Return value: The original file name for the given File object

original_file_names(files) → paths[source]¶

Returns the full paths of the real and attack data of the given PadFile objects.

Parameters:

files: The list of lists ([real, attack]) of file object to retrieve the original data file names for.

Returns:

paths: The paths extracted for the concatenated real+attack files, in the preserved order.

probe_file_sets(model_id = None, group = 'dev') → files¶

Returns a list of probe FileSet objects, respecting the current protocol. If a model_id is specified, only the probe files that should be compared with the given model id are returned (for most databases, these are all probe files of the given group). Otherwise, all probe files of the given group are returned.

Parameters:

model_id: A unique ID that identifies the model.
group: The group to get the enrollment files for.

Returns:

files: The list of file sets used to probe the model with the given model id.

probe_files(model_id = None, group = 'dev') → files¶

Returns a list of probe File objects, respecting the current protocol. If a model_id is specified, only the probe files that should be compared with the given model id are returned (for most databases, these are all probe files of the given group). Otherwise, all probe files of the given group are returned.

Parameters:

model_id: A unique ID that identifies the model.
group: The group to get the enrollment files for.

Returns:

files: The list of files used for to probe the model with the given model id.

replace_directories(replacements=None)¶

This helper function replaces the original_directory and the annotation_directory of the database with the directories read from the given replacement file.

This function is provided for convenience, so that the database configuration files do not need to be modified. Instead, this function uses the given dictionary of replacements to change the original directory and the original extension (if given).

The given replacements can be of type dict, including all replacements, or a file name (as a str), in which case the file is read. The structure of the file should be:

# Comments starting with # and empty lines are ignored

[YOUR_..._DATA_DIRECTORY] = /path/to/your/data
[YOUR_..._ANNOTATION_DIRECTORY] = /path/to/your/annotations

If no annotation files are available (e.g. when they are stored inside the database), the annotation directory can be left out.

Parameters:

replacements: A dictionary with replacements, or a name of a file to read the dictionary from. If the file name does not exist, no directories are replaced.

sort(files) → sorted¶

Returns a sorted version of the given list of File’s (or other structures that define an ‘id’ data member). The files will be sorted according to their id, and duplicate entries will be removed.

Parameters:

files: The list of files to be uniquified and sorted.

Returns:

sorted: The sorted list of files, with duplicate BioFile.ids being removed.

test_files(groups = ['dev']) → files¶

Returns all test files (i.e., files used for enrollment and probing) for the given groups, respecting the current protocol. The files for the steps can be limited using the all_files_options defined in the constructor.

Parameters:

groups: The groups to get the data for.

Returns:

files: The sorted and unique list of test files of the database.

training_files(step = None, arrange_by_client = False) → files[source]¶

Returns all training File objects This function needs to be implemented in derived class implementations.

Parameters:: The parameters are not applicable in this version of anti-spoofing experiments

Returns:

files: The (arranged) list of files used for the training.

uses_probe_file_sets(protocol=None)¶: Defines if, for the current protocol, the database uses several probe files to generate a score. Returns True if the given protocol specifies file sets for probes, instead of a single probe file. In this default implementation, False is returned, throughout. If you need different behavior, please overload this function in your derived class.

class bob.pad.db.PadFile(client_id, path, attack_type=None, file_id=None)¶

Bases: bob.bio.db.BioFile

A simple base class that defines basic properties of File object for the use in PAD experiments

load(directory=None, extension='.hdf5')¶

Loads the data at the specified location and using the given extension. Override it if you need to load differently.

Keyword Parameters:

data: The data blob to be saved (normally a numpy.ndarray).
directory: [optional] If not empty or None, this directory is prefixed to the final file destination
extension: [optional] The extension of the filename - this will control the type of output and the codec for saving the input blob.

make_path(directory=None, extension=None)¶

Wraps the current path so that a complete path is formed

Keyword Parameters:

directory: An optional directory name that will be prefixed to the returned result.
extension: An optional extension that will be suffixed to the returned filename. The extension normally includes the leading . character as in .jpg or .hdf5.

Returns a string containing the newly generated file path.

save(data, directory=None, extension='.hdf5', create_directories=True)¶

Saves the input data at the specified location and using the given extension. Override it if you need to save differently.

Keyword Parameters:

data: The data blob to be saved (normally a numpy.ndarray).
directory: [optional] If not empty or None, this directory is prefixed to the final file destination
extension: [optional] The extension of the filename - this will control the type of output and the codec for saving the input blob.

class bob.pad.db.PadFileListDatabase(base_dir, original_directory=None, original_extension=None, annotation_directory=None, annotation_extension='', annotation_type=None, train_subdir=None, dev_subdir=None, eval_subdir=None, real_filename=None, attack_filename=None, keep_read_lists_in_memory=True)¶

Bases: bob.db.base.Database

This class provides a user-friendly interface to databases that are given as file lists.

Keyword parameters:

base_dir: The directory that contains the filelists defining the protocol(s). If you use the protocol attribute when querying the database, it will be appended to the base directory, such that several protocols are supported by the same class instance of bob.pad.db.
original_directory: The directory, where the original data can be found
original_extension: The filename extension of the original data, or multiple extensions
annotation_directory: The directory, where additional annotation files can be found
annotation_extension: The filename extension of the annoation files
annotation_type: The type of annotation that can be read. Currently, annotations are not supported for PAD See bob.db.base.read_annotation_file() for details.
train_subdir: Specify a custom subdirectory for the filelists of the development set (default is ‘train’)
dev_subdir: Specify a custom subdirectory for the filelists of the development set (default is ‘dev’)
eval_subdir: Specify a custom subdirectory for the filelists of the development set (default is ‘eval’)
keep_read_lists_in_memory: If set to true, the lists are read only once and stored in memory

annotations(file)[source]¶

We do not have support for PAD annotations yet.

Return value: Does nothing

check_parameter_for_validity(parameter, parameter_description, valid_parameters, default_parameter=None)¶

Checks the given parameter for validity

Ensures a given parameter is in the set of valid parameters. If the parameter is None or empty, the value in default_parameter will be returned, in case it is specified, otherwise a ValueError will be raised.

This function will return the parameter after the check tuple or list of parameters, or raise a ValueError.

Parameters:

parameter – str The single parameter to be checked. Might be a string or None.
parameter_description – str A short description of the parameter. This will be used to raise an exception in case the parameter is not valid.
valid_parameters – [str] A list/tuple of valid values for the parameters.
default_parameters – [str] or None The default parameter that will be returned in case parameter is None or empty. If omitted and parameter is empty, a ValueError is raised.

check_parameters_for_validity(parameters, parameter_description, valid_parameters, default_parameters=None)¶

Checks the given parameters for validity.

Checks a given parameter is in the set of valid parameters. It also assures that the parameters form a tuple or a list. If parameters is ‘None’ or empty, the default_parameters will be returned (if default_parameters is omitted, all valid_parameters are returned).

This function will return a tuple or list of parameters, or raise a ValueError.

Parameters:

parameters – str, [str] or None The parameters to be checked. Might be a string, a list/tuple of strings, or None.
parameter_description – str A short description of the parameter. This will be used to raise an exception in case the parameter is not valid.
valid_parameters – [str] A list/tuple of valid values for the parameters.
default_parameters – [str] or None The list/tuple of default parameters that will be returned in case parameters is None or empty. If omitted, all valid_parameters are used.

client_ids(protocol=None, groups=None)[source]¶

Returns a list of client ids for the specific query by the user.

Keyword Parameters:

protocol: The protocol to consider
groups: The groups to which the clients belong (“dev”, “eval”, “train”).

Returns: A list containing all the client ids which have the given properties.

clients(protocol=None, groups=None)[source]¶

Returns a list of Client objects for the specific query by the user.

Keyword Parameters:

protocol: The protocol to consider
groups: The groups to which the clients belong (“dev”, “eval”, “train”, “optional_train_1”, “optional_train_2”).

Returns: A list containing all the Client objects which have the given properties.

convert_names_to_highlevel(names, low_level_names, high_level_names)¶

Converts group names from a low level to high level API

This is useful for example when you want to return db.groups() for the bob.bio.base. Your instance of the database should already have low_level_names and high_level_names initialized.

convert_names_to_lowlevel(names, low_level_names, high_level_names)¶: Same as convert_names_to_highlevel but on reverse

get_base_directory()[source]¶: Returns the base directory where the filelists defining the database are located.

get_list_file(group, type=None, protocol=None)[source]¶

groups(protocol=None)[source]¶

This function returns the list of groups for this database.

protocol: The protocol for which the groups should be retrieved.

Returns: a list of groups

objects(protocol=None, purposes=None, groups=None)[source]¶

Returns a set of File objects for the specific query by the user.

Keyword Parameters:

protocol: The protocol to consider
purposes: The purposes required to be retrieved (“real”, “attack”) 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.
groups: One of the groups (“dev”, “eval”, “train”) 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.

Returns: A list of File objects considering all the filtering criteria.

original_file_name(file_obj, check_existence=True)[source]¶

Returns the original file_obj name of the given file_obj.

This interface supports several original extensions, so that file_obj lists can contain different data types.

When multiple original extensions are specified, this function will check the existence of any of these file_obj names, and return the first one that actually exists. In this case, the check_existence flag is ignored.

Keyword parameters

file_obj: The py:class:File object for which the file_obj name should be returned.
check_existence: Should the existence of the original file_obj be checked? (Ignored when multiple original extensions were specified in the contructor.)

Returns str : The full path of the original data file_obj.

set_base_directory(base_dir)[source]¶: Resets the base directory where the filelists defining the database are located.