BiosecurId Database

The BiosecurID database

bob.db.biosecurid.face.get_config()[source]

Returns a string containing the configuration information.

class bob.db.biosecurid.face.Client(id, group)[source]

Bases: sqlalchemy.ext.declarative.api.Base

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

files
group_choices = ('world', 'clientDev', 'impostorDev', 'clientEval', 'impostorEval')
id
sgroup
class bob.db.biosecurid.face.Database(original_directory=None, original_extension='.bmp')[source]

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.

client(id)[source]

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

client_groups()[source]

Returns the names of the XM2VTS groups. This is specific to this database which does not have separate training, development and evaluation sets.

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

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

Keyword Parameters:

protocol
Ignored.
groups
The groups to which the clients belong either from (‘dev’, ‘eval’, ‘world’) or the specific XM2VTS ones from (‘client’, ‘impostorDev’, ‘impostorEval’) Note that ‘dev’, ‘eval’ and ‘world’ are alias for ‘client’. If no groups are specified, then both clients are impostors are listed.

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

groups(protocol=None)[source]

Returns the names of all registered groups

has_client_id(id)[source]

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

has_protocol(name)[source]

Tells if a certain protocol is available

model_ids(protocol=None, groups=None)[source]
Returns a list of model ids for the specific query by the user.
Models correspond to Clients for the XM2VTS database (At most one model per identity).

Keyword Parameters:

protocol
Ignored.
groups
The groups to which the subjects attached to the models belong (‘dev’, ‘eval’, ‘world’) Note that ‘dev’, ‘eval’ and ‘world’ are alias for ‘client’. If no groups are specified, then both clients are impostors are listed.
Returns: A list containing all the model ids (model <-> client in XM2VTS) belonging
to the given group.
models(protocol=None, groups=None)[source]
Returns a list of Client for the specific query by the user.
Models correspond to Clients for the XM2VTS database (At most one model per identity).

Keyword Parameters:

protocol
Ignored.
groups
The groups to which the subjects attached to the models belong (‘dev’, ‘eval’, ‘world’) Note that ‘dev’, ‘eval’ and ‘world’ are alias for ‘client’. If no groups are specified, then both clients are impostors are listed.
Returns: A list containing all the models (model <-> client in BiosecurID) belonging
to the given group.
objects(protocol=None, purposes=None, model_ids=None, groups=None, classes=None)[source]

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

Keyword Parameters:

protocol
One of the Biosecurid protocols (‘A’).
purposes
The purposes required to be retrieved (‘enrol’, ‘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). 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.
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 File objects.

protocol(name)[source]

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

protocol_names()[source]

Returns all registered protocol names

protocol_purposes()[source]

Returns all registered protocol purposes

protocols()[source]

Returns all registered protocols

purposes()[source]

Returns the list of allowed purposes

class bob.db.biosecurid.face.File(client_id, path, session_id, shot_id)[source]

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

Generic file container

client
client_id
id
path
protocolPurposes
session_id
shot_id
class bob.db.biosecurid.face.Protocol(name)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BiosecurId protocols

id
name
purposes
class bob.db.biosecurid.face.ProtocolPurpose(protocol_id, sgroup, purpose)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BiosecurId protocol purposes

files
group_choices = ('world', 'dev', 'eval')
id
protocol
protocol_id
purpose
purpose_choices = ('train', 'enrol', 'probe')
sgroup