Python API

Todo

The link for the database isn’t working any more...

Details about the NIST SRE 2012 database can be found here: http://www.nist_sre12.org/

bob.db.nist_sre12.get_config()

Returns a string containing the configuration information.

class bob.db.nist_sre12.Client(id, gender)

Bases: sqlalchemy.ext.declarative.api.Base

Database clients, marked by an integer identifier and the group they belong to

gender

gender_choices = ('male', 'female')

id

metadata = MetaData(bind=None)

class bob.db.nist_sre12.Database(original_directory=None, original_extension='.sph')

Bases: bob.db.verification.utils.database.SQLiteDatabase, bob.db.verification.utils.database.ZTDatabase

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.

all_files(**kwargs)

Returns the list of all File objects that satisfy your query. For possible keyword arguments, please check the objects() function.

annotations(file)

This function returns the annotations for the given file id as a dictionary.

Keyword parameters:

file : bob.db.verification.utils.File or one of its derivatives

The File object you want to retrieve the annotations for,

Return value:

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

assert_validity()

Raise a RuntimeError if the database back-end is not available.

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

Checks the given parameter for validity, i.e., if it is contained in the set of valid parameters. If the parameter is ‘None’ or empty, the 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.

Keyword 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, i.e., if they are contained 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.

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

Returns the client object in the database given a certain id. Raises an error if that does not exist.

clients(protocol=None, groups=None, world_gender=None, subworld=None, filter_ids_unknown=True)

Returns a set of clients for the specific query by the user.

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

groups

The groups to which the clients belong (‘dev’, ‘eval’, ‘world’, ‘optional_world_1’, ‘optional_world_2’)

world_gender

The gender to consider for the world data (‘female’, ‘male’)

subworld

The subworld to consider (only one at a time is possible). This is an alias to the group ‘optional_world_X’ when groups is ‘world’ and subworld is ‘optional_world_X’.

filter_ids_unknown

Do not add the ids unknown ‘F_ID_X_F’ and ‘M_ID_X_M’

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

enroll_files(protocol=None, model_id=None, groups='dev', **kwargs)

Returns the list of enrollment File objects from the given model id of the given protocol for the given groups that satisfy your query. If the model_id is None (the default), enrollment files for all models are returned. For possible keyword arguments, please check the objects() function.

file_names(files, directory, extension)

This function returns the list of original file names for the given list of File objects.

Keyword parameters:

files : [File]

The list of File objects for which the file names should be retrieved

directory : str

The base directory where the files are stored

extension : str

The file name extension of the files

Return value : [str]

The file names for the given File objects, in the same order.

files(ids, preserve_order=True)

Returns a list of File objects with the given file ids

Keyword Parameters:

ids : [various type]

The ids of the object in the database table “file”. This object should be a python iterable (such as a tuple or list).

preserve_order : bool

If True (the default) the order of elements is preserved, but the execution time increases.

Returns a list (that may be empty) of File objects.

get_client_id_from_model_id(model_id, **kwargs)

Returns the client_id attached to the given model_id

Keyword Parameters:

model_id

The model_id to consider

Returns: The client_id attached to the given model_id

groups(protocol=None)

Returns the names of all registered groups

has_client_id(id)

Returns True if we have a client with a certain integer identifier

has_protocol(name)

Tells if a certain protocol is available

is_valid()

Returns if a valid session has been opened for reading the database.

model_ids(protocol=None, groups=None, world_gender=None, subworld=None, filter_ids_unknown=True)

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

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

groups

The groups to which the subjects attached to the models belong (‘dev’, ‘eval’, ‘world’)

world_gender

The gender to consider for the world data (‘female’, ‘male’)

subworld

The subworld to consider (only one at a time is possible). This is an alias to the group ‘optional_world_X’ when groups is ‘world’ and subworld is ‘optional_world_X’.

filter_ids_unknown

Do not add the ids unknown ‘F_ID_X’ and ‘M_ID_X’

Returns: A list containing the ids of all models belonging to the given group.

models(protocol=None, groups=None, world_gender=None, subworld=None, filter_ids_unknown=True)

