MOBIO Database

This is the Bob database entry for the MOBIO database

class bob.db.mobio.Database(original_directory=None, original_extension=None, annotation_directory=None, annotation_extension='.pos')

Bases: bob.db.base.SQLiteDatabase

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.

groups(protocol=None)

Returns the names of all registered groups

genders()

Returns the list of genders

subworld_names()

Returns all registered subworld names

subworlds()

Returns the list of subworlds

has_subworld(name)

Tells if a certain subworld is available

clients(protocol=None, groups=None, subworld=None, gender=None)

Returns a list of Clients for the specific query by the user.

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

groups

The groups to which the clients belong (‘dev’, ‘eval’, ‘world’) Please note that world data are protocol/gender independent

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) In order to be considered, ‘world’ should be in groups and only one split should be specified.

gender

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

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

has_client_id(id)

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

client(id)

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

tclients(protocol=None, groups=None, subworld='onethird', gender=None)

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

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

groups

Ignored. For the MOBIO database, this has no impact as the T-Norm clients are coming from the ‘world’ set, and are hence the same for both the ‘dev’ and ‘eval’ sets.

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) Please note that ‘onethird’ is the default value.

gender

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

Returns: A list containing all the T-norm clients belonging to the given group.

zclients(protocol=None, groups=None, subworld='onethird', gender=None)

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

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

groups

Ignored. For the MOBIO database, this has no impact as the Z-Norm clients are coming from the ‘world’ set, and are hence the same for both the ‘dev’ and ‘eval’ sets.

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) Please note that ‘onethird’ is the default value.

gender

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

Returns: A list containing all the Z-norm clients belonging to the given group.

models(protocol=None, groups=None, subworld=None, gender=None)

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

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

groups

The groups to which the subjects attached to the models belong (‘dev’, ‘eval’, ‘world’) Please note that world data are protocol/gender independent

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) In order to be considered, ‘world’ should be in groups and only one split should be specified.

gender

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

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

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

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

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

groups

The groups to which the subjects attached to the models belong (‘dev’, ‘eval’, ‘world’) Please note that world data are protocol/gender independent

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) In order to be considered, ‘world’ should be in groups and only one split should be specified.

gender

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

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

tmodels(protocol=None, groups=None, subworld='onethird', gender=None)

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

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

groups

Ignored. For the MOBIO database, this has no impact as the T-Norm clients are coming from the ‘world’ set, and are hence the same for both the ‘dev’ and ‘eval’ sets.

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) Please note that ‘onethird’ is the default value.

gender

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

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

tmodel_ids(protocol=None, groups=None, subworld='onethird', gender=None)

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

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

groups

Ignored. For the MOBIO database, this has no impact as the T-Norm clients are coming from the ‘world’ set, and are hence the same for both the ‘dev’ and ‘eval’ sets.

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) Please note that ‘onethird’ is the default value.

gender

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

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

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

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

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

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

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” group.

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

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.

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) In order to be considered, “world” should be in groups and only one split should be specified.

gender

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

device

The device to consider (‘laptop’, ‘mobile’)

Returns: A set of Files with the given properties.

tobjects(protocol=None, model_ids=None, groups=None, subworld='onethird', gender=None, speech_type=None, device=None)

Returns a set of filenames for enrolling T-norm models for score

normalization.

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

model_ids

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

groups

Ignored. For the MOBIO database, this has no impact as the T-Norm clients are coming from the ‘world’ set, and are hence the same for both the ‘dev’ and ‘eval’ sets.

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) Please note that ‘onethird’ is the default value.

gender

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

speech_type

The speech type to consider (‘p’, ‘l’, ‘r’, ‘f’)

device

The device choice to consider (‘mobile’, ‘laptop’)

Returns: A set of Files with the given properties.

zobjects(protocol=None, model_ids=None, groups=None, subworld='onethird', gender=None, speech_type=['r', 'f'], device=['mobile'])

Returns a set of Files to perform Z-norm score normalization.

Keyword Parameters:

protocol

One of the MOBIO protocols (‘mobile0-male’, ‘mobile0-female’, ‘mobile1-male’, ‘mobile1-female’, ‘laptop1-male’, ‘laptop1-female’, ‘laptop_mobile1-male’, ‘laptop_mobile1-female’) ‘male’and ‘female’ are aliases for ‘mobile0-male’ and ‘mobile0-female’, respectively.

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

Ignored. For the MOBIO database, this has no impact as the Z-Norm clients are coming from the ‘world’ set, and are hence the same for both the ‘dev’ and ‘eval’ sets.

subworld

Specify a split of the world data (‘onethird’, ‘twothirds’, ‘twothirds-subsampled’) Please note that ‘onethird’ is the default value.

gender

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

speech_type

The speech type to consider (‘p’, ‘l’, ‘r’, ‘f’)

device

The device choice to consider (‘mobile’, ‘laptop’)

Returns: A set of Files with the given properties.

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 File 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)}

protocol_names()

Returns all registered protocol names

protocols()

Returns all registered protocols

has_protocol(name)

Tells if a certain protocol is available

protocol(name)

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

protocol_purposes()

Returns all registered protocol purposes

purposes()

Returns the list of allowed purposes

class bob.db.mobio.Client(id, group, gender, institute)

Bases: sqlalchemy.ext.declarative.api.Base

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

gender_choices = ('female', 'male')

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

institute_choices = ('idiap', 'manchester', 'surrey', 'oulu', 'brno', 'avignon')

id

sgroup

gender

institute

class bob.db.mobio.Subworld(name)

Bases: sqlalchemy.ext.declarative.api.Base

Database clients belonging to the world group are split in subsets

id

clients

files

name

class bob.db.mobio.TModel(mid, client_id, protocol_id)

Bases: sqlalchemy.ext.declarative.api.Base

T-Norm models

id

client

protocol

files

mid

client_id

protocol_id

class bob.db.mobio.File(client_id, path, session_id, speech_type, shot_id, environment, device, channel_id)

Bases: sqlalchemy.ext.declarative.api.Base, bob.db.base.File

Generic file container

id

path

speech_type_choices = ('p', 'l', 'r', 'f')

environment_choices = ('i', 'o')

device_choices = ('mobile', 'laptop')

client

client_id

session_id

speech_type

shot_id

environment

device

channel_id

class bob.db.mobio.Protocol(name, gender)

Bases: sqlalchemy.ext.declarative.api.Base

MOBIO protocols

id

gender_choices = ('female', 'male', 'both')

name

gender

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

Bases: sqlalchemy.ext.declarative.api.Base

MOBIO protocol purposes

id

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

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

protocol

files

protocol_id

sgroup

purpose

bob.db.mobio.get_config()

Returns a string containing the configuration information.