Merge branch 'master' of https://github.com/biometrics/openbr

Scott Klum
2 parents 8ccbcbe4 e0463ba6
Showing 10 changed files with 206 additions and 94 deletions
CHANGELOG.md
sdk/openbr_plugin.cpp
sdk/openbr_plugin.h
sdk/plugins/format.cpp
sdk/plugins/gallery.cpp
sdk/plugins/meta.cpp
sdk/plugins/misc.cpp
sdk/plugins/nec3.cpp
sdk/plugins/reduce.cpp
share/openbr/cmake/FindNEC3.cmake
 0.3.0 - ??/??/??
 ================
 * YouTubeFacesDBTransform implements Dr. Wolf's experimental protocol
+* NEC3 refactored
  
 0.2.0 - 2/23/13
 ===============
@@ -452,6 +452,7 @@ TemplateList TemplateList::fromGallery(const br::File &amp;gallery)
     foreach (const br::File &file, gallery.split()) {
         QScopedPointer<Gallery> i(Gallery::make(file));
         TemplateList newTemplates = i->read();
+        if (gallery.getBool("reduce")) newTemplates = newTemplates.reduced();
         const int crossValidate = gallery.getInt("crossValidate");
         if (crossValidate > 0) srand(0);
  
@@ -1239,10 +1240,10 @@ Transform *Transform::make(QString str, QObject *parent)
     if (Globals->abbreviations.contains(str))
         return make(Globals->abbreviations[str], parent);
  
-    { // Check for use of '!' as shorthand for Chain(...)
+    { // Check for use of '!' as shorthand for Expand(...)
         QStringList words = parse(str, '!');
         if (words.size() > 1)
-            return make("Chain([" + words.join(",") + "])", parent);
+            return make("Expand([" + words.join(",") + "])", parent);
     }
  
     { // Check for use of '+' as shorthand for Pipe(...)
@@ -393,6 +393,17 @@ struct TemplateList : public QList&lt;Template&gt;
                 labelCounts[file.label()]++;
         return labelCounts;
     }
+
+    /*!
+     * \brief Merge all the templates together.
+     */
+    TemplateList reduced() const
+    {
+        Template reduced;
+        foreach (const Template &t, *this)
+            reduced.merge(t);
+        return TemplateList() << reduced;
+    }
 };
  
 /*!
@@ -509,6 +509,34 @@ BR_REGISTER(Format, matFormat)
  
 /*!
  * \ingroup formats
+ * \brief RAW format
+ *
+ * http://www.nist.gov/srd/nistsd27.cfm
+ * \author Josh Klontz \cite jklontz
+ */
+class rawFormat : public Format
+{
+    Q_OBJECT
+
+    Template read() const
+    {
+        QByteArray data;
+        QtUtils::readFile(file, data);
+        if (data.size() != 768*800)
+            qFatal("Expected 768*800 bytes.");
+        return Template(file, Mat(768, 800, CV_8UC1, data.data()).clone());
+    }
+
+    void write(const Template &t) const
+    {
+        QtUtils::writeFile(file, QByteArray().setRawData((const char*)t.m().data, t.m().total() * t.m().elemSize()));
+    }
+};
+
+BR_REGISTER(Format, rawFormat)
+
+/*!
+ * \ingroup formats
  * \brief Retrieves an image from a webcam.
  * \author Josh Klontz \cite jklontz
  */
@@ -135,7 +135,7 @@ BR_REGISTER(Gallery, EmptyGallery)
  
 /*!
  * \ingroup galleries
- * \brief Treats the gallery as a single image.
+ * \brief Treats the gallery as a br::Format.
  * \author Josh Klontz \cite jklontz
  */
 class DefaultGallery : public Gallery
@@ -150,8 +150,8 @@ class DefaultGallery : public Gallery
  
     void write(const Template &t)
     {
-        QtUtils::touchDir(QFileInfo(file.name));
-        OpenCVUtils::saveImage(t, file.name);
+        QScopedPointer<Format> format(Factory<Format>::make(file));
+        format->write(t);
     }
 };
 BR_REGISTER(Gallery, DefaultGallery)
