Long Distance Heterogeneous Face Database (LDHF-DB)

class bob.db.nivl.Database(original_directory=None, original_extension=None)

Bases: bob.db.base.SQLiteDatabase

Wrapper class for the Near-Infrared and Visible-Light (NIVL) Dataset

protocols()

purposes()

annotations(file, annotation_type='eyes_center')

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

Parameters

file: bob.db.base.File

The File object you want to retrieve the annotations for,

Return

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

objects(groups=None, protocol=None, purposes=None, model_ids=None, modality=None, **kwargs)

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

get_client_by_id(client_id)

Get the client object from its ID

model_ids(protocol=None, groups=None)

groups(protocol=None, **kwargs)

This function returns the list of groups for this database.

clients(protocol=None, groups=None)

zclients(protocol=None)

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

tclients(protocol=None)

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

zobjects(protocol=None, groups=None)

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

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

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

tmodel_ids(groups=None, protocol=None, **kwargs)

This function returns the ids of the T-Norm models of the given groups for the given protocol.

property modality_separator

property modalities

all_files(**kwargs)

Returns the list of all File objects that satisfy your query.

For possible keyword arguments, please check the implemention’s objects() method.

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)

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

convert_names_to_highlevel(names, low_level_names, high_level_names)

convert_names_to_lowlevel(names, low_level_names, high_level_names)

file_names(files, directory, extension)

files(ids, preserve_order=True)

Returns a list of File objects with the given file ids

Parameters

• ids (list or tuple) – 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.

Return type

list

is_valid()

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

original_file_name(file)

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

Parameters

file – bob.db.base.File or a derivative The File objects for which the file name should be retrieved

Returns

The original file name for the given bob.db.base.File object.

Return type

str

Raises

ValueError – if the file is not found.

original_file_names(files)

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

Parameters

files (list of bob.db.base.File) – The list of file object to retrieve the original data file names for.

Returns

The paths extracted for the files, in the same order.

Return type

list of str

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

Returns a full file paths considering particular file ids

Parameters

• ids (list or :obj`tuple`) – 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, optional) – The bit of path to be prepended to the filename stem

• suffix (str, optional) – 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.

Return type

list

query(*args)

Creates a query to the database using the given arguments.

reverse(paths, preserve_order=True)

Reverses the lookup from certain paths, returns a list of bob.db.base.File’s

Parameters

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

• preserve_order (bool, optional) – If True (the default) the order of elements is preserved, but the execution time increases.

Returns

A list (that may be empty).

Return type

list

sort(files)

uniquify(file_list)

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

Parameters

file_list ([bob.db.base.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.

Return type

list

class bob.db.nivl.File(file_id, image_name, client_id, modality, session, year)

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

Information about the files of the LDHF database.

Each file includes * the client id

modality_choices = ('VIS', 'NIR')

id

path

client

all_annotations

client_id

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.

Parameters

• directory (str, optional) – If not empty or None, this directory is prefixed to the final file destination

• extension (str, optional) – If not empty or None, this extension is suffixed to the final file destination

Returns

The loaded data (normally numpy.ndarray).

Return type

object

make_path(directory=None, extension=None)

Wraps the current path so that a complete path is formed

Parameters

• directory (str, optional) – An optional directory name that will be prefixed to the returned result.

• extension (str, optional) – An optional extension that will be suffixed to the returned filename. The extension normally includes the leading . character as in .jpg or .hdf5.

Returns

Returns a string containing the newly generated file path.

Return type

str

metadata = MetaData(bind=None)

modality

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.

Parameters

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

• directory (str, optional) – If not empty or None, this directory is prefixed to the final file destination

• extension (str, optional) – The extension of the filename - this will control the type of output and the codec for saving the input blob.

• create_directories (bool, optional) – Whether to create the required directories to save the data.

session

year

annotations(annotation_type='eyes_center')

class bob.db.nivl.Client(id, group)

Bases: sqlalchemy.ext.declarative.api.Base

Information about the clients (identities) of the LDHF.

id

metadata = MetaData(bind=None)

class bob.db.nivl.Annotation(file_id, le_x, le_y, re_x, re_y)

Bases: sqlalchemy.ext.declarative.api.Base

• Annotation.id

• x

• y

file_id

le_x

le_y

re_x

re_y

metadata = MetaData(bind=None)

class bob.db.nivl.Protocol_File_Association(protocol, group, purpose, file_id)

Bases: sqlalchemy.ext.declarative.api.Base

Describe the protocols

metadata = MetaData(bind=None)

protocol

group

purpose

file_id

bob.db.nivl.get_config()

Returns a string containing the configuration information.