From 741aba4ddd4361055467562471e1aada6f5793df Mon Sep 17 00:00:00 2001
From: Tiago Freitas Pereira <tiagofrepereira@gmail.com>
Date: Tue, 15 Dec 2020 16:56:25 +0100
Subject: [PATCH] Added MORPH dataset

---
 bob/bio/face/config/database/morph.py |  9 +++
 bob/bio/face/database/__init__.py     |  2 +
 bob/bio/face/database/morph.py        | 87 +++++++++++++++++++++++++++
 doc/implemented.rst                   |  1 +
 setup.py                              |  2 +
 5 files changed, 101 insertions(+)
 create mode 100644 bob/bio/face/config/database/morph.py
 create mode 100644 bob/bio/face/database/morph.py

diff --git a/bob/bio/face/config/database/morph.py b/bob/bio/face/config/database/morph.py
new file mode 100644
index 00000000..c42d79cc
--- /dev/null
+++ b/bob/bio/face/config/database/morph.py
@@ -0,0 +1,9 @@
+from bob.bio.face.database import MorphDatabase
+
+# In case protocol is comming from chain loading
+# https://www.idiap.ch/software/bob/docs/bob/bob.extension/stable/py_api.html#bob.extension.config.load
+if "protocol" not in locals():
+    protocol = "verification_fold1"
+
+
+database = MorphDatabase(protocol=protocol)
diff --git a/bob/bio/face/database/__init__.py b/bob/bio/face/database/__init__.py
index a7ef08a7..3c0429f2 100644
--- a/bob/bio/face/database/__init__.py
+++ b/bob/bio/face/database/__init__.py
@@ -13,6 +13,7 @@ from .ijbc import IJBCBioDatabase
 from .replaymobile import ReplayMobileBioDatabase
 from .fargo import FargoBioDatabase
 from .meds import MEDSDatabase
+from .morph import MorphDatabase
 
 # gets sphinx autodoc done right - don't remove it
 
@@ -45,5 +46,6 @@ __appropriate__(
     ReplayMobileBioDatabase,
     FargoBioDatabase,
     MEDSDatabase,
+    MorphDatabase,
 )
 __all__ = [_ for _ in dir() if not _.startswith("_")]
diff --git a/bob/bio/face/database/morph.py b/bob/bio/face/database/morph.py
new file mode 100644
index 00000000..4790fe71
--- /dev/null
+++ b/bob/bio/face/database/morph.py
@@ -0,0 +1,87 @@
+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Tiago de Freitas Pereira <tiago.pereira@idiap.ch>
+
+"""
+  MEDS database implementation 
+"""
+
+from bob.bio.base.database import (
+    CSVDataset,
+    CSVDatasetZTNorm,
+)
+from bob.pipelines.datasets import CSVToSampleLoader
+from bob.bio.face.database.sample_loaders import EyesAnnotations
+from bob.extension import rc
+from bob.extension.download import get_file
+import bob.io.base
+from sklearn.pipeline import make_pipeline
+
+
+class MorphDatabase(CSVDatasetZTNorm):
+    """
+    The MORPH dataset is relatively old, but is getting some traction recently mostly because its richness
+    with respect to sensitive attributes.
+    It is composed by 55,000 samples from 13,000 subjects from men and women and five
+    race clusters (called ancestry) and they are the following: African, European, Asian, Hispanic and Others. Figure 8
+    present some samples from this database.
+
+    This dataset contains faces from five ethnicities (African, European, Asian, Hispanic, "Other")
+    and two genders (Male and Female).
+    Furthermore, this interface contains three verification protocols and they are:
+    `verification_fold1`, `verification_fold2` and `verification_fold1`.
+    Follow below the identities distribution in each set for the for each protocol:
+
+    +--------------------+---------------+-----------+-----------+-----------+
+    |                    | Training set              | Dev. Set  | Eval. Set |
+    +--------------------+---------------+-----------+           +           +
+    |                    | T-References  | Z-Probes  |           |           |
+    +====================+===============+===========+===========+===========+
+    | verification_fold1 |      69       |     66    |   6738    |   6742    |
+    +--------------------+---------------+-----------+-----------+-----------+
+    | verification_fold2 |      69       |     67    |   6734    |   6737    |
+    +--------------------+---------------+-----------+-----------+-----------+
+    | verification_fold3 |      70       |     66    |   6736    |   6740    |
+    +--------------------+---------------+-----------+-----------+-----------+ 
+
+    .. warning::
+        Use the command below to set the path of the real data::
+
+            $ bob config set bob.db.morph.directory [PATH-TO-MORPH-DATA]
+
+    Parameters
+    ----------
+
+    protocol: str
+        One of the database protocols. Options are `verification_fold1`, `verification_fold2` and `verification_fold3`
+
+    """
+
+    def __init__(self, protocol):
+
+        # Downloading model if not exists
+        urls = [
+            "https://www.idiap.ch/software/bob/databases/latest/morph.tar.gz",
+            "http://www.idiap.ch/software/bob/databases/latest/morph.tar.gz",
+        ]
+        filename = get_file("morph.tar.gz", urls)
+
+        self.annotation_type = "eyes-center"
+        self.fixed_positions = None
+
+        database = CSVDataset(
+            filename,
+            protocol,
+            csv_to_sample_loader=make_pipeline(
+                CSVToSampleLoader(
+                    data_loader=bob.io.base.load,
+                    dataset_original_directory=rc["bob.db.morph.directory"]
+                    if rc["bob.db.morph.directory"]
+                    else "",
+                    extension=".JPG",
+                ),
+                EyesAnnotations(),
+            ),
+        )
+
+        super().__init__(database)
diff --git a/doc/implemented.rst b/doc/implemented.rst
index 364f4f57..0deac260 100644
--- a/doc/implemented.rst
+++ b/doc/implemented.rst
@@ -21,6 +21,7 @@ Databases
    bob.bio.face.database.MultipieBioDatabase
    bob.bio.face.database.FargoBioDatabase
    bob.bio.face.database.MEDSDatabase
+   bob.bio.face.database.MorphDatabase
 
 
 Face Image Annotators
diff --git a/setup.py b/setup.py
index 4b978b1e..daf7cdb0 100644
--- a/setup.py
+++ b/setup.py
@@ -111,6 +111,7 @@ setup(
             "replaymobile-img-spoof  = bob.bio.face.config.database.replaymobile:replaymobile_spoof",
             "fargo  = bob.bio.face.config.database.fargo:database",
             "meds = bob.bio.face.config.database.meds:database",
+            "morph = bob.bio.face.config.database.morph:database",
         ],
         "bob.bio.annotator": [
             "facedetect               = bob.bio.face.config.annotator.facedetect:annotator",
@@ -172,6 +173,7 @@ setup(
             "replaymobile-img-spoof  = bob.bio.face.config.database.replaymobile_spoof",
             "fargo  = bob.bio.face.config.database.fargo",
             "meds = bob.bio.face.config.database.meds",
+            "morph = bob.bio.face.config.database.morph",
         ],
         "bob.bio.cli": [
             "display-face-annotations          = bob.bio.face.script.display_face_annotations:display_face_annotations",
-- 
GitLab