introduced br::Distance::trainable() and UntrainableDistance

Josh Klontz
1 parent 3ed08edc
Showing 11 changed files with 36 additions and 23 deletions
openbr/core/core.cpp
openbr/openbr_plugin.h
openbr/plugins/distance.cpp
openbr/plugins/eigen3.cpp
openbr/plugins/keypoint.cpp
openbr/plugins/openbr_internal.h
openbr/plugins/pp5.cpp
openbr/plugins/quantize.cpp
openbr/plugins/sentence.cpp
openbr/plugins/turk.cpp
openbr/plugins/validate.cpp
@@ -77,7 +77,7 @@ struct AlgorithmCore
         qDebug("Training Enrollment");
         trainingWrapper->train(data);
-        if (!distance.isNull()) {
+        if (!distance.isNull() && distance->trainable()) {
             if (Globals->crossValidate > 0)
                 for (int i=data.size()-1; i>=0; i--) if (data[i].file.get<bool>("allPartitions",false)) data.removeAt(i);
@@ -1358,7 +1358,8 @@ public:
     static Distance *make(QString str, QObject *parent); /*!< \brief Make a distance from a string. */
     static QSharedPointer<Distance> fromAlgorithm(const QString &algorithm); /*!< \brief Retrieve an algorithm's distance. */
-    virtual void train(const TemplateList &src) { (void) src; } /*!< \brief Train the distance. */
+    virtual bool trainable() { return true; } /*!< \brief \c true if The distance implements train(), false otherwise. */
+    virtual void train(const TemplateList &src) = 0; /*!< \brief Train the distance. */
     virtual void compare(const TemplateList &target, const TemplateList &query, Output *output) const; /*!< \brief Compare two template lists. */
     virtual QList<float> compare(const TemplateList &targets, const Template &query) const; /*!< \brief Compute the normalized distance between a template and a template list. */
     virtual float compare(const Template &a, const Template &b) const; /*!< \brief Compute the distance between two templates. */
@@ -35,7 +35,7 @@ namespace br
  * \brief Standard distance metrics
  * \author Josh Klontz \cite jklontz
  */
-class DistDistance : public Distance
+class DistDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_ENUMS(Metric)
@@ -128,7 +128,7 @@ BR_REGISTER(Distance, DistDistance)
  * \brief DistDistance wrapper.
  * \author Josh Klontz \cite jklontz
  */
-class DefaultDistance : public Distance
+class DefaultDistance : public UntrainableDistance
 {
     Q_OBJECT
     Distance *distance;
@@ -279,7 +279,7 @@ BR_REGISTER(Distance, FuseDistance)
  * \brief Fast 8-bit L1 distance
  * \author Josh Klontz \cite jklontz
  */
-class ByteL1Distance : public Distance
+class ByteL1Distance : public UntrainableDistance
 {
     Q_OBJECT
@@ -296,7 +296,7 @@ BR_REGISTER(Distance, ByteL1Distance)
  * \brief Fast 4-bit L1 distance
  * \author Josh Klontz \cite jklontz
  */
-class HalfByteL1Distance : public Distance
+class HalfByteL1Distance : public UntrainableDistance
 {
     Q_OBJECT
@@ -313,7 +313,7 @@ BR_REGISTER(Distance, HalfByteL1Distance)
  * \brief Returns -log(distance(a,b)+1)
  * \author Josh Klontz \cite jklontz
  */
-class NegativeLogPlusOneDistance : public Distance
+class NegativeLogPlusOneDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_PROPERTY(br::Distance* distance READ get_distance WRITE set_distance RESET reset_distance STORED false)
@@ -347,7 +347,7 @@ BR_REGISTER(Distance, NegativeLogPlusOneDistance)
  * \brief Returns \c true if the templates are identical, \c false otherwise.
  * \author Josh Klontz \cite jklontz
  */
-class IdenticalDistance : public Distance
+class IdenticalDistance : public UntrainableDistance
 {
     Q_OBJECT
@@ -368,7 +368,7 @@ BR_REGISTER(Distance, IdenticalDistance)
  * \brief Online distance metric to attenuate match scores across multiple frames
  * \author Brendan klare \cite bklare
  */
-class OnlineDistance : public Distance
+class OnlineDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_PROPERTY(br::Distance* distance READ get_distance WRITE set_distance RESET reset_distance STORED false)
@@ -395,7 +395,7 @@ BR_REGISTER(Distance, OnlineDistance)
  * \brief Attenuation function based distance from attributes
  * \author Scott Klum \cite sklum
  */
-class AttributeDistance : public Distance
+class AttributeDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_PROPERTY(QString attribute READ get_attribute WRITE set_attribute RESET reset_attribute STORED false)
@@ -421,7 +421,7 @@ BR_REGISTER(Distance, AttributeDistance)
  * \brief Sum match scores across multiple distances
  * \author Scott Klum \cite sklum
  */
-class SumDistance : public Distance
+class SumDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_PROPERTY(QList<br::Distance*> distances READ get_distances WRITE set_distances RESET reset_distances)
@@ -657,7 +657,7 @@ BR_REGISTER(Transform, SparseLDATransform)
  * \brief L1 distance computed using eigen.
  * \author Josh Klontz \cite jklontz
  */
-class L1Distance : public Distance
+class L1Distance : public UntrainableDistance
 {
     Q_OBJECT
@@ -677,7 +677,7 @@ BR_REGISTER(Distance, L1Distance)
  * \brief L2 distance computed using eigen.
  * \author Josh Klontz \cite jklontz
  */
-class L2Distance : public Distance
+class L2Distance : public UntrainableDistance
 {
     Q_OBJECT
@@ -109,7 +109,7 @@ BR_REGISTER(Transform, KeyPointDescriptorTransform)
  * \brief Wraps OpenCV Key Point Matcher
  * \author Josh Klontz \cite jklontz
  */
-class KeyPointMatcherDistance : public Distance
+class KeyPointMatcherDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_PROPERTY(QString matcher READ get_matcher WRITE set_matcher RESET reset_matcher STORED false)
@@ -501,6 +501,18 @@ typedef QVector&lt;Neighbors&gt; Neighborhood;
 BR_EXPORT bool compareNeighbors(const Neighbor &a, const Neighbor &b);
+/*!
+ * \brief A br::Distance that does not require training data.
+ */
+class BR_EXPORT UntrainableDistance : public Distance
+{
+    Q_OBJECT
+
+private:
+    bool trainable() { return false; }
+    void train(const TemplateList &data) { (void) data; }
+};
+
 }
 #endif // OPENBR_INTERNAL_H
@@ -407,7 +407,7 @@ BR_REGISTER(Transform, PP5EnrollTransform)
  * \author E. Taborsky \cite mmtaborsky
  * \note PP5 distance is known to be asymmetric
  */
-class PP5CompareDistance : public Distance
+class PP5CompareDistance : public UntrainableDistance
                          , public PP5Context
 {
     Q_OBJECT
@@ -251,7 +251,7 @@ QVector&lt;Mat&gt; ProductQuantizationLUTs;
  * \brief Distance in a product quantized space \cite jegou11
  * \author Josh Klontz \cite jklontz
  */
-class ProductQuantizationDistance : public Distance
+class ProductQuantizationDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_PROPERTY(bool bayesian READ get_bayesian WRITE set_bayesian RESET reset_bayesian STORED false)
@@ -291,7 +291,7 @@ BR_REGISTER(Distance, ProductQuantizationDistance)
  * \brief Recurively computed distance in a product quantized space
  * \author Josh Klontz \cite jklontz
  */
-class RecursiveProductQuantizationDistance : public Distance
+class RecursiveProductQuantizationDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_PROPERTY(float t READ get_t WRITE set_t RESET reset_t STORED false)
@@ -39,7 +39,7 @@ BR_REGISTER(Transform, SentenceTransform)
  * \brief Distance between sentences
  * \author Josh Klontz \cite jklontz
  */
-class SentenceSimilarityDistance : public Distance
+class SentenceSimilarityDistance : public UntrainableDistance
 {
     Q_OBJECT
@@ -138,7 +138,7 @@ BR_REGISTER(Transform, TurkClassifierTransform)
  * \brief Unmaps Turk HITs to be compared against query mats
  * \author Scott Klum \cite sklum
  */
-class TurkDistance : public Distance
+class TurkDistance : public UntrainableDistance
 {
     Q_OBJECT
     Q_PROPERTY(QString key READ get_key WRITE set_key RESET reset_key)
@@ -139,7 +139,7 @@ BR_REGISTER(Transform, CrossValidateTransform)
  * \brief Cross validate a distance metric.
  * \author Josh Klontz \cite jklontz
  */
-class CrossValidateDistance : public Distance
+class CrossValidateDistance : public UntrainableDistance
 {
     Q_OBJECT
@@ -159,7 +159,7 @@ BR_REGISTER(Distance, CrossValidateDistance)
  * \brief Checks target metadata against filters.
  * \author Josh Klontz \cite jklontz
  */
-class FilterDistance : public Distance
+class FilterDistance : public UntrainableDistance
 {
     Q_OBJECT
@@ -190,7 +190,7 @@ BR_REGISTER(Distance, FilterDistance)
  * \brief Checks target metadata against query metadata.
  * \author Scott Klum \cite sklum
  */
-class MetadataDistance : public Distance
+class MetadataDistance : public UntrainableDistance
 {
     Q_OBJECT
@@ -241,7 +241,7 @@ BR_REGISTER(Distance, MetadataDistance)
  * \brief Sets distance to -FLOAT_MAX if a target template has/doesn't have a key.
  * \author Scott Klum \cite sklum
  */
-class RejectDistance : public Distance
+class RejectDistance : public UntrainableDistance
 {
     Q_OBJECT