Returns a set of models for the specific query by the user.

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

groups

The groups to which the subjects attached to the models belong (‘dev’, ‘eval’, ‘world’)

world_gender

The gender to consider for the world data (‘female’, ‘male’)

subworld

The subworld to consider (only one at a time is possible). This is an alias to the group ‘optional_world_X’ when groups is ‘world’ and subworld is ‘optional_world_X’.

filter_ids_unknown

Do not add the ids unknown ‘F_ID_X’ and ‘M_ID_X’

Returns: A list containing all the models belonging to the given group.

objects(protocol=None, purposes=None, model_ids=None, groups=None, world_gender=None, subworld=None, classes=None)

Returns a set of filenames for the specific query by the user. WARNING: Files used as impostor access for several different models are only listed one and refer to only a single model

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

purposes

The purposes required to be retrieved (‘enroll’, ‘probe’, ‘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. This field is ignored for the data from the “world” group.

model_ids

Only retrieves the files for the provided list of model ids (claimed client id). The model ids are string. 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 the same as a tuple with all possible values.

world_gender

The gender to consider for the world data (‘female’, ‘male’)

subworld

The subworld to consider (only one at a time is possible). This is an alias to the group ‘optional_world_X’ when groups is ‘world’ and subworld is ‘optional_world_X’.

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.

Returns: A list of files which have the given properties.

original_file_name(file, check_existence=True)

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

Keyword parameters:

file : File or a derivative

The File objects for which the file name should be retrieved

check_existence : bool

Check if the original file exists?

Return value : str

The original file name for the given File object

original_file_names(files, check_existence=True)

This function returns the list of original file names for the given list of File objects.

Keyword parameters:

files : [File]

The list of File objects for which the file names should be retrieved

check_existence : bool

Check if the original files exists?

Return value : [str]

The original file names for the given File objects, in the same order.

paths(ids, prefix=None, suffix=None, preserve_order=True)

Returns a full file paths considering particular file ids, a given directory and an extension

Keyword Parameters:

ids : [various type]

The ids of the object in the database table “file”. This object should be a python iterable (such as a tuple or list).

prefix : str or None

The bit of path to be prepended to the filename stem

suffix : str or None

The extension determines the suffix that will be appended to the filename stem.

preserve_order : bool

If True (the default) the order of elements is preserved, but the execution time increases.

Returns a list (that may be empty) of the fully constructed paths given the file ids.

probe_files(protocol=None, model_id=None, groups='dev', **kwargs)

Returns the list of probe File objects to probe the model with the given model id of the given protocol for the given groups that satisfy your query. If the model_id is None (the default), all possible probe files are returned. For possible keyword arguments, please check the objects() function.

protocol(name)

Returns the protocol object in the database given a certain name. Raises an error if that does not exist.

protocol_names()

Returns all registered protocol names

protocol_purposes()

Returns all registered protocol purposes

protocols()

Returns all registered protocols

provides_file_set_for_protocol(protocol=None)

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.

purposes()

Returns the list of allowed purposes

query(*args)

Creates a query to the database using the given arguments.

reverse(paths, preserve_order=True)

Reverses the lookup: from certain paths, return a list of File objects

Keyword Parameters:

paths : [str]

The filename stems to query for. This object should be a python iterable (such as a tuple or list)

preserve_order : True

If True (the default) the order of elements is preserved, but the execution time increases.

Returns a list (that may be empty).

t_enroll_files(protocol, model_id, groups='dev', **kwargs)

Returns the list of T-Norm model enrollment File objects from the given model id of the given protocol for the given group that satisfy your query. For possible keyword arguments, please check the tobjects() function.

t_model_ids(protocol, groups='dev', **kwargs)

Returns the list of model ids used for T-Norm of the given protocol for the given group that satisfy your query. For possible keyword arguments, please check the tmodel_ids() function.

tclients(protocol=None, groups=None, gender=None)

Returns a set of clients for the specific query by the user.

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

groups

The groups to which the clients belong (‘dev’, ‘eval’, ‘world’)

gender

The gender to consider (‘female’, ‘male’)

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

test_files(protocol=None, groups='dev', **kwargs)

Returns the list of all test File objects of the given groups that satisfy your query. Test objects are all File objects that serve either for enrollment or probing. For possible keyword arguments, please check the objects() function.

tmodel_ids(protocol=None, groups=None, gender=None)

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

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

groups

The groups to which the subjects attached to the models belong (‘dev’, ‘eval’, ‘world’)

gender

The gender to consider (‘female’, ‘male’)

Returns: A list containing all the T-norm models which have the given properties.

tmodels(protocol=None, groups=None, gender=None)

Returns a set of T-Norm models for the specific query by the user.

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

groups

The groups to which the subjects attached to the models belong (‘dev’, ‘eval’, ‘world’)

gender

The gender to consider (‘female’, ‘male’)

Returns: A list containing all the T-norm models which have the given properties.

tobjects(protocol=None, model_ids=None, groups=None, gender=None)

Returns a set of filenames for the specific query by the user. WARNING: Files used as impostor access for several different models are only listed one and refer to only a single model

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

model_ids

Only retrieves the files for the provided list of model ids (claimed client id). The model ids are string. If ‘None’ is given (this is the default), no filter over the model_ids is performed.

groups

One of the groups (‘dev’, ‘eval’, ‘world’) 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.

gender

The gender to consider (‘female’, ‘male’)

Returns: A list of files which have the given properties.

training_files(protocol=None, **kwargs)

Returns the list of all training (world) File objects that satisfy your query. For possible keyword arguments, please check the objects() function.

uniquify(file_list)

Sorts the given list of File objects and removes duplicates from it.

Keyword parameters:

file_list : [File]

A list of File objects to be handled. Also other objects can be handled, as long as they are sortable.

Returns

A sorted copy of the given file_list with the duplicates removed.

z_probe_files(protocol, groups='dev', **kwargs)

Returns the list of Z-Norm probe File objects to probe the model with the given model id of the given protocol for the given group that satisfy your query. For possible keyword arguments, please check the zobjects() function.

zobjects(protocol=None, model_ids=None, groups=None, gender=None)

Returns a set of filenames for the specific query by the user. WARNING: Files used as impostor access for several different models are only listed one and refer to only a single model

Keyword Parameters:

protocol

The protocol to consider (‘female’, ‘male’)

model_ids

Only retrieves the files for the provided list of model ids (claimed client id). The model ids are string. If ‘None’ is given (this is the default), no filter over the model_ids is performed.

groups

One of the groups (‘dev’, ‘eval’, ‘world’) 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.

gender

The gender to consider (‘female’, ‘male’)

Returns: A list of files which have the given properties.

class bob.db.nist_sre12.File(client_id, path)

Bases: sqlalchemy.ext.declarative.api.Base, bob.db.verification.utils.file.File

Generic file container

client

client_id

id

make_path(directory=None, extension=None)

Wraps the current path so that a complete path is formed

Keyword parameters:

directory : str or None

An optional directory name that will be prefixed to the returned result.

extension : str or None

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.

metadata = MetaData(bind=None)

path

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

Saves the input data at the specified location and using the given extension.

Keyword parameters:

data : various types

The data blob to be saved (normally a numpy.ndarray).

directory : str or None

If not empty or None, this directory is prefixed to the final file destination

extension : str or None

The extension of the filename. This extension will control the type of output and the codec for saving the input blob.

create_directories : bool

Should the directory structure be created (if necessary) before writing the data?

class bob.db.nist_sre12.Protocol(name)

Bases: sqlalchemy.ext.declarative.api.Base

NIST SRE 2012 protocols

id

metadata = MetaData(bind=None)

name

class bob.db.nist_sre12.ProtocolPurpose(protocol_id, sgroup, purpose)

Bases: sqlalchemy.ext.declarative.api.Base

NIST SRE 2012 purposes

clients

files

group_choices = ('world', 'dev', 'eval', 'optional_world_1', 'optional_world_2')

id

metadata = MetaData(bind=None)

protocol

protocol_id

purpose

purpose_choices = ('train', 'enroll', 'probe', 'tnorm', 'znorm')

sgroup

tclients