Python API¶

Details about the AMI database can be found here: http://groups.inf.ed.ac.uk/ami/corpus/

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

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

Bases: object

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

class bob.db.ami.Database(original_directory=None, original_extension=None)[source]¶

Bases: bob.bio.base.database.FileListBioDatabase

Wrapper class for the Amicorpus database for speaker recognition (http://groups.inf.ed.ac.uk/ami/corpus/). this class defines a simple protocol for training, dev and and by splitting the audio files of the database in three main parts.

all_files(groups=['dev'])¶

annotations(file)¶

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.

Keyword parameters:

file: The BioFile object for which the annotations should be read.
Return value: The annotations as a dictionary: {‘reye’:(re_y,re_x), ‘leye’:(le_y,le_x)}

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)[source]¶

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)[source]¶

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')¶

Returns the client id that is connected to the given model id.

Keyword parameters:

model_id: The model id for which the client id should be returned.
groups: (optional) the groups, the client belongs to. Might be one or more of (‘dev’, ‘eval’, ‘world’, ‘optional_world_1’, ‘optional_world_2’). If groups are given, only these groups are considered.
protocol: The protocol to consider

Returns: The client id for the given model id, if found.

client_id_from_t_model_id(t_model_id, group='dev')¶

Returns the client id that is connected to the given T-Norm model id.

Keyword parameters:

model_id: The model id for which the client id should be returned.
groups: (optional) the groups, the client belongs to. Might be one or more of (‘dev’, ‘eval’). If groups are given, only these groups are considered.
protocol: The protocol to consider

Returns: The client id for the given model id of a T-Norm model, if found.

client_ids(protocol=None, groups=None)¶

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”, “world”, “optional_world_1”, “optional_world_2”).

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

clients(protocol=None, groups=None)¶

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”, “world”, “optional_world_1”, “optional_world_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)[source]¶

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)[source]¶: 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.

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

groups(protocol=None, add_world=True, add_subworld=True)¶

This function returns the list of groups for this database.

protocol: The protocol for which the groups should be retrieved.
add_world: Add the world groups?
add_subworld: Add the sub-world groups? Only valid, when add_world=True

Returns: a list of groups

implements_zt(protocol=None, groups=None)¶

Checks if the file lists for the ZT score normalization are available.

Keyword Parameters:

protocol: The protocol for which the groups should be retrieved.
groups: The groups for which the ZT score normalization file lists should be checked (“dev”, “eval”).

Returns:	`True` if the all file lists for ZT score normalization exist, otherwise `False`.

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)¶

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

Keyword Parameters:

protocol: The protocol to consider
groups: 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.

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, classes=None, **kwargs)¶

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

Keyword Parameters:

protocol: The protocol to consider
purposes: 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 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.
model_ids: 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 the model_ids is performed.
groups: 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").
classes: The classes (types of accesses) to be retrieved (‘client’, ‘impostor’) 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. Note: classes are not allowed to be specified when the ‘probes_filename’ is used.

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

original_file_name(file, check_existence=True)¶

Returns the original file name of the given file.

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

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

Keyword parameters

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

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

original_file_names(files) → paths[source]¶

Returns the full path of the original data of the given File objects.

Parameters:

files: The list of file object to retrieve the original data file names for.

Returns:

paths: The paths extracted for the files, in the same 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.

set_base_directory(filelists_directory)¶: Resets the base directory where the filelists defining the database are located.

sort(files) → sorted[source]¶

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.

t_enroll_files(t_model_id, group = 'dev') → files¶

Returns a list of File objects that should be used to enroll the T-Norm model with the given model id from the given group, respecting the current protocol.

Parameters:

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

Returns:

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

t_model_ids(group = 'dev') → ids¶

Returns a list of model ids of T-Norm models 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 T-Norm models of the given group.

tclient_ids(protocol=None, groups=None)¶

Returns a list of T-Norm 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”).

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

tclients(protocol=None, groups=None)¶

Returns a list of T-Norm 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”).

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

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.

tmodel_ids_with_protocol(protocol=None, groups=None, **kwargs)¶

Returns a list of T-Norm model ids for the specific query by the user.

Keyword Parameters:

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

Returns: A list containing all the T-Norm model ids belonging to the given group.

tobjects(groups=None, protocol=None, model_ids=None, **kwargs)¶

Returns a list of BioFile objects for enrolling T-norm models for score normalization.

Keyword Parameters:

protocol: The protocol to consider
model_ids: 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 the model_ids is performed.
groups: The groups to which the models belong (“dev”, “eval”).

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

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

Returns all training files for the given step, and arranges them by client, if desired, respecting the current protocol. The files for the steps can be limited using the ..._training_options defined in the constructor.

Parameters:

step: The step for which the training data should be returned.
arrange_by_client: Should the training files be arranged by client? If set to True, training files will be returned in [[bob.bio.base.database.BioFile]], where each sub-list contains the files of a single client. Otherwise, all files will be stored in a simple [bob.bio.base.database.BioFile].

Returns:

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

uses_dense_probe_file(protocol)¶: Determines if a dense probe file list is used based on the existence of parameters.

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.

z_probe_file_sets(group = 'dev') → files¶

Returns a list of probe FileSet objects used to compute the Z-Norm. This function needs to be implemented in derived class implementations.

Parameters:

group: The group to get the Z-norm probe files for.

Returns:

files: The unique list of file sets used to compute the Z-norm.

z_probe_files(group = 'dev') → files¶

Returns a list of probe files used to compute the Z-Norm, respecting the current protocol. The Z-probe files can be limited using the z_probe_options in the query to bob.bio.base.database.ZTBioDatabase.z_probe_files()

Parameters:

group: The group to get the Z-norm probe files for.

Returns:

files: The unique list of files used to compute the Z-norm.

zclient_ids(protocol=None, groups=None)¶

Returns a list of Z-Norm 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”).

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

zclients(protocol=None, groups=None)¶

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

Keyword Parameters:

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

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

zobjects(groups=None, protocol=None, **kwargs)¶

Returns a list of BioFile objects to perform Z-norm score normalization.

Keyword Parameters:

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

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

class bob.db.ami.FileListFile(file_name, client_id, model_id=None, claimed_id=None)¶

Bases: object

Initialize the File object with the minimum required data.

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.

Parameters

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.
path: The path of this file, relative to the basic directory. If you use an SQL database, this should be the SQL type String. Please do not specify any file extensions.
file_id: The id of the file. 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 are using an automatically determined file id, you can skip selecting the file id.