@@ -26,13 +26,13 @@ using namespace cv;
 namespace br
 {
  
-static TemplateList Simplified(const TemplateList &templates)
+static TemplateList Expanded(const TemplateList &templates)
 {
-    TemplateList simplified;
+    TemplateList expanded;
     foreach (const Template &t, templates) {
         if (t.isEmpty()) {
             if (!t.file.getBool("enrollAll"))
-                simplified.append(t);
+                expanded.append(t);
             continue;
         }
  
@@ -46,13 +46,13 @@ static TemplateList Simplified(const TemplateList &amp;templates)
  
         for (int i=0; i<t.size(); i++) {
             if (!fte || !t.file.getBool("enrollAll")) {
-                simplified.append(Template(t.file, t[i]));
-                simplified.last().file.setROIs(ROIs.mid(i*ROIStep, ROIStep));
-                simplified.last().file.setLandmarks(landmarks.mid(i*landmarkStep, landmarkStep));
+                expanded.append(Template(t.file, t[i]));
+                expanded.last().file.setROIs(ROIs.mid(i*ROIStep, ROIStep));
+                expanded.last().file.setLandmarks(landmarks.mid(i*landmarkStep, landmarkStep));
             }
         }
     }
-    return simplified;
+    return expanded;
 }
  
 static void _train(Transform *transform, const TemplateList *data)
@@ -92,7 +92,8 @@ static void incrementStep()
  *
  * The source br::Template is given to the first transform and the resulting br::Template is passed to the next transform, etc.
  *
- * \see ChainTransform
+ * \see ExpandTransform
+ * \see ForkTransform
  */
 class PipeTransform : public MetaTransform
 {
@@ -142,10 +143,9 @@ class PipeTransform : public MetaTransform
     void backProject(const Template &dst, Template &src) const
     {
         src = dst;
-        //reverse order in which transforms are processed
+        // Reverse order in which transforms are processed
         int length = transforms.length();
-        //foreach (const Transform *f, transforms) {
-        for (int i=length-1; i>=0; i--){
+        for (int i=length-1; i>=0; i--) {
             Transform *f = transforms.at(i);
             try {
                 src >> *f;
@@ -156,22 +156,21 @@ class PipeTransform : public MetaTransform
             }
         }
     }
-
 };
  
 BR_REGISTER(Transform, PipeTransform)
  
 /*!
  * \ingroup transforms
- * \brief Transforms in series.
+ * \brief Transforms in series with expansion step.
  * \author Josh Klontz \cite jklontz
  *
  * The source br::Template is given to the first transform and the resulting br::Template is passed to the next transform, etc.
- * Each matrix is reorganized into a new template before continuing.
+ * Each matrix is expanded into its own template between steps.
  *
  * \see PipeTransform
  */
-class ChainTransform : public MetaTransform
+class ExpandTransform : public MetaTransform
 {
     Q_OBJECT
     Q_PROPERTY(QList<br::Transform*> transforms READ get_transforms WRITE set_transforms RESET reset_transforms)
@@ -185,7 +184,7 @@ class ChainTransform : public MetaTransform
         for (int i=0; i<transforms.size(); i++) {
             transforms[i]->train(copy);
             copy >> *transforms[i];
-            copy = Simplified(copy);
+            copy = Expanded(copy);
             incrementStep();
         }
  
@@ -211,17 +210,16 @@ class ChainTransform : public MetaTransform
         dst = src;
         for (int i=0; i<transforms.size(); i++) {
             dst >> *transforms[i];
-            dst = Simplified(dst);
+            dst = Expanded(dst);
         }
     }
  
     void backProject(const Template &dst, Template &src) const
     {
         src = dst;
-        //reverse order in which transforms are processed
+        // Reverse order in which transforms are processed
         int length = transforms.length();
-        //foreach (const Transform *f, transforms) {
-        for (int i=length-1; i>=0; i--){
+        for (int i=length-1; i>=0; i--) {
             Transform *f = transforms.at(i);
             try {
                 src >> *f;
@@ -234,7 +232,7 @@ class ChainTransform : public MetaTransform
     }
 };
  
-BR_REGISTER(Transform, ChainTransform)
+BR_REGISTER(Transform, ExpandTransform)
  
 /*!
  * \ingroup transforms
@@ -242,6 +240,8 @@ BR_REGISTER(Transform, ChainTransform)
  * \author Josh Klontz \cite jklontz
  *
  * The source br::Template is seperately given to each transform and the results are appended together.
+ *
+ * \see PipeTransform
  */
 class ForkTransform : public MetaTransform
 {
@@ -317,6 +317,26 @@ class RenameFirstTransform : public UntrainableMetaTransform
  
 BR_REGISTER(Transform, RenameFirstTransform)
  
+/*!
+ * \ingroup transforms
+ * \brief Change the br::Template::file extension
+ * \author Josh Klontz \cite jklontz
+ */
+class AsTransform : public UntrainableMetaTransform
+{
+    Q_OBJECT
+    Q_PROPERTY(QString extension READ get_extension WRITE set_extension RESET reset_extension STORED false)
+    BR_PROPERTY(QString, extension, "")
+
+    void project(const Template &src, Template &dst) const
+    {
+        dst = src;
+        dst.file.name = dst.file.name.left(dst.file.name.lastIndexOf('.')+1) + extension;
+    }
+};
+
+BR_REGISTER(Transform, AsTransform)
+
 }
  
 #include "misc.moc"
+#ifdef WIN32
+#include <windows.h>
+#endif
+
 #include <NeoFacePro.h>
-#include <mm_plugin.h>
  
-#include "common/resource.h"
+#include <openbr_plugin.h>
+#include "core/resource.h"
  
-using namespace mm;
+using namespace br;
  
 /*!
  * \ingroup initializers
  * \brief Initialize NEC3
  * \author Josh Klontz \cite jklontz
+ * \author Scott Klum \cite sklum
  * \warning Needs a maintainer
  */
 class NEC3Initializer : public Initializer
@@ -19,7 +24,7 @@ class NEC3Initializer : public Initializer
     {
         int result = NeoFacePro::Initialize();
         if (result != NFP_SUCCESS) qWarning("NEC3 Initialize error [%d]", result);
-        Globals->Abbreviations.insert("NEC3", "Open+NEC3Enroll:NEC3Compare");
+        Globals->abbreviations.insert("NEC3", "Open!NEC3Enroll:NEC3Compare");
     }
  
     void finalize() const
@@ -29,40 +34,27 @@ class NEC3Initializer : public Initializer
     }
 };
  
-MM_REGISTER(Initializer, NEC3Initializer)
+BR_REGISTER(Initializer, NEC3Initializer)
  
 /*!
- * \brief Helper class
- * \author Josh Klontz \cite jklontz
- * \warning Needs a maintainer
+ * \brief NEC3 Context
+ * \author Scott Klum \cite sklum
  */
-class CFaceInfoResourceMaker : public ResourceMaker<NeoFacePro::CFaceInfo>
-{
-    NeoFacePro::CFaceInfo *make() const
-    {
-        NeoFacePro::CFaceInfo *faceInfo = new NeoFacePro::CFaceInfo();
-        faceInfo->SetParamAlgorithm(NFP_ALGORITHM003);
-        faceInfo->SetParamEyesRoll(15);
-        faceInfo->SetParamEyesMaxWidth(1000);
-        faceInfo->SetParamEyesMinWidth(30);
-        faceInfo->SetParamMaxFace(5);
-        faceInfo->SetParamReliability(0);
-        return faceInfo;
-    }
-};
  
-/*!
- * \brief Helper class
- * \author Josh Klontz \cite jklontz
- * \warning Needs a maintainer
- */
-class CFaceFeatureResourceMaker : public ResourceMaker<NeoFacePro::CFaceFeature>
+struct NEC3Context
 {
-    NeoFacePro::CFaceFeature *make() const
-    {
-        NeoFacePro::CFaceFeature *faceFeature = new NeoFacePro::CFaceFeature();
-        faceFeature->SetParamFeatureType(NFP_FEATURE_S14);
-        return faceFeature;
+    NeoFacePro::CFaceInfo faceInfo;
+    NeoFacePro::CFaceFeature faceFeature;
+
+    NEC3Context() {
+        faceInfo.SetParamAlgorithm(NFP_ALGORITHM003);
+        faceInfo.SetParamEyesRoll(15);
+        faceInfo.SetParamEyesMaxWidth(1000);
+        faceInfo.SetParamEyesMinWidth(30);
+        faceInfo.SetParamMaxFace(1);
+        faceInfo.SetParamReliability(0);
+
+        faceFeature.SetParamFeatureType(NFP_FEATURE_S14);
     }
 };
  
@@ -70,30 +62,22 @@ class CFaceFeatureResourceMaker : public ResourceMaker&lt;NeoFacePro::CFaceFeature&gt;
  * \ingroup transforms
  * \brief Enroll a face image in NEC NeoFace 3
  * \author Josh Klontz \cite jklontz
+ * \author Scott Klum \cite sklum
  * \warning Needs a maintainer
  */
-class NEC3Enroll : public UntrainableFeature
+class NEC3Enroll : public UntrainableTransform
 {
     Q_OBJECT
-    Q_PROPERTY(bool detectOnly READ get_detectOnly WRITE set_detectOnly)
-    MM_MEMBER(bool, detectOnly)
+    Q_PROPERTY(bool detectOnly READ get_detectOnly WRITE set_detectOnly RESET reset_detectOnly STORED false)
+    BR_PROPERTY(bool, detectOnly, false)
  
-    Resource<NeoFacePro::CFaceInfo> faceInfoResource;
-    Resource<NeoFacePro::CFaceFeature> faceFeatureResource;
-    QSharedPointer<Feature> flip;
-
-    QString parameters() const
-    {
-        return "bool detectOnly = 0";
-    }
+    Resource<NEC3Context> contexts;
+    QSharedPointer<Transform> flip;
  
     void init()
     {
-        faceInfoResource.setResourceMaker(new CFaceInfoResourceMaker());
-        faceFeatureResource.setResourceMaker(new CFaceFeatureResourceMaker());
-        faceInfoResource.setMaxResources(1); // Only works in serial
-        faceFeatureResource.setMaxResources(1); // Only works in serial
-        flip = QSharedPointer<Feature>(Feature::make("Flip(X)"));
+        contexts.setMaxResources(1);
+        flip = QSharedPointer<Transform>(Transform::make("Flip(X)"));
     }
  
     void project(const Template &src, Template &dst) const
@@ -112,29 +96,29 @@ class NEC3Enroll : public UntrainableFeature
         binfo.bmiHeader.biHeight = input.rows;
         binfo.bmiHeader.biBitCount = 24;
  
-        NeoFacePro::CFaceInfo *faceInfo = faceInfoResource.acquire();
-        int result = faceInfo->FindFace(binfo, input.data);
-        faceInfo->LocateEyes();
+        NEC3Context *context = contexts.acquire();
+        int result = context->faceInfo.FindFace(binfo, input.data);
+        context->faceInfo.LocateEyes();
+
         if (result == NFP_CANNOT_FIND_FACE) {
             if (Globals->verbose) qDebug("NEC3Enroll face not found for file %s", qPrintable(src.file.flat()));
         } else if (result != NFP_SUCCESS) {
             qWarning("NEC3Enroll FindFace error %d for file %s", result, qPrintable(src.file.flat()));
         }
  
-        NeoFacePro::CFaceFeature *faceFeature = faceFeatureResource.acquire();
-        QList<cv::Point2f> landmarks;
-        for (int i=0; i<faceInfo->GetFaceMax(); i++) {
-            if (faceInfo->SetFaceIndex(i) != NFP_SUCCESS)
+        QList<QPointF> landmarks;
+        for (int i=0; i<context->faceInfo.GetFaceMax(); i++) {
+            if (context->faceInfo.SetFaceIndex(i) != NFP_SUCCESS)
                 continue;
-            POINT right = faceInfo->GetRightEye();
-            POINT left = faceInfo->GetLeftEye();
-            landmarks.append(cv::Point2f(right.x, right.y));
-            landmarks.append(cv::Point2f(left.x, left.y));
+            POINT right = context->faceInfo.GetRightEye();
+            POINT left = context->faceInfo.GetLeftEye();
+            landmarks.append(QPointF(right.x, right.y));
+            landmarks.append(QPointF(left.x, left.y));
  
             if (detectOnly) {
                 dst += src.m();
             } else {
-                result = faceFeature->SetFeature(faceInfo);
+                result = context->faceFeature.SetFeature(&context->faceInfo);
                 if (result != NFP_SUCCESS) {
                     qWarning("NEC3Enroll SetFeature error %d for file %s", result, qPrintable(src.file.flat()));
                     continue;
@@ -142,7 +126,7 @@ class NEC3Enroll : public UntrainableFeature
  
                 void *data;
                 long size;
-                result = faceFeature->Serialize(&data, &size);
+                result = context->faceFeature.Serialize(&data, &size);
                 if (result != NFP_SUCCESS) {
                     qWarning("NEC3Enroll Serialize error %d for file %s", result, qPrintable(src.file.flat()));
                     continue;
@@ -156,22 +140,22 @@ class NEC3Enroll : public UntrainableFeature
         }
         dst.file.appendLandmarks(landmarks);
  
-        faceInfoResource.release(faceInfo);
-        faceFeatureResource.release(faceFeature);
+        contexts.release(context);
  
-        if (src.file.getBool("ForceEnrollment") && dst.isEmpty()) dst += cv::Mat();
+        if (!src.file.getBool("enrollAll") && dst.isEmpty()) dst += cv::Mat();
     }
 };
  
-MM_REGISTER(Feature, NEC3Enroll)
+BR_REGISTER(Transform, NEC3Enroll)
  
 /*!
  * \ingroup distances
  * \brief Compare faces with NEC NeoFace 3 SDK
  * \author Josh Klontz \cite jklontz
+ * \author Scott Klum \cite sklum
  * \warning Needs a maintainer
  */
-class NEC3Compare : public BasicComparer
+class NEC3Compare : public Distance
 {
     Q_OBJECT
  
@@ -190,6 +174,6 @@ class NEC3Compare : public BasicComparer
     }
 };
  
-MM_REGISTER(Comparer, NEC3Compare)
+BR_REGISTER(Distance, NEC3Compare)
  
 #include "nec3.moc"
@@ -79,6 +79,67 @@ class AndTransform : public UntrainableMetaTransform
  
 BR_REGISTER(Transform, AndTransform)
  
+/*!
+ * \ingroup transforms
+ * \brief Statistics
+ * \author Josh Klontz \cite jklontz
+ */
+class StatTransform : public UntrainableTransform
+{
+    Q_OBJECT
+    Q_ENUMS(Statistic)
+    Q_PROPERTY(Statistic statistic READ get_statistic WRITE set_statistic RESET reset_statistic STORED false)
+
+public:
+    /*!
+     * \brief Available statistics
+     */
+    enum Statistic { Min, Max, Mean, StdDev };
+
+private:
+    BR_PROPERTY(Statistic, statistic, Mean)
+
+    void project(const Template &src, Template &dst) const
+    {
+        if (src.m().channels() != 1)
+            qFatal("Expected 1 channel matrix.");
+        Mat m(1, 1, CV_32FC1);
+        if ((statistic == Min) || (statistic == Max)) {
+            double min, max;
+            minMaxLoc(src, &min, &max);
+            m.at<float>(1, 1) = (statistic == Min ? min : max);
+        } else {
+            Scalar mean, stddev;
+            meanStdDev(src, mean, stddev);
+            m.at<float>(1,1) = (statistic == Mean ? mean[0] : stddev[0]);
+        }
+        dst = m;
+    }
+};
+
+BR_REGISTER(Transform, StatTransform)
+
+/*!
+ * \ingroup transforms
+ * \brief Downsample the rows and columns of a matrix.
+ */
+class DownsampleTransform : public UntrainableTransform
+{
+    Q_OBJECT
+    Q_PROPERTY(int k READ get_k WRITE set_k RESET reset_k STORED false)
+    BR_PROPERTY(int, k, 1)
+
+    void project(const Template &src, Template &dst) const
+    {
+        Mat input = src.m();
+        Mat output;
+        (void) input; // TODO: write me!
+        dst.m() = output;
+    }
+};
+
+BR_REGISTER(Transform, DownsampleTransform)
+
 } // namespace br
  
 #include "reduce.moc"
+find_path(NEC3_DIR Include/NeoFacePro.h ${CMAKE_SOURCE_DIR}/3rdparty/*)
+
+include_directories(${NEC3_DIR}/Include)
+link_directories(${NEC3_DIR}/Lib)
+
+set(NEC3_LIBS NeoFacePro)