More updates to our docs

Jordan Cheney
1 parent 4c5dbb6c
Showing 24 changed files with 4305 additions and 3584 deletions
docs/docs/abstractions.md
docs/docs/contribute.md
docs/docs/docs/c_api.md
docs/docs/docs/cl_api.md
docs/docs/docs/cpp_api.md
docs/docs/docs/plugins/classification.md
docs/docs/docs/plugins/cluster.md
docs/docs/docs/plugins/core.md
docs/docs/docs/plugins/distance.md
docs/docs/docs/plugins/format.md
docs/docs/docs/plugins/gallery.md
docs/docs/docs/plugins/gui.md
docs/docs/docs/plugins/imgproc.md
docs/docs/docs/plugins/io.md
docs/docs/docs/plugins/metadata.md
docs/docs/docs/plugins/output.md
docs/docs/docs/plugins/video.md
docs/docs/install.md
docs/docs/plugins.md
docs/docs/technical.md
-# C++ Plugin API
-
-The in-depth documentation for the classes and abstractions in the C++ plugin API.
-
----
-
-## File
-
-A file path with associated metadata.
-
-The File is one of two important data structures in OpenBR (the Template is the other).
-It is typically used to store the path to a file on disk with associated metadata.
-The ability to associate a key/value metadata table with the file helps keep the API simple while providing customizable behavior.
-
-When querying the value of a metadata key, the value will first try to be resolved against the file's private metadata table.
-If the key does not exist in its local table then it will be resolved against the properties in the global Context.
-By design file metadata may be set globally using Context::setProperty to operate on all files.
-
-Files have a simple grammar that allow them to be converted to and from strings.
-If a string ends with a \c ] or \c ) then the text within the final \c [] or \c () are parsed as comma separated metadata fields.
-By convention, fields within \c [] are expected to have the format <tt>[key1=value1, key2=value2, ..., keyN=valueN]</tt> where order is irrelevant.
-Fields within \c () are expected to have the format <tt>(value1, value2, ..., valueN)</tt> where order matters and the key context dependent.
-The left hand side of the string not parsed in a manner described above is assigned to #name.
-
-Values are not necessarily stored as strings in the metadata table.
-The system will attempt to infer and convert them to their "native" type.
-The conversion logic is as follows:
-
-1. If the value starts with \c [ and ends with \c ] then it is treated as a comma separated list and represented with \c QVariantList. Each value in the list is parsed recursively.
-2. If the value starts with \c ( and ends with \c ) and contains four comma separated elements, each convertable to a floating point number, then it is represented with \c QRectF.
-3. If the value starts with \c ( and ends with \c ) and contains two comma separated elements, each convertable to a floating point number, then it is represented with \c QPointF.
-4. If the value is convertable to a floating point number then it is represented with \c float.
-5. Otherwise, it is represented with \c QString.
-
-Metadata keys fall into one of two categories:
-* \c camelCaseKeys are inputs that specify how to process the file.
-* \c Capitalized_Underscored_Keys are outputs computed from processing the file.
-
-Below are some of the most commonly occuring standardized keys:
-
-Key             | Value          | Description
----             | ----           | -----------
-name            | QString        | Contents of #name
-separator       | QString        | Seperate #name into multiple files
-Index           | int            | Index of a template in a template list
-Confidence      | float          | Classification/Regression quality
-FTE             | bool           | Failure to enroll
-FTO             | bool           | Failure to open
-*_X             | float          | Position
-*_Y             | float          | Position
-*_Width         | float          | Size
-*_Height        | float          | Size
-*_Radius        | float          | Size
-Label           | QString        | Class label
-Theta           | float          | Pose
-Roll            | float          | Pose
-Pitch           | float          | Pose
-Yaw             | float          | Pose
-Points          | QList<QPointF> | List of unnamed points
-Rects           | QList<Rect>    | List of unnamed rects
-Age             | float          | Age used for demographic filtering
-Gender          | QString        | Subject gender
-Train           | bool           | The data is for training, as opposed to enrollment
-_*              | *              | Reserved for internal use
-
-### Members
-
-#### Name
-
-Path to a file on disk
-
-#### FTE
-
-'Failed to enroll'. If true this file failed to be processed somewhere in the template enrollment algorithm
-
-#### m_metadata
-
-Map for storing metadata. It is a <a href=http://doc.qt.io/qt-5/QString.html>QString</a>, <a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a> key value pairing.
-
----
-
-## Template
-
----
-
-## Transform
-
----
-
-## UntrainableTransform
-
----
-
-## MetaTransform
-
----
-
-## UntrainableMetaTransform
-
----
-
-## MetadataTransform
-
----
-
-## UntrainableMetadataTransform
-
----
-
-## TimeVaryingTransform
-
----
-
-## Distance
-
----
-
-## UntrainableDistance
-
----
-
-## Output
-
----
-
-## MatrixOutput
-
----
-
-## Format
-
----
-
-## Representation
-
----
-
-## Classifier
+# Context
+
+---
+
+# File
+
+A file path with associated metadata.
+
+The File is one of two important data structures in OpenBR (the Template is the other).
+It is typically used to store the path to a file on disk with associated metadata.
+The ability to associate a key/value metadata table with the file helps keep the API simple while providing customizable behavior.
+
+When querying the value of a metadata key, the value will first try to be resolved against the file's private metadata table.
+If the key does not exist in its local table then it will be resolved against the properties in the global Context.
+By design file metadata may be set globally using Context::setProperty to operate on all files.
+
+Files have a simple grammar that allow them to be converted to and from strings.
+If a string ends with a **]** or **)** then the text within the final **[]** or **()** are parsed as comma separated metadata fields.
+By convention, fields within **[]** are expected to have the format <tt>[key1=value1, key2=value2, ..., keyN=valueN]</tt> where order is irrelevant.
+Fields within **()** are expected to have the format <tt>(value1, value2, ..., valueN)</tt> where order matters and the key context dependent.
+The left hand side of the string not parsed in a manner described above is assigned to #name.
+
+Values are not necessarily stored as strings in the metadata table.
+The system will attempt to infer and convert them to their "native" type.
+The conversion logic is as follows:
+
+1. If the value starts with **[** and ends with **]** then it is treated as a comma separated list and represented with <a href=http://doc.qt.io/qt-5/qvariant.html#QVariantList-typedef>QVariantList</a>. Each value in the list is parsed recursively.
+2. If the value starts with **(** and ends with **)** and contains four comma separated elements, each convertable to a floating point number, then it is represented with <a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a>.
+3. If the value starts with **(** and ends with **)** and contains two comma separated elements, each convertable to a floating point number, then it is represented with <a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a>.
+4. If the value is convertable to a floating point number then it is represented with <tt>float</tt>.
+5. Otherwise, it is represented with <a href=http://doc.qt.io/qt-5/QString.html>QString</a>.
+
+Metadata keys fall into one of two categories:
+* camelCaseKeys are inputs that specify how to process the file.
+* Capitalized_Underscored_Keys are outputs computed from processing the file.
+
+Below are some of the most commonly occuring standardized keys:
+
+Key             | Value          | Description
+---             | ----           | -----------
+name            | QString        | Contents of #name
+separator       | QString        | Seperate #name into multiple files
+Index           | int            | Index of a template in a template list
+Confidence      | float          | Classification/Regression quality
+FTE             | bool           | Failure to enroll
+FTO             | bool           | Failure to open
+*_X             | float          | Position
+*_Y             | float          | Position
+*_Width         | float          | Size
+*_Height        | float          | Size
+*_Radius        | float          | Size
+Label           | QString        | Class label
+Theta           | float          | Pose
+Roll            | float          | Pose
+Pitch           | float          | Pose
+Yaw             | float          | Pose
+Points          | QList<QPointF> | List of unnamed points
+Rects           | QList<Rect>    | List of unnamed rects
+Age             | float          | Age used for demographic filtering
+Gender          | QString        | Subject gender
+Train           | bool           | The data is for training, as opposed to enrollment
+_*              | *              | Reserved for internal use
+
+---
+
+## Members
+
+### Name
+
+Path to a file on disk
+
+### FTE
+
+Failed to enroll. If true this file failed to be processed somewhere in the template enrollment algorithm
+
+### m_metadata
+
+Map for storing metadata. It is a <a href=http://doc.qt.io/qt-5/QString.html>QString</a>, <a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a> key value pairing.
+
+---
+
+## Constructors
+
+### File()
+
+Default constructor. Sets [FTE](#fte) to false.
+
+### File(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &file)
+
+Initializes the file by calling the private function init.
+
+### File(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &file, const <a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a> &label)
+
+Initializes the file by calling the private function init. Append label to the [metadata](#m_metadata) using the key "Label".
+
+### File(const char \*file)
+
+Initializes the file with a c-style string.
+
+### File(const <a href=http://doc.qt.io/qt-5/qvariant.html#QVariantMap-typedef>QVariantMap</a> &metadata)
+
+Sets [FTE](#file#fte) to false and sets the [file metadata](#m_metadata) to metadata.
+
+---
+
+## Static Functions
+
+
+### static <a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a> parse(<a href=http://doc.qt.io/qt-5/QString.html>QString</a> &value) const
+
+Try to convert value to a <a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a>, <a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a>, int or float. If a conversion is possible it returns the converted value, otherwise it returns the unconverted string.
+
+    QString point = "(1, 1)";
+    QString rect = "(1, 1, 5, 5)";
+    QString integer = "1";
+    QString fp = "1.0";
+    QString string = "Hello World";
+
+    File::parse(point);   // returns QVariant(QPointF, QPointF(1, 1))
+    File::parse(rect);    // returns QVariant(QRectF, QRectF(1, 1, 5x5))
+    File::parse(integer); // returns QVariant(int, 1)
+    File::parse(fp);      // returns QVariant(float, 1.0f)
+    File::parse(string);  // returns QVariant(QString, "Hello World")
+
+### static <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a>&gt; values(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;U&gt; &fileList, const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key)
+
+This function requires a type specification in place of U. Valid types are [File](#file) and <a href=http://doc.qt.io/qt-5/QString.html>QString</a>. Returns a list of the values of the key in each of the given files.
+
+    File f1, f2;
+    f1.set("Key1", QVariant::fromValue<float>(1));
+    f1.set("Key2", QVariant::fromValue<float>(2));
+    f2.set("Key1", QVariant::fromValue<float>(3));
+
+    File::values<File>(QList<File>() << f1 << f2, "Key1"); // returns [QVariant(float, 1),
+                                                           //          QVariant(float, 3)]
+
+### static <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;T&gt; get(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;U&gt; &fileList, const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key)
+
+This function requires a type specification in place of T and U. Valid types for U are [File](#file) and <a href=http://doc.qt.io/qt-5/QString.html>QString</a>. T can be any type. Returns a list of the values of the key in each of the given files. If the key doesn't exist in any of the files or the value cannot be converted to type T an error is thrown.
+
+    File f1, f2;
+    f1.set("Key1", QVariant::fromValue<float>(1));
+    f1.set("Key2", QVariant::fromValue<float>(2));
+    f2.set("Key1", QVariant::fromValue<float>(3));
+
+    File::get<float, File>(QList<File>() << f1 << f2, "Key1");  // returns [1., 3.]
+    File::get<float, File>(QList<File>() << f1 << f2, "Key2");  // Error: Key doesn't exist in f2
+    File::get<QRectF, File>(QList<File>() << f1 << f2, "Key1"); // Error: float is not convertable to QRectF
+
+### static <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;T&gt; get(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;U&gt; &fileList, const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key, const T &defaultValue)
+
+This function requires a type specification in place of T and U. Valid types for U are [File](#file) and <a href=http://doc.qt.io/qt-5/QString.html>QString</a>. T can be any type. Returns a list of the values of the key in each of the given files. If the key doesn't exist in any of the files or the value cannot be converted to type T the given defaultValue is returned.
+
+    File f1, f2;
+    f1.set("Key1", QVariant::fromValue<float>(1));
+    f1.set("Key2", QVariant::fromValue<float>(2));
+    f2.set("Key1", QVariant::fromValue<float>(3));
+
+    File::get<float, File>(QList<File>() << f1 << f2, "Key1");                       // returns [1., 3.]
+    File::get<float, File>(QList<File>() << f1 << f2, "Key2", QList<float>() << 1);  // returns [1.]
+    File::get<QRectF, File>(QList<File>() << f1 << f2, "Key1, QList<QRectF>()");     // returns []
+
+### <a href=http://doc.qt.io/qt-5/qdebug.html>QDebug</a> operator <<(<a href=http://doc.qt.io/qt-5/qdebug.html>QDebug</a> dbg, const [File](#file) &file)
+
+Calls [flat](#qstring-flat-const) on the given file and that streams that file to stderr.
+
+    File file("../path/to/pictures/picture.jpg");
+    file.set("Key", QString("Value"));
+
+    qDebug() << file; // "../path/to/pictures/picture.jpg[Key=Value]" streams to stderr
+
+### <a href=http://doc.qt.io/qt-5/qdatastream.html>QDataStream</a> &operator <<(<a href=http://doc.qt.io/qt-5/qdatastream.html>QDataStream</a> &stream, const [File](#file) &file)
+
+Serialize a file to a data stream.
+
+    void store(QDataStream &stream)
+    {
+        File file("../path/to/pictures/picture.jpg");
+        file.set("Key", QString("Value"));
+
+        stream << file; // "../path/to/pictures/picture.jpg[Key=Value]" serialized to the stream
+    }
+
+### <a href=http://doc.qt.io/qt-5/qdatastream.html>QDataStream</a> &operator >>(<a href=http://doc.qt.io/qt-5/qdatastream.html>QDataStream</a> &stream, [File](#file) &file)
+
+Deserialize a file from a data stream.
+
+    void load(QDataStream &stream)
+    {
+        File in("../path/to/pictures/picture.jpg");
+        in.set("Key", QString("Value"));
+
+        stream << in; // "../path/to/pictures/picture.jpg[Key=Value]" serialized to the stream
+
+        File out;
+        stream >> out;
+
+        out.name; // returns "../path/to/pictures/picture.jpg"
+        out.flat(); // returns "../path/to/pictures/picture.jpg[Key=Value]"
+    }
+
+---
+
+## Functions
+
+### Operator <a href=http://doc.qt.io/qt-5/QString.html>QString</a>() const
+
+returns [name](#name). Allows Files to be used as <a href=http://doc.qt.io/qt-5/QString.html>QString</a>.
+
+### <a href=http://doc.qt.io/qt-5/QString.html>QString</a> flat() const
+
+Returns the [name](#name) and [metadata](#m_metadata) as string.
+
+    File file("../path/to/pictures/picture.jpg");
+    file.set("Key1", QVariant::fromValue<float>(1));
+    file.set("Key2", QVariant::fromValue<float>(2));
+
+    file.flat(); // returns "../path/to/pictures/picture.jpg[Key1=1,Key2=2]"
+
+### <a href=http://doc.qt.io/qt-5/QString.html>QString</a> hash() const
+
+Returns a hash of the file.
+
+    File file("../path/to/pictures/picture.jpg");
+    file.set("Key1", QVariant::fromValue<float>(1));
+    file.set("Key2", QVariant::fromValue<float>(2));
+
+    file.hash(); // returns "kElVwY"
+
+### <a href=http://doc.qt.io/qt-5/qstringlist.html>QStringList</a> localKeys() const
+
+Returns an immutable version of the local metadata keys gotten by calling [metadata](#metadata).keys().
+
+    File file("../path/to/pictures/picture.jpg");
+    file.set("Key1", QVariant::fromValue<float>(1));
+    file.set("Key2", QVariant::fromValue<float>(2));
+
+    file.localKeys(); // returns [Key1, Key2]
+
+### <a href=http://doc.qt.io/qt-5/qvariant.html#QVariantMap-typedef>QVariantMap</a> localMetadata() const
+
+returns an immutable version of the local [metadata](#m_metadata).
+
+    File file("../path/to/pictures/picture.jpg");
+    file.set("Key1", QVariant::fromValue<float>(1));
+    file.set("Key2", QVariant::fromValue<float>(2));
+
+    file.localMetadata(); // return QMap(("Key1", QVariant(float, 1)) ("Key2", QVariant(float, 2)))
+
+### void append(<a href=http://doc.qt.io/qt-5/qvariant.html#QVariantMap-typedef>QVariantMap</a> &localMetadata)
+
+Add new metadata fields to [metadata](#m_metadata).
+
+    File f();
+    f.set("Key1", QVariant::fromValue<float>(1));
+
+    QVariantMap map;
+    map.insert("Key2", QVariant::fromValue<float>(2));
+    map.insert("Key3", QVariant::fromValue<float>(3));
+
+    f.append(map);
+    f.flat(); // returns "[Key1=1, Key2=2, Key3=3]"
+
+### void append(const [File](#file) &other)
+
+Append another file using the **;** separator. The file names are combined with the separator in between them. The metadata fields are combined. An additional field describing the separator is appended to the metadata.
+
+    File f1("../path/to/pictures/picture1.jpg");
+    f1.set("Key1", QVariant::fromValue<float>(1));
+
+    File f2("../path/to/pictures/picture2.jpg");
+    f2.set("Key2", QVariant::fromValue<float>(2));
+    f2.set("Key3", QVariant::fromValue<float>(3));
+
+    f1.append(f2);
+    f1.name; // return "../path/to/pictures/picture1.jpg;../path/to/pictures/picture2.jpg"
+    f1.localKeys(); // returns "[Key1, Key2, Key3, separator]"
+
+
+### File &operator +=(const <a href=http://doc.qt.io/qt-5/qmap.html>QMap</a><<a href=http://doc.qt.io/qt-5/QString.html>QString</a>, <a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a>> &other)
+
+Shortcut operator to call [append](#void-appendqvariantmap-localmetadata).
+
+### File &operator +=(const [File](#file) &other)
+
+Shortcut operator to call [append](#void-appendconst-file-other).
+
+### <a href=http://doc.qt.io/qt-5/qlist.html>QList</a><[File](#file)> split() const
+
+Parse [name](#name) and split on the **;** separator. Each split file has the same [metadata](#m_metadata) as the joined file.
+
+    File f1("../path/to/pictures/picture1.jpg");
+    f1.set("Key1", QVariant::fromValue<float>(1));
+
+    f1.split(); // returns [../path/to/pictures/picture1.jpg[Key1=1]]
+
+    File f2("../path/to/pictures/picture2.jpg");
+    f2.set("Key2", QVariant::fromValue<float>(2));
+    f2.set("Key3", QVariant::fromValue<float>(3));
+
+    f1.append(f2);
+    f1.split(); // returns [../path/to/pictures/picture1.jpg[Key1=1, Key2=2, Key3=3, separator=;],
+                    //          ../path/to/pictures/picture2.jpg[Key1=1, Key2=2, Key3=3, separator=;]]
+
+### <a href=http://doc.qt.io/qt-5/qlist.html>QList</a><[File](#file)> split(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &separator) const
+
+Split the file on the given separator. Each split file has the same [metadata](#m_metadata) as the joined file.
+
+    File f("../path/to/pictures/picture1.jpg,../path/to/pictures/picture2.jpg");
+    f.set("Key1", QVariant::fromValue<float>(1));
+    f.set("Key2", QVariant::fromValue<float>(2));
+
+    f.split(","); // returns [../path/to/pictures/picture1.jpg[Key1=1, Key2=2],
+                              ../path/to/pictures/picture2.jpg[Key1=1, Key2=2]]
+
+### void setParameter(int index, const <a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a> &value)
+
+Insert a keyless value into the [metadata](#m_metadata).
+
+    File f;
+    f.set("Key1", QVariant::fromValue<float>(1));
+    f.set("Key2", QVariant::fromValue<float>(2));
+
+    f.setParameter(1, QVariant::fromValue<float>(3));
+    f.setParameter(5, QVariant::fromValue<float>(4));
+
+    f.flat(); // returns "[Key1=1, Key2=2, Arg1=3, Arg5=4]"
+
+### bool operator ==(const char \*other) const
+
+Compare [name](#name) to c-style string other.
+
+    File f("picture.jpg");
+
+    f == "picture.jpg";       // returns true
+    f == "other_picture.jpg"; // returns false
+
+### bool operator ==(const [File](#file) &other) const
+
+Compare [name](#name) and [metadata](#m_metadata) to another file name and metadata for equality.
+
+    File f1("picture1.jpg");
+    File f2("picture1.jpg");
+
+    f1 == f2; // returns true
+
+    f1.set("Key1", QVariant::fromValue<float>(1));
+    f2.set("Key2", QVariant::fromValue<float>(2));
+
+    f1 == f2; // returns false (metadata doesn't match)
+
+### bool operator !=(const [File](#file) &other) const
+
+Compare [name](#name) and [metadata](#m_metadata) to another file name and metadata for inequality.
+
+    File f1("picture1.jpg");
+    File f2("picture1.jpg");
+
+    f1 != f2; // returns false
+
+    f1.set("Key1", QVariant::fromValue<float>(1));
+    f2.set("Key2", QVariant::fromValue<float>(2));
+
+    f1 != f2; // returns true (metadata doesn't match)
+
+### bool operator <(const [File](#file) &other) const
+
+Compare [name](#name) to a different file name.
+
+### bool operator <=(const [File](#file) &other) const
+
+Compare [name](#name) to a different file name.
+
+### bool operator >(const [File](#file) &other) const
+
+Compare [name](#name) to a different file name.
+
+### bool operator >=(const [File](#file) &other) const
+
+Compare [name](#name) to a different file name.
+
+### bool isNull() const
+
+Returns true if [name](#name) and [metadata](#m_metadata) are empty and false otherwise.
+
+    File f;
+    f.isNull(); // returns true
+
+    f.set("Key1", QVariant::fromValue<float>(1));
+    f.isNull(); // returns false
+
+### bool isTerminal() const
+
+Returns true if [name](#name) equals "Terminal".
+
+### bool exists() const
+
+Returns true if the file at [name](#name) exists on disk.
+
+### <a href=http://doc.qt.io/qt-5/QString.html>QString</a> fileName() const
+
+Returns the file's base name and extension.
+
+    File file("../path/to/pictures/picture.jpg");
+    file.fileName(); // returns "picture.jpg"
+
+### <a href=http://doc.qt.io/qt-5/QString.html>QString</a> baseName() const
+
+Returns the file's base name.
+
+    File file("../path/to/pictures/picture.jpg");
+    file.baseName(); // returns "picture"
+
+### <a href=http://doc.qt.io/qt-5/QString.html>QString</a> suffix() const
+
+Returns the file's extension.
+
+    File file("../path/to/pictures/picture.jpg");
+    file.suffix(); // returns "jpg"
+
+### <a href=http://doc.qt.io/qt-5/QString.html>QString</a> path() const
+
+Return's the path of the file, excluding the name.
+
+    File file("../path/to/pictures/picture.jpg");
+    file.suffix(); // returns "../path/to/pictures"
+
+### <a href=http://doc.qt.io/qt-5/QString.html>QString</a> resolved() const
+
+Returns [name](#name). If name does not exist it prepends name with the path in Globals->path.
+
+### bool contains(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key) const
+
+Returns True if the key is in the [metadata](#m_metadata) and False otherwise.
+
+    File file;
+    file.set("Key1", QVariant::fromValue<float>(1));
+
+    file.contains("Key1"); // returns true
+    file.contains("Key2"); // returns false
+
+### bool contains(const <a href=http://doc.qt.io/qt-4.8/qstringlist.html>QStringList</a> &keys) const
+
+Returns True if all of the keys are in the [metadata](#m_metadata) and False otherwise.
+
+    File file;
+    file.set("Key1", QVariant::fromValue<float>(1));
+    file.set("Key2", QVariant::fromValue<float>(2));
+
+    file.contains(QStringList("Key1")); // returns true
+    file.contains(QStringList() << "Key1" << "Key2") // returns true
+    file.contains(QStringList() << "Key1" << "Key3"); // returns false
+
+### <a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a> value(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key) const
+
+Returns the value associated with key in the [metadata](#m_metadata).
+
+    File file;
+    file.set("Key1", QVariant::fromValue<float>(1));
+    file.value("Key1"); // returns QVariant(float, 1)
+
+### void set(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key, const <a href=http://doc.qt.io/qt-5/qvariant.html>QVariant</a> &value)
+
+Insert or overwrite the [metadata](#m_metadata) key with the given value.
+
+    File f;
+    f.flat(); // returns ""
+
+    f.set("Key1", QVariant::fromValue<float>(1));
+    f.flat(); // returns "[Key1=1]"
+
+### void set(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key, const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &value)
+
+Insert or overwrite the [metadata](#m_metadata) key with the given value.
+
+    File f;
+    f.flat(); // returns ""
+
+    f.set("Key1", QString("1"));
+    f.flat(); // returns "[Key1=1]"
+
+### void setList(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key, const <a href=>QList</a><T> &value)
+
+This function requires a type specification in place of T. Insert or overwrite the [metadata](#m_metadata) key with the value. The value will remain a list and should be queried with the function [getList](#qlistt-getlistconst-qstring-key-const).
+
+    File file;
+
+    QList<float> list = QList<float>() << 1 << 2 << 3;
+    file.setList<float>("List", list);
+    file.getList<float>("List"); // return [1., 2. 3.]
+
+### void remove(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key)
+
+Remove the key value pair associated with the given key from the [metadata](#metadata)
+
+    File f;
+    f.set("Key1", QVariant::fromValue<float>(1));
+    f.set("Key2", QVariant::fromValue<float>(2));
+
+    f.flat(); // returns "[Key1=1, Key2=2]"
+
+    f.remove("Key1");
+    f.flat(); // returns "[Key2=2]"
+
+### T get(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key)
+
+This function requires a type specification in place of T. Try and get the value associated with the given key in the [metadata](#m_metadata). If the key does not exist or cannot be converted to the given type an error is thrown.
+
+    File f;
+    f.set("Key1", QVariant::fromValue<float>(1));
+
+    f.get<float>("Key1");  // returns 1
+    f.get<float>("Key2");  // Error: Key2 is not in the metadata
+    f.get<QRectF>("Key1"); // Error: A float can't be converted to a QRectF
+
+### T get(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key, const T &defaultValue)
+
+This function requires a type specification in place of T. Try and get the value associated with the given key in the [metadata](#m_metadata). If the key does not exist or cannot be converted to the given type the defaultValue is returned.
+
+    File f;
+    f.set("Key1", QVariant::fromValue<float>(1));
+
+    f.get<float>("Key1", 5);  // returns 1
+    f.get<float>("Key2", 5);  // returns 5
+    f.get<QRectF>("Key1", QRectF(0, 0, 10, 10)); // returns QRectF(0, 0, 10x10)
+
+### bool getBool(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key, bool defaultValue = false)
+
+This is a specialization of [get](#t-getconst-qstring-key) for the boolean type. If the key is not in the [metadata](#m_metadata) the defaultValue is returned. If the key is in the metadata but the value cannot be converted to a bool **true** is returned. If the key is found and the value can be converted to a bool the value is returned.
+
+    File f;
+    f.set("Key1", QVariant::fromValue<bool>(true));
+    f.set("Key2", QVariant::fromValue<float>(10));
+
+    f.getBool("Key1");       // returns true
+    f.getBool("Key2")        // returns true (key found)
+    f.getBool("Key3");       // returns false (default value)
+    f.getBool("Key3", true); // returns true (default value)
+
+### <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;T&gt; getList(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key) const
+
+This function requires a type specification in place of T. Similar to [get](#t-getconst-qstring-key) only this returns a list. If the key is not found or the value cannot be converted into a <a href=http://doc.qt.io/qt-5/QList.html>QList</a><T> an error is thrown.
+
+    File file;
+
+    QList<float> list = QList<float>() << 1 << 2 << 3;
+    file.setList<float>("List", list);
+
+    file.getList<float>("List");  // return [1., 2. 3.]
+    file.getList<QRectF>("List"); // Error: float cannot be converted to QRectF
+    file.getList<float>("Key");   // Error: key doesn't exist
+
+### <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;T&gt; getList(const <a href=http://doc.qt.io/qt-5/QString.html>QString</a> &key, const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;T&gt; &defaultValue) const
+
+This function requires a type specification in place of T. Similar to [get](#t-getconst-qstring-key-const-t-defaultvalue) only this returns a list. If the key is not found or the value cannot be converted into a <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;T&gt; the supplied defaultValue is returned.
+
+    File file;
+
+    QList<float> list = QList<float>() << 1 << 2 << 3;
+    file.setList<float>("List", list);
+
+    file.getList<float>("List", QList<float>());                  // return [1., 2. 3.]
+    file.getList<QRectF>("List", QList<QRectF>());                // return []
+    file.getList<float>("Key", QList<float>() << 1 << 2 << 3);    // return [1., 2., 3.]
+
+### <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a>&gt; namedPoints() const
+
+Find all of the points that can be parsed from [metadata](#m_metadata) keys and return them. Only values that are convertable to <a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a> are found. Values that can be converted to <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a>&gt; are not included.
+
+    File file;
+    file.set("Key1", QVariant::fromValue<QPointF>(QPointF(1, 1)));
+    file.set("Key2", QVariant::fromValue<QPointF>(QPointF(2, 2)));
+    file.set("Points", QVariant::fromValue<QPointF>(QPointF(3, 3)))
+
+    f.namedPoints(); // returns [QPointF(1, 1), QPointF(2, 2), QPointF(3, 3)]
+
+    file.setPoints(QList<QPointF>() << QPointF(3, 3)); // changes metadata["Points"] to QList<QPointF>
+    f.namedPoints(); // returns [QPointF(1, 1), QPointF(2, 2)]
+
+### <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a>&gt; points() const
+
+Returns the list of points stored in [metadata](#m_metadata)["Points"]. A list is expected and a single point not in a list will not be returned. Convenience functions [appendPoint](#void-appendpointconst-qpointf-point), [appendPoints](#void-appendpointsconst-qlistqpointf-points), [clearPoints](#void-clearpoints) and [setPoints](#void-setpointsconst-qlistqpointf-points) have been provided to manipulate the internal points list.
+
+    File file;
+    file.set("Points", QVariant::fromValue<QPointF>(QPointF(1, 1)));
+    file.points(); // returns [] (point is not in a list)
+
+    file.setPoints(QList<QPointF>() << QPointF(2, 2));
+    file.points(); // returns [QPointF(2, 2)]
+
+### void appendPoint(const <a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a> &point)
+
+Add a point to the file's points list stored in [metadata](#m_metadata)["Points"]
+
+    File file;
+    file.points(); // returns []
+
+    file.appendPoint(QPointF(1, 1));
+    file.points(); // returns [QPointF(1, 1)]
+
+### void appendPoints(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a>&gt; &points)
+
+Add a list of points to the file's points list stored in [metadata](#m_metadata)["Points"]
+
+    File file;
+    file.points(); // returns []
+
+    file.appendPoints(QList<QPointF>() << QPointF(1, 1) << QPointF(2, 2));
+    file.points(); // returns [QPointF(1, 1), QPointF(2, 2)]
+
+### void clearPoints()
+
+Clear the list of points stored in [metadata](#m_metadata)["Points"].
+
+    File file;
+    file.appendPoints(QList<QPointF>() << QPointF(1, 1) << QPointF(2, 2));
+    file.points(); // returns [QPointF(1, 1), QPointF(2, 2)]
+
+    file.clearPoints();
+    file.points(); // returns []
+
+### void setPoints(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qpointf.html>QPointF</a>&gt; &points)
+
+Clears the points stored in [metadata](#m_metadata) and replaces them with points.
+
+    File file;
+    file.appendPoints(QList<QPointF>() << QPointF(1, 1) << QPointF(2, 2));
+    file.points(); // returns [QPointF(1, 1), QPointF(2, 2)]
+
+    file.setPoints(QList<QPointF>() << QPointF(3, 3) << QPointF(4, 4));
+    file.points(); // returns [QPointF(3, 3), QPointF(4, 4)]
+
+### <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a>&gt; namedRects() const
+
+Find all of the rects that can be parsed from [metadata](#m_metadata) keys and return them. Only values that are convertable to <a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a> are found. Values that can be converted to <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a>&gt; are not included.
+
+    File file;
+    file.set("Key1", QVariant::fromValue<QRectF>(QRectF(1, 1, 5, 5)));
+    file.set("Key2", QVariant::fromValue<QRectF>(QRectF(2, 2, 5, 5)));
+    file.set("Rects", QVariant::fromValue<QRectF>(QRectF(3, 3, 5, 5)));
+
+    f.namedRects(); // returns [QRectF(1, 1, 5x5), QRectF(2, 2, 5x5), QRectF(3, 3, 5x5)]
+
+    file.setRects(QList<QRectF>() << QRectF(3, 3, 5x5)); // changes metadata["Rects"] to QList<QRectF>
+    f.namedRects(); // returns [QRectF(1, 1, 5x5), QRectF(2, 2, 5x5)]
+
+### <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a>&gt; rects() const
+
+Returns the list of points stored in [metadata](#m_metadata)["Rects"]. A list is expected and a single rect not in a list will not be returned. Convenience functions [appendRect](#void-appendrectconst-qrectf-rect), [appendRects](#void-appendrectsconst-qlistqrectf-rects), [clearRects](#void-clearrects) and [setRects](#void-setrectsconst-qlistqrectf-rects) have been provided to manipulate the internal points list.
+
+    File file;
+    file.set("Rects", QVariant::fromValue<QRectF>(QRectF(1, 1, 5, 5)));
+    file.rects(); // returns [] (rect is not in a list)
+
+    file.setRects(QList<QRectF>() << QRectF(2, 2, 5, 5));
+    file.rects(); // returns [QRectF(2, 2, 5x5)]
+
+### void appendRect(const <a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a> &rect)
+
+Add a rect to the file's rects list stored in [metadata](#m_metadata)["Rects"].
+
+    File file;
+    file.rects(); // returns []
+
+    file.appendRect(QRectF(1, 1, 5, 5));
+    file.rects(); // returns [QRectF(1, 1, 5x5)]
+
+### void appendRect(const <a href=http://docs.opencv.org/modules/core/doc/basic_structures.html#rect>Rect</a> &rect)
+
+Add a OpenCV style rect to the file's rects list stored in [metadata](#m_metadata)["Rects"]. The rect is automatically converted to a QRectF.
+
+    File file;
+    file.rects(); // returns []
+
+    file.appendRect(cv::Rect(1, 1, 5, 5)); // automatically converted to QRectF
+    file.rects(); // returns [QRectF(1, 1, 5x5)]
+
+### void appendRects(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a>&gt; &rects)
+
+Add a list of rects to the file's rects list stored in [metadata](#m_metadata)["Rects"]
+
+    File file;
+    file.rects(); // returns []
+
+    file.appendRects(QList<QRectF>() << QRectF(1, 1, 5, 5) << QRectF(2, 2, 5, 5));
+    file.rects(); // returns [QRectF(1, 1, 5x5), QRectF(2, 2, 5x5)]
+
+### void appendRects(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://docs.opencv.org/modules/core/doc/basic_structures.html#rect>Rect</a>&gt; &rects)
+
+Add a list of OpenCV style rects to the file's rects list stored in [metadata](#m_metadata)["Rects"]. Each rect is automatically converted to a QRectF.
+
+    File file;
+    file.rects(); // returns []
+
+    file.appendRects(QList<cv::Rect>() << cv::Rect(1, 1, 5, 5) << cv::Rect(2, 2, 5, 5));
+    file.rects(); // returns [QRectF(1, 1, 5x5), QRectF(2, 2, 5x5)]
+
+
+### void clearRects()
+
+Clear the list of rects stored in [metadata](#m_metadata)["Rects"].
+
+    File file;
+    file.appendRects(QList<QRectF>() << QRectF(1, 1, 5, 5) << QRectF(2, 2, 5, 5));
+    file.rects(); // returns [QRectF(1, 1, 5x5), QRectF(2, 2, 5x5)]
+
+    file.clearRects();
+    file.rects(); // returns []
+
+### void setRects(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://doc.qt.io/qt-4.8/qrectf.html>QRectF</a>&gt; &rects)
+
+Clears the rects stored in [metadata](#m_metadata)["Rects"] and replaces them with the given rects.
+
+    File file;
+    file.appendRects(QList<QRectF>() << QRectF(1, 1, 5, 5) << QRectF(2, 2, 5, 5));
+    file.rects(); // returns [QRectF(1, 1, 5x5), QRectF(2, 2, 5x5)]
+
+    file.setRects(QList<QRectF>() << QRectF(3, 3, 5, 5) << QRectF(4, 4, 5, 5));
+    file.rects(); // returns [QRectF(3, 3, 5x5), QRectF(4, 4, 5x5)]
+
+### void setRects(const <a href=http://doc.qt.io/qt-5/QList.html>QList</a>&lt;<a href=http://docs.opencv.org/modules/core/doc/basic_structures.html#rect>Rect</a>&gt; &rects)
+
+Clears the rects stored in [metadata](#m_metadata)["Rects"] and replaces them with the given OpenCV style rects.
+
+    File file;
+    file.appendRects(QList<cv::Rect>() << cv::Rect(1, 1, 5, 5) << cv::Rect(2, 2, 5, 5));
+    file.rects(); // returns [QRectF(1, 1, 5x5), QRectF(2, 2, 5x5)]
+
+    file.setRects(QList<cv::Rect>() << cv::Rect(3, 3, 5, 5) << cv::Rect(4, 4, 5, 5));
+    file.rects(); // returns [QRectF(3, 3, 5x5), QRectF(4, 4, 5x5)]
+
+---
+
+# FileList
+
+A convenience class for dealing with lists of files.
+
+## Constructors
+
+### FileList()
+
+Default constructor. Doesn't do anything
+
+### FileList(int n)
+
+Initialize the [FileList](#filelist) with n empty files
+
+### FileList(const <a href=http://doc.qt.io/qt-4.8/qstringlist.html>QStringList</a> &files)
+
+Initialize the [FileList](#filelist) from a list of strings. Each string should have the format "filename[key1=value1, key2=value2, ... keyN=valueN]"
+
+### FileList(const <a href=http://doc.qt.io/qt-4.8/qlist.html>QList</a>&lt;[File](#file)&gt; &files)
+
+Initialize the [FileList](#filelist) from a list of [files](#file).
+
+## Static Functions
+
+### static FileList fromGallery(const [File](#file) &gallery, bool cache = false)
+
+Creates a [FileList](#filelist) from a [Gallery](#gallery). Galleries store one or more [Templates](#template) on disk. Common formats include csv, xml, and gal, which is a unique OpenBR format. Read more about this in the [Gallery](#gallery) section. This function creates a [FileList](#filelist) by parsing the stored gallery based on its format. Cache determines whether the gallery should be stored for faster reading later.
+
+    File gallery("gallery.csv");
+
+    FileList fList = FileList::fromGallery(gallery);
+    fList.flat(); // returns all the files that have been loaded from disk. It could
+                  // be 1 or 100 depending on what was stored.
+
+## Functions
+
+### <a href=http://doc.qt.io/qt-4.8/qstringlist.html>QStringList</a> flat() const
+
+Calls [flat](#qstring-flat-const) on every [File](#file) in the list and returns the resulting strings as a <a href=http://doc.qt.io/qt-4.8/qstringlist.html>QStringList</a>.
+
+    File f1("picture1.jpg"), f2("picture2.jpg");
+    f1.set("Key", QString("Value"));
+
+    FileList fList(QList<File>() << f1 << f2);
+    fList.flat(); // returns ["picture1.jpg[Key=Value]", "picture2.jpg"]
+
+### <a href=http://doc.qt.io/qt-4.8/qstringlist.html>QStringList</a> names() const
+
+Stores the name of every [file](#file) in the list and returns the resulting strings as a <a href=http://doc.qt.io/qt-4.8/qstringlist.html>QStringList</a>.
+
+    File f1("picture1.jpg"), f2("picture2.jpg");
+    f1.set("Key", QString("Value"));
+
+    FileList fList(QList<File>() << f1 << f2);
+    fList.names(); // returns ["picture1.jpg", "picture2.jpg"]
+
+### void sort(const <a href=http://doc.qt.io/qt-4.8/qstring.html>QString</a> &key)
+
+Sorts the [FileList](#filelist) based on the value associated with the given key in each file.
+
+    File f1("1"), f2("2"), f3("3");
+    f1.set("Key", QVariant::fromValue<float>(3));
+    f2.set("Key", QVariant::fromValue<float>(1));
+    f3.set("Key", QVariant::fromValue<float>(2));
+
+    FileList fList(QList<File>() << f1 << f2 << f3);
+    fList.names(); // returns ["1", "2", "3"]
+
+    fList.sort("Key");
+    fList.names(); // returns ["2", "3", "1"]
+
+---
+
+# Template
+
+---
+
+# TemplateList
+
+---
+
+# Transform
+
+---
+
+# UntrainableTransform
+
+---
+
+# MetaTransform
+
+---
+
+# UntrainableMetaTransform
+
+---
+
+# MetadataTransform
+
+---
+
+# UntrainableMetadataTransform
+
+---
+
+# TimeVaryingTransform
+
+---
+
+# Distance
+
+---
+
+# UntrainableDistance
+
+---
+
+# Output
+
+---
+
+# MatrixOutput
+
+---
+
+# Format
+
+---
+
+# Representation
+
+---
+
+# Classifier
+---
+
+# AdaBoostTransform
+
+Wraps OpenCV's Ada Boost framework
+
+* **file:** classification/adaboost.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# EBIFTransform
+
+Face Recognition Using Early Biologically Inspired Features
+
+* **file:** classification/ebif.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ForestTransform
+
+Wraps OpenCV's random trees framework
+
+* **file:** classification/forest.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# ForestInductionTransform
+
+Wraps OpenCV's random trees framework to induce features
+
+* **file:** classification/forest.cpp
+* **inherits:** [ForestTransform](../cpp_api.md#foresttransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# IPC2013Initializer
+
+Initializes Intel Perceptual Computing SDK 2013
+
+* **file:** classification/ipc2013.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# IPC2013FaceRecognitionTransfrom
+
+Intel Perceptual Computing SDK 2013 Face Recognition
+
+* **file:** classification/ipc2013.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# EigenInitializer
+
+Initialize Eigen
+
+* **file:** classification/lda.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# PCATransform
+
+Projects input into learned Principal Component Analysis subspace.
+
+* **file:** classification/lda.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **authors:** Brendan Klare, Josh Klontz
+* **properties:** None
+
+---
+
+# RowWisePCATransform
+
+PCA on each row.
+
+* **file:** classification/lda.cpp
+* **inherits:** [PCATransform](../cpp_api.md#pcatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DFFSTransform
+
+Computes Distance From Feature Space (DFFS)
+
+* **file:** classification/lda.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# LDATransform
+
+Projects input into learned Linear Discriminant Analysis subspace.
+
+* **file:** classification/lda.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **authors:** Brendan Klare, Josh Klontz
+* **properties:** None
+
+---
+
+# SparseLDATransform
+
+Projects input into learned Linear Discriminant Analysis subspace
+
+* **file:** classification/lda.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# MLPTransform
+
+Wraps OpenCV's multi-layer perceptron framework
+
+* **file:** classification/mlp.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# NT4Initializer
+
+Initialize Neurotech SDK 4
+
+* **file:** classification/nt4.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **authors:** Josh Klontz, E. Taborsky
+* **properties:** None
+
+---
+
+# NT4DetectFace
+
+Neurotech face detection
+
+* **file:** classification/nt4.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **authors:** Josh Klontz, E. Taborsky
+* **properties:** None
+
+---
+
+# NT4EnrollFace
+
+Enroll face in Neurotech SDK 4
+
+* **file:** classification/nt4.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# NT4EnrollIris
+
+Enroll iris in Neurotech SDK 4
+
+* **file:** classification/nt4.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** E. Taborsky
+* **properties:** None
+
+---
+
+# NT4Compare
+
+Compare templates with Neurotech SDK 4
+
+* **file:** classification/nt4.cpp
+* **inherits:** [Distance](../cpp_api.md#distance)
+* **authors:** Josh Klontz, E. Taborsky
+* **properties:** None
+
+---
+
+# PP4Initializer
+
+Initialize PittPatt 4
+
+* **file:** classification/pp4.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# PP4EnrollTransform
+
+Enroll faces in PittPatt 4
+
+* **file:** classification/pp4.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# PP5Initializer
+
+Initialize PP5
+
+* **file:** classification/pp5.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **authors:** Josh Klontz, E. Taborsky
+* **properties:** None
+
+---
+
+# PP5EnrollTransform
+
+Enroll faces in PP5
+
+* **file:** classification/pp5.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **authors:** Josh Klontz, E. Taborsky
+* **properties:** None
+
+---
+
+# PP5CompareDistance
+
+Compare templates with PP5
+
+* **file:** classification/pp5.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **authors:** Josh Klontz, E. Taborsky
+* **properties:** None
+
+---
+
+# SVMTransform
+
+C. Burges. "A tutorial on support vector machines for pattern recognition,"
+
+* **file:** classification/svm.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SVMDistance
+
+SVM Regression on template absolute differences.
+
+* **file:** classification/svm.cpp
+* **inherits:** [Distance](../cpp_api.md#distance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# TurkClassifierTransform
+
+Convenience class for training turk attribute regressors
+
+* **file:** classification/turk.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CollectNNTransform
+
+Collect nearest neighbors and append them to metadata.
+
+* **file:** cluster/collectnn.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# KMeansTransform
+
+Wraps OpenCV kmeans and flann.
+
+* **file:** cluster/kmeans.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# KNNTransform
+
+K nearest neighbors classifier.
+
+* **file:** cluster/knn.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# LogNNTransform
+
+Log nearest neighbors to specified file.
+
+* **file:** cluster/lognn.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api.md#timevaryingtransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# RandomCentroidsTransform
+
+Chooses k random points to be centroids.
+
+* **file:** cluster/randomcentroids.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# AlgorithmsInitializer
+
+Initializes global abbreviations with implemented algorithms
+
+* **file:** core/algorithms.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ProcrustesAlignTransform
+
+Improved procrustes alignment of points, to include a post processing scaling of points
+
+* **file:** core/align.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# TextureMapTransform
+
+Maps texture from one set of points to another. Assumes that points are rigidly transformed
+
+* **file:** core/align.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **authors:** Brendan Klare, Scott Klum
+* **properties:** None
+
+---
+
+# SynthesizePointsTransform
+
+Synthesize additional points via triangulation.
+
+* **file:** core/align.cpp
+* **inherits:** [MetadataTransform](../cpp_api.md#metadatatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ProcrustesInitializer
+
+Initialize Procrustes croppings
+
+* **file:** core/align.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# AttributeAlgorithmsInitializer
+
+Initializes global abbreviations with implemented algorithms for attributes
+
+* **file:** core/attributealgorithms.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Babatunde Ogunfemi
+* **properties:** None
+
+---
+
+# CacheTransform
+
+Caches br::Transform::project() results.
+
+* **file:** core/cache.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ContractTransform
+
+It's like the opposite of ExpandTransform, but not really
+
+* **file:** core/contract.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# CrossValidateTransform
+
+Cross validate a trainable transform.
+
+* **file:** core/crossvalidate.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **authors:** Josh Klontz, Scott Klum
+* **properties:** None
+
+---
+
+# DiscardTransform
+
+Removes all template's matrices.
+
+* **file:** core/discard.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ExpandTransform
+
+Performs an expansion step on input templatelists
+
+* **file:** core/expand.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# FirstTransform
+
+Removes all but the first matrix from the template.
+
+* **file:** core/first.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ForkTransform
+
+Transforms in parallel.
+
+* **file:** core/fork.cpp
+* **inherits:** [CompositeTransform](../cpp_api.md#compositetransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# FTETransform
+
+Flags images that failed to enroll based on the specified transform.
+
+* **file:** core/fte.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# GalleryCompareTransform
+
+Compare each template to a fixed gallery (with name = galleryName), using the specified distance.
+
+* **file:** core/gallerycompare.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# IdentityTransform
+
+A no-op transform.
+
+* **file:** core/identity.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# IndependentTransform
+
+Clones the transform so that it can be applied independently.
+
+* **file:** core/independent.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# JNIInitializer
+
+Initialize JNI
+
+* **file:** core/jni.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Jordan Cheney
+* **properties:** None
+
+---
+
+# LikelyTransform
+
+Generic interface to Likely JIT compiler
+
+* **file:** core/likely.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# LoadStoreTransform
+
+Caches transform training.
+
+* **file:** core/loadstore.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# PipeTransform
+
+Transforms in series.
+
+* **file:** core/pipe.cpp
+* **inherits:** [CompositeTransform](../cpp_api.md#compositetransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ProcessWrapperTransform
+
+Interface to a separate process
+
+* **file:** core/processwrapper.cpp
+* **inherits:** [WrapperTransform](../cpp_api.md#wrappertransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# Registrar
+
+Register custom objects with Qt meta object system.
+
+* **file:** core/registrar.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# RestTransform
+
+Removes the first matrix from the template.
+
+* **file:** core/rest.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SchrodingerTransform
+
+Generates two templates, one of which is passed through a transform and the other
+
+* **file:** core/schrodinger.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# SingletonTransform
+
+A globally shared transform.
+
+* **file:** core/singleton.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# AttributeDistance
+
+Attenuation function based distance from attributes
+
+* **file:** distance/attribute.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# BayesianQuantizationDistance
+
+Bayesian quantization distance
+
+* **file:** distance/bayesianquantization.cpp
+* **inherits:** [Distance](../cpp_api.md#distance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ByteL1Distance
+
+Fast 8-bit L1 distance
+
+* **file:** distance/byteL1.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CrossValidateDistance
+
+Cross validate a distance metric.
+
+* **file:** distance/crossvalidate.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DefaultDistance
+
+DistDistance wrapper.
+
+* **file:** distance/default.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DistDistance
+
+Standard distance metrics
+
+* **file:** distance/dist.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# FilterDistance
+
+Checks target metadata against filters.
+
+* **file:** distance/filter.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# FuseDistance
+
+Fuses similarity scores across multiple matrices of compared templates
+
+* **file:** distance/fuse.cpp
+* **inherits:** [Distance](../cpp_api.md#distance)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# HalfByteL1Distance
+
+Fast 4-bit L1 distance
+
+* **file:** distance/halfbyteL1.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# HeatMapDistance
+
+1v1 heat map comparison
+
+* **file:** distance/heatmap.cpp
+* **inherits:** [Distance](../cpp_api.md#distance)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# IdenticalDistance
+
+Returns
+
+* **file:** distance/identical.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# KeyPointMatcherDistance
+
+Wraps OpenCV Key Point Matcher
+
+* **file:** distance/keypointmatcher.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# L1Distance
+
+L1 distance computed using eigen.
+
+* **file:** distance/L1.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# L2Distance
+
+L2 distance computed using eigen.
+
+* **file:** distance/L2.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# MatchProbabilityDistance
+
+Match Probability
+
+* **file:** distance/matchprobability.cpp
+* **inherits:** [Distance](../cpp_api.md#distance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# MetadataDistance
+
+Checks target metadata against query metadata.
+
+* **file:** distance/metadata.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# NegativeLogPlusOneDistance
+
+Returns -log(distance(a,b)+1)
+
+* **file:** distance/neglogplusone.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# OnlineDistance
+
+Online distance metric to attenuate match scores across multiple frames
+
+* **file:** distance/online.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Brendan klare
+* **properties:** None
+
+---
+
+# PipeDistance
+
+Distances in series.
+
+* **file:** distance/pipe.cpp
+* **inherits:** [Distance](../cpp_api.md#distance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RejectDistance
+
+Sets distance to -FLOAT_MAX if a target template has/doesn't have a key.
+
+* **file:** distance/reject.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# SumDistance
+
+Sum match scores across multiple distances
+
+* **file:** distance/sum.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# TurkDistance
+
+Unmaps Turk HITs to be compared against query mats
+
+* **file:** distance/turk.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# UnitDistance
+
+Linear normalizes of a distance so the mean impostor score is 0 and the mean genuine score is 1.
+
+* **file:** distance/unit.cpp
+* **inherits:** [Distance](../cpp_api.md#distance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# binaryFormat
+
+A simple binary matrix format.
+
+* **file:** format/binary.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# csvFormat
+
+Reads a comma separated value file.
+
+* **file:** format/csv.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ebtsFormat
+
+Reads FBI EBTS transactions.
+
+* **file:** format/ebts.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# lffsFormat
+
+Reads a NIST LFFS file.
+
+* **file:** format/lffs.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# lmatFormat
+
+Likely matrix format
+
+* **file:** format/lmat.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# matFormat
+
+MATLAB <tt>.mat</tt> format.
+
+* **file:** format/mat.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# mtxFormat
+
+Reads a NIST BEE similarity matrix.
+
+* **file:** format/mtx.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# maskFormat
+
+Reads a NIST BEE mask matrix.
+
+* **file:** format/mtx.cpp
+* **inherits:** [mtxFormat](../cpp_api.md#mtxformat)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# nullFormat
+
+Returns an empty matrix.
+
+* **file:** format/null.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# postFormat
+
+Handle POST requests
+
+* **file:** format/post.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# rawFormat
+
+RAW format
+
+* **file:** format/raw.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# scoresFormat
+
+Reads in scores or ground truth from a text table.
+
+* **file:** format/scores.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# urlFormat
+
+Reads image files from the web.
+
+* **file:** format/url.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# videoFormat
+
+Read all frames of a video using OpenCV
+
+* **file:** format/video.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# webcamFormat
+
+Retrieves an image from a webcam.
+
+* **file:** format/video.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DefaultFormat
+
+Reads image files.
+
+* **file:** format/video.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# xmlFormat
+
+Decodes images from Base64 xml
+
+* **file:** format/xml.cpp
+* **inherits:** [Format](../cpp_api.md#format)
+* **authors:** Scott Klum, Josh Klontz
+* **properties:** None
+
+---
+
+# arffGallery
+
+Weka ARFF file format.
+
+* **file:** gallery/arff.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# galGallery
+
+A binary gallery.
+
+* **file:** gallery/binary.cpp
+* **inherits:** [BinaryGallery](../cpp_api.md#binarygallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# utGallery
+
+A contiguous array of br_universal_template.
+
+* **file:** gallery/binary.cpp
+* **inherits:** [BinaryGallery](../cpp_api.md#binarygallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# urlGallery
+
+Newline-separated URLs.
+
+* **file:** gallery/binary.cpp
+* **inherits:** [BinaryGallery](../cpp_api.md#binarygallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# jsonGallery
+
+Newline-separated JSON objects.
+
+* **file:** gallery/binary.cpp
+* **inherits:** [BinaryGallery](../cpp_api.md#binarygallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# crawlGallery
+
+Crawl a root location for image files.
+
+* **file:** gallery/crawl.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# csvGallery
+
+Treats each line as a file.
+
+* **file:** gallery/csv.cpp
+* **inherits:** [FileGallery](../cpp_api.md#filegallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# dbGallery
+
+Database input.
+
+* **file:** gallery/db.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DefaultGallery
+
+Treats the gallery as a br::Format.
+
+* **file:** gallery/default.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# EmptyGallery
+
+Reads/writes templates to/from folders.
+
+* **file:** gallery/empty.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# FDDBGallery
+
+Implements the FDDB detection format.
+
+* **file:** gallery/fddb.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# flatGallery
+
+Treats each line as a call to File::flat()
+
+* **file:** gallery/flat.cpp
+* **inherits:** [FileGallery](../cpp_api.md#filegallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# googleGallery
+
+Input from a google image search.
+
+* **file:** gallery/google.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# keyframesGallery
+
+Read key frames of a video with LibAV
+
+* **file:** gallery/keyframes.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Ben Klein
+* **properties:** None
+
+---
+
+# mp4Gallery
+
+Read key frames of a .mp4 video file with LibAV
+
+* **file:** gallery/keyframes.cpp
+* **inherits:** [keyframesGallery](../cpp_api.md#keyframesgallery)
+* **author:** Ben Klein
+* **properties:** None
+
+---
+
+# landmarksGallery
+
+Text format for associating anonymous landmarks with images.
+
+* **file:** gallery/landmarks.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# lmatGallery
+
+Likely matrix format
+
+* **file:** gallery/lmat.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# matrixGallery
+
+Combine all templates into one large matrix and process it as a br::Format
+
+* **file:** gallery/matrix.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# MemoryGalleries
+
+Initialization support for memGallery.
+
+* **file:** gallery/mem.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# memGallery
+
+A gallery held in memory.
+
+* **file:** gallery/mem.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# postGallery
+
+Handle POST requests
+
+* **file:** gallery/post.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# statGallery
+
+Print template statistics.
+
+* **file:** gallery/stat.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# templateGallery
+
+Treat the file as a single binary template.
+
+* **file:** gallery/template.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# turkGallery
+
+For Amazon Mechanical Turk datasets
+
+* **file:** gallery/turk.cpp
+* **inherits:** [Gallery](../cpp_api.md#gallery)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# txtGallery
+
+Treats each line as a file.
+
+* **file:** gallery/txt.cpp
+* **inherits:** [FileGallery](../cpp_api.md#filegallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# xmlGallery
+
+A
+
+* **file:** gallery/xml.cpp
+* **inherits:** [FileGallery](../cpp_api.md#filegallery)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# AdjacentOverlayTransform
+
+Load the image named in the specified property, draw it on the current matrix adjacent to the rect specified in the other property.
+
+* **file:** gui/adjacentoverlay.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# DrawTransform
+
+Renders metadata onto the image.
+
+* **file:** gui/draw.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DrawDelaunayTransform
+
+Creates a Delaunay triangulation based on a set of points
+
+* **file:** gui/drawdelaunay.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# DrawGridLinesTransform
+
+Draws a grid on the image
+
+* **file:** gui/drawgridlines.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DrawOpticalFlow
+
+Draw a line representing the direction and magnitude of optical flow at the specified points.
+
+* **file:** gui/drawopticalflow.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# DrawPropertiesPointTransform
+
+Draw the values of a list of properties at the specified point on the image
+
+* **file:** gui/drawpropertiespoint.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# DrawPropertyPointTransform
+
+Draw the value of the specified property at the specified point on the image
+
+* **file:** gui/drawpropertypoint.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# DrawSegmentation
+
+Fill in the segmentations or draw a line between intersecting segments.
+
+* **file:** gui/drawsegmentation.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# ShowTransform
+
+Displays templates in a GUI pop-up window using QT.
+
+* **file:** gui/show.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api.md#timevaryingtransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# ShowTrainingTransform
+
+Show the training data
+
+* **file:** gui/show.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ManualTransform
+
+Manual selection of landmark locations
+
+* **file:** gui/show.cpp
+* **inherits:** [ShowTransform](../cpp_api.md#showtransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# ManualRectsTransform
+
+Manual select rectangular regions on an image.
+
+* **file:** gui/show.cpp
+* **inherits:** [ShowTransform](../cpp_api.md#showtransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# ElicitTransform
+
+Elicits metadata for templates in a pretty GUI
+
+* **file:** gui/show.cpp
+* **inherits:** [ShowTransform](../cpp_api.md#showtransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# SurveyTransform
+
+Display an image, and asks a yes/no question about it
+
+* **file:** gui/show.cpp
+* **inherits:** [ShowTransform](../cpp_api.md#showtransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# FPSLimit
+
+Limits the frequency of projects going through this transform to the input targetFPS
+
+* **file:** gui/show.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api.md#timevaryingtransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# FPSCalc
+
+Calculates the average FPS of projects going through this transform, stores the result in AvgFPS
+
+* **file:** gui/show.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api.md#timevaryingtransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# AbsTransform
+
+Computes the absolute value of each element.
+
+* **file:** imgproc/abs.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# AbsDiffTransform
+
+Take the absolute difference of two matrices.
+
+* **file:** imgproc/absdiff.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# AdaptiveThresholdTransform
+
+Wraps OpenCV's adaptive thresholding.
+
+* **file:** imgproc/adaptivethreshold.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# AffineTransform
+
+Performs a two or three point registration.
+
+* **file:** imgproc/affine.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# AndTransform
+
+Logical AND of two matrices.
+
+* **file:** imgproc/and.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ApplyMaskTransform
+
+Applies a mask from the metadata.
+
+* **file:** imgproc/applymask.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# BayesianQuantizationTransform
+
+Quantize into a space where L1 distance approximates log-likelihood.
+
+* **file:** imgproc/bayesianquantization.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# BinarizeTransform
+
+Approximate floats as signed bit.
+
+* **file:** imgproc/binarize.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# BlendTransform
+
+Alpha-blend two matrices
+
+* **file:** imgproc/blend.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# BlurTransform
+
+Gaussian blur
+
+* **file:** imgproc/blur.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ByRowTransform
+
+Turns each row into its own matrix.
+
+* **file:** imgproc/byrow.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CannyTransform
+
+Warpper to OpenCV Canny edge detector
+
+* **file:** imgproc/canny.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# CatTransform
+
+Concatenates all input matrices into a single matrix.
+
+* **file:** imgproc/cat.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CatColsTransform
+
+Concatenates all input matrices by column into a single matrix.
+
+* **file:** imgproc/catcols.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# CatRowsTransform
+
+Concatenates all input matrices by row into a single matrix.
+
+* **file:** imgproc/catrows.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CenterTransform
+
+Normalize each dimension based on training data.
+
+* **file:** imgproc/center.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ContrastEqTransform
+
+Xiaoyang Tan; Triggs, B.;
+
+* **file:** imgproc/contrasteq.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CropTransform
+
+Crops about the specified region of interest.
+
+* **file:** imgproc/crop.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CropBlackTransform
+
+Crop out black borders
+
+* **file:** imgproc/cropblack.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CropFromMaskTransform
+
+Crops image based on mask metadata
+
+* **file:** imgproc/cropfrommask.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# CropSquareTransform
+
+Trim the image so the width and the height are the same size.
+
+* **file:** imgproc/cropsquare.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CryptographicHashTransform
+
+Wraps QCryptographicHash
+
+* **file:** imgproc/cryptographichash.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CvtTransform
+
+Colorspace conversion.
+
+* **file:** imgproc/cvt.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CvtFloatTransform
+
+Convert to floating point format.
+
+* **file:** imgproc/cvtfloat.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# CvtUCharTransform
+
+Convert to uchar format
+
+* **file:** imgproc/cvtuchar.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# NLMeansDenoisingTransform
+
+Wraps OpenCV Non-Local Means Denoising
+
+* **file:** imgproc/denoising.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DiscardAlphaTransform
+
+Drop the alpha channel (if exists).
+
+* **file:** imgproc/discardalpha.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# DivTransform
+
+Enforce a multiple of
+
+* **file:** imgproc/div.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DoGTransform
+
+Difference of gaussians
+
+* **file:** imgproc/dog.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DownsampleTransform
+
+Downsample the rows and columns of a matrix.
+
+* **file:** imgproc/downsample.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Lacey Best-Rowden
+* **properties:** None
+
+---
+
+# DupTransform
+
+Duplicates the template data.
+
+* **file:** imgproc/dup.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# EnsureChannelsTransform
+
+Enforce the matrix has a certain number of channels by adding or removing channels.
+
+* **file:** imgproc/ensurechannels.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# EqualizeHistTransform
+
+Histogram equalization
+
+* **file:** imgproc/equalizehist.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# FlipTransform
+
+Flips the image about an axis.
+
+* **file:** imgproc/flip.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# FloodTransform
+
+Fill black pixels with the specified color.
+
+* **file:** imgproc/flood.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# GaborTransform
+
+http://en.wikipedia.org/wiki/Gabor_filter
+
+* **file:** imgproc/gabor.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# GaborJetTransform
+
+A vector of gabor wavelets applied at a point.
+
+* **file:** imgproc/gabor.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# GammaTransform
+
+Gamma correction
+
+* **file:** imgproc/gamma.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# GradientTransform
+
+Computes magnitude and/or angle of image.
+
+* **file:** imgproc/gradient.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# GradientMaskTransform
+
+Masks image according to pixel change.
+
+* **file:** imgproc/gradientmask.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# GroupTransform
+
+Group all input matrices into a single matrix.
+
+* **file:** imgproc/group.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# HistTransform
+
+Histograms the matrix
+
+* **file:** imgproc/hist.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# HistBinTransform
+
+Quantizes the values into bins.
+
+* **file:** imgproc/histbin.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# HistEqQuantizationTransform
+
+Approximate floats as uchar with different scalings for each dimension.
+
+* **file:** imgproc/histeqquantization.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# HoGDescriptorTransform
+
+OpenCV HOGDescriptor wrapper
+
+* **file:** imgproc/hog.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# InpaintTransform
+
+Wraps OpenCV inpainting
+
+* **file:** imgproc/inpaint.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# IntegralTransform
+
+Computes integral image.
+
+* **file:** imgproc/integral.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# IntegralHistTransform
+
+An integral histogram
+
+* **file:** imgproc/integralhist.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# IntegralSamplerTransform
+
+Sliding window feature extraction from a multi-channel integral image.
+
+* **file:** imgproc/integralsampler.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# KernelHashTransform
+
+Kernel hash
+
+* **file:** imgproc/kernelhash.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# KeyPointDescriptorTransform
+
+Wraps OpenCV Key Point Descriptor
+
+* **file:** imgproc/keypointdescriptor.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# LargestConvexAreaTransform
+
+Set the template's label to the area of the largest convex hull.
+
+* **file:** imgproc/largestconvexarea.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# LBPTransform
+
+Ahonen, T.; Hadid, A.; Pietikainen, M.;
+
+* **file:** imgproc/lbp.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# LimitSizeTransform
+
+Limit the size of the template
+
+* **file:** imgproc/limitsize.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# LTPTransform
+
+Tan, Xiaoyang, and Bill Triggs. "Enhanced local texture feature sets for face recognition under difficult lighting conditions." Analysis and Modeling of Faces and Gestures. Springer Berlin Heidelberg, 2007. 168-182.
+
+* **file:** imgproc/ltp.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **authors:** Brendan Klare, Josh Klontz
+* **properties:** None
+
+---
+
+# MAddTransform
+
+dst = a*src+b
+
+* **file:** imgproc/madd.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# MaskTransform
+
+Applies an eliptical mask
+
+* **file:** imgproc/mask.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# MatStatsTransform
+
+Statistics
+
+* **file:** imgproc/matstats.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# MeanTransform
+
+Computes the mean of a set of templates.
+
+* **file:** imgproc/mean.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# MeanFillTransform
+
+Fill 0 pixels with the mean of non-0 pixels.
+
+* **file:** imgproc/meanfill.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# MergeTransform
+
+Wraps OpenCV merge
+
+* **file:** imgproc/merge.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# MorphTransform
+
+Morphological operator
+
+* **file:** imgproc/morph.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# BuildScalesTransform
+
+Document me
+
+* **file:** imgproc/multiscale.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# NormalizeTransform
+
+Normalize matrix to unit length
+
+* **file:** imgproc/normalize.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:**
+
+	* **NormType**-  Values are NORM_INF, NORM_L1, NORM_L2, NORM_MINMAX
+	* **ByRow**-  If true normalize each row independently otherwise normalize the entire matrix.
+	* **alpha**-  Lower bound if using NORM_MINMAX. Value to normalize to otherwise.
+	* **beta**-  Upper bound if using NORM_MINMAX. Not used otherwise.
+	* **squareRoot**-  If true compute the signed square root of the output after normalization.
+
+
+---
+
+# OrigLinearRegressionTransform
+
+Prediction with magic numbers from jmp; must get input as blue;green;red
+
+* **file:** imgproc/origlinearregression.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** E. Taborsky
+* **properties:** None
+
+---
+
+# PackTransform
+
+Compress two uchar into one uchar.
+
+* **file:** imgproc/pack.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# PowTransform
+
+Raise each element to the specified power.
+
+* **file:** imgproc/pow.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ProductQuantizationDistance
+
+Distance in a product quantized space
+
+* **file:** imgproc/productquantization.cpp
+* **inherits:** [UntrainableDistance](../cpp_api.md#untrainabledistance)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ProductQuantizationTransform
+
+Product quantization
+
+* **file:** imgproc/productquantization.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# QuantizeTransform
+
+Approximate floats as uchar.
+
+* **file:** imgproc/quantize.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RankTransform
+
+Converts each element to its rank-ordered value.
+
+* **file:** imgproc/rank.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RectRegionsTransform
+
+Subdivide matrix into rectangular subregions.
+
+* **file:** imgproc/rectregions.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RecursiveIntegralSamplerTransform
+
+Construct template in a recursive decent manner.
+
+* **file:** imgproc/recursiveintegralsampler.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RedLinearRegressionTransform
+
+Prediction using only the red wavelength; magic numbers from jmp
+
+* **file:** imgproc/redlinearregression.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** E. Taborsky
+* **properties:** None
+
+---
+
+# ReshapeTransform
+
+Reshape the each matrix to the specified number of rows.
+
+* **file:** imgproc/reshape.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ResizeTransform
+
+Resize the template
+
+* **file:** imgproc/resize.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RevertAffineTransform
+
+Designed for use after eye detection + Stasm, this will
+
+* **file:** imgproc/revertaffine.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# RGTransform
+
+Normalized RG color space.
+
+* **file:** imgproc/rg.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RndPointTransform
+
+Generates a random landmark.
+
+* **file:** imgproc/rndpoint.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RndRegionTransform
+
+Selects a random region.
+
+* **file:** imgproc/rndregion.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RndRotateTransform
+
+Randomly rotates an image in a specified range.
+
+* **file:** imgproc/rndrotate.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# RndSubspaceTransform
+
+Generates a random subspace.
+
+* **file:** imgproc/rndsubspace.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ROITransform
+
+Crops the rectangular regions of interest.
+
+* **file:** imgproc/roi.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ROIFromPtsTransform
+
+Crops the rectangular regions of interest from given points and sizes.
+
+* **file:** imgproc/roifrompoints.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# RootNormTransform
+
+dst=sqrt(norm_L1(src)) proposed as RootSIFT in
+
+* **file:** imgproc/rootnorm.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RowWiseMeanCenterTransform
+
+Remove the row-wise training set average.
+
+* **file:** imgproc/rowwisemeancenter.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SampleFromMaskTransform
+
+Samples pixels from a mask.
+
+* **file:** imgproc/samplefrommask.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# ScaleTransform
+
+Scales using the given factor
+
+* **file:** imgproc/scale.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# SIFTDescriptorTransform
+
+Specialize wrapper OpenCV SIFT wrapper
+
+* **file:** imgproc/sift.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SkinMaskTransform
+
+http://worldofcameras.wordpress.com/tag/skin-detection-opencv/
+
+* **file:** imgproc/skinmask.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SlidingWindowTransform
+
+Applies a transform to a sliding window.
+
+* **file:** imgproc/slidingwindow.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# IntegralSlidingWindowTransform
+
+Overloads SlidingWindowTransform for integral images that should be
+
+* **file:** imgproc/slidingwindow.cpp
+* **inherits:** [SlidingWindowTransform](../cpp_api.md#slidingwindowtransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SplitChannelsTransform
+
+Split a multi-channel matrix into several single-channel matrices.
+
+* **file:** imgproc/splitchannels.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SubdivideTransform
+
+Divide the matrix into 4 smaller matricies of equal size.
+
+* **file:** imgproc/subdivide.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SubtractTransform
+
+Subtract two matrices.
+
+* **file:** imgproc/subtract.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ThresholdTransform
+
+Wraps OpenCV's adaptive thresholding.
+
+* **file:** imgproc/threshold.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# WatershedSegmentationTransform
+
+Applies watershed segmentation.
+
+* **file:** imgproc/watershedsegmentation.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# DecodeTransform
+
+Decodes images
+
+* **file:** io/decode.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DownloadTransform
+
+Downloads an image from a URL
+
+* **file:** io/download.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# IncrementalOutputTransform
+
+Incrementally output templates received to a gallery, based on the current filename
+
+* **file:** io/incrementaloutput.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api.md#timevaryingtransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# OpenTransform
+
+Applies br::Format to br::Template::file::name and appends results.
+
+* **file:** io/open.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# PrintTransform
+
+Prints the template's file to stdout or stderr.
+
+* **file:** io/print.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ReadTransform
+
+Read images
+
+* **file:** io/read.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ReadLandmarksTransform
+
+Read landmarks from a file and associate them with the correct templates.
+
+* **file:** io/readlandmarks.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# WriteTransform
+
+Write all mats to disk as images.
+
+* **file:** io/write.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api.md#timevaryingtransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# YouTubeFacesDBTransform
+
+Implements the YouTubesFaceDB
+
+* **file:** io/youtubefacesdb.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# AnonymizeLandmarksTransform
+
+Remove a name from a point/rect
+
+* **file:** metadata/anonymizelandmarks.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# AsTransform
+
+Change the br::Template::file extension
+
+* **file:** metadata/as.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# AveragePointsTransform
+
+Averages a set of landmarks into a new landmark
+
+* **file:** metadata/averagepoints.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# CascadeTransform
+
+Wraps OpenCV cascade classifier
+
+* **file:** metadata/cascade.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **authors:** Josh Klontz, David Crouse
+* **properties:** None
+
+---
+
+# CheckTransform
+
+Checks the template for NaN values.
+
+* **file:** metadata/check.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ClearPointsTransform
+
+Clears the points from a template
+
+* **file:** metadata/clearpoints.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# ConsolidateDetectionsTransform
+
+Consolidate redundant/overlapping detections.
+
+* **file:** metadata/consolidatedetections.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# CropRectTransform
+
+Crops the width and height of a template's rects by input width and height factors.
+
+* **file:** metadata/croprect.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# DelaunayTransform
+
+Creates a Delaunay triangulation based on a set of points
+
+* **file:** metadata/delaunay.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# ExpandRectTransform
+
+Expand the width and height of a template's rects by input width and height factors.
+
+* **file:** metadata/expandrect.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# ExtractMetadataTransform
+
+Create matrix from metadata values.
+
+* **file:** metadata/extractmetadata.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ASEFEyesTransform
+
+Bolme, D.S.; Draper, B.A.; Beveridge, J.R.;
+
+* **file:** metadata/eyes.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **authors:** David Bolme, Josh Klontz
+* **properties:** None
+
+---
+
+# FilterDupeMetadataTransform
+
+Removes duplicate templates based on a unique metadata key
+
+* **file:** metadata/filterdupemetadata.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api.md#timevaryingtransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# GridTransform
+
+Add landmarks to the template in a grid layout
+
+* **file:** metadata/grid.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# GroundTruthTransform
+
+Add any ground truth to the template using the file's base name.
+
+* **file:** metadata/groundtruth.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# HOGPersonDetectorTransform
+
+Detects objects with OpenCV's built-in HOG detection.
+
+* **file:** metadata/hogpersondetector.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# IfMetadataTransform
+
+Clear templates without the required metadata.
+
+* **file:** metadata/ifmetadata.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ImpostorUniquenessMeasureTransform
+
+Impostor Uniqueness Measure
+
+* **file:** metadata/imposteruniquenessmeasure.cpp
+* **inherits:** [Transform](../cpp_api.md#transform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# JSONTransform
+
+Represent the metadata as JSON template data.
+
+* **file:** metadata/json.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# KeepMetadataTransform
+
+Retains only the values for the keys listed, to reduce template size
+
+* **file:** metadata/keepmetadata.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# KeyPointDetectorTransform
+
+Wraps OpenCV Key Point Detector
+
+* **file:** metadata/keypointdetector.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# KeyToRectTransform
+
+Convert values of key_X, key_Y, key_Width, key_Height to a rect.
+
+* **file:** metadata/keytorect.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Jordan Cheney
+* **properties:** None
+
+---
+
+# MongooseInitializer
+
+Initialize mongoose server
+
+* **file:** metadata/mongoose.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Unknown
+* **properties:** None
+
+---
+
+# NameTransform
+
+Sets the template's matrix data to the br::File::name.
+
+* **file:** metadata/name.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# NameLandmarksTransform
+
+Name a point/rect
+
+* **file:** metadata/namelandmarks.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# NormalizePointsTransform
+
+Normalize points to be relative to a single point
+
+* **file:** metadata/normalizepoints.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# PointDisplacementTransform
+
+Normalize points to be relative to a single point
+
+* **file:** metadata/pointdisplacement.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# PointsToMatrixTransform
+
+Converts either the file::points() list or a QList<QPointF> metadata item to be the template's matrix
+
+* **file:** metadata/pointstomatrix.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# ProcrustesTransform
+
+Procrustes alignment of points
+
+* **file:** metadata/procrustes.cpp
+* **inherits:** [MetadataTransform](../cpp_api.md#metadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# RectsToTemplatesTransform
+
+For each rectangle bounding box in src, a new
+
+* **file:** metadata/rectstotemplates.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# RegexPropertyTransform
+
+Apply the input regular expression to the value of inputProperty, store the matched portion in outputProperty.
+
+* **file:** metadata/regexproperty.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# RemoveMetadataTransform
+
+Removes a metadata field from all templates
+
+* **file:** metadata/removemetadata.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# RemoveTemplatesTransform
+
+Remove templates with the specified file extension or metadata value.
+
+* **file:** metadata/removetemplates.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RenameTransform
+
+Rename metadata key
+
+* **file:** metadata/rename.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# RenameFirstTransform
+
+Rename first found metadata key
+
+* **file:** metadata/renamefirst.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# ReorderPointsTransform
+
+Reorder the points such that points[from[i]] becomes points[to[i]] and
+
+* **file:** metadata/reorderpoints.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# RestoreMatTransform
+
+Set the last matrix of the input template to a matrix stored as metadata with input propName.
+
+* **file:** metadata/restoremat.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# SaveMatTransform
+
+Store the last matrix of the input template as a metadata key with input property name.
+
+* **file:** metadata/savemat.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# SelectPointsTransform
+
+Retains only landmarks/points at the provided indices
+
+* **file:** metadata/selectpoints.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Brendan Klare
+* **properties:** None
+
+---
+
+# SetMetadataTransform
+
+Sets the metadata key/value pair.
+
+* **file:** metadata/setmetadata.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# SetPointsInRectTransform
+
+Set points relative to a rect
+
+* **file:** metadata/setpointsinrect.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api.md#untrainablemetadatatransform)
+* **author:** Jordan Cheney
+* **properties:** None
+
+---
+
+# StasmInitializer
+
+Initialize Stasm
+
+* **file:** metadata/stasm4.cpp
+* **inherits:** [Initializer](../cpp_api.md#initializer)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# StasmTransform
+
+Wraps STASM key point detector
+
+* **file:** metadata/stasm4.cpp
+* **inherits:** [UntrainableTransform](../cpp_api.md#untrainabletransform)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# StopWatchTransform
+
+Gives time elapsed over a specified transform as a function of both images (or frames) and pixels.
+
+* **file:** metadata/stopwatch.cpp
+* **inherits:** [MetaTransform](../cpp_api.md#metatransform)
+* **authors:** Jordan Cheney, Josh Klontz
+* **properties:** None
+
+---
+
+# bestOutput
+
+The highest scoring matches.
+
+* **file:** output/best.cpp
+* **inherits:** [Output](../cpp_api.md#output)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# csvOutput
+
+Comma separated values output.
+
+* **file:** output/csv.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DefaultOutput
+
+Adaptor class -- write a matrix output using Format classes.
+
+* **file:** output/default.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **author:** Charles Otto
+* **properties:** None
+
+---
+
+# EmptyOutput
+
+Output to the terminal.
+
+* **file:** output/empty.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# evalOutput
+
+Evaluate the output matrix.
+
+* **file:** output/eval.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# heatOutput
+
+Matrix-like output for heat maps.
+
+* **file:** output/heat.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# histOutput
+
+Score histogram.
+
+* **file:** output/hist.cpp
+* **inherits:** [Output](../cpp_api.md#output)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# meltOutput
+
+One score per row.
+
+* **file:** output/melt.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# mtxOutput
+
+
+
+* **file:** output/mtx.cpp
+* **inherits:** [Output](../cpp_api.md#output)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# nullOutput
+
+Discards the scores.
+
+* **file:** output/null.cpp
+* **inherits:** [Output](../cpp_api.md#output)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# rankOutput
+
+Outputs highest ranked matches with scores.
+
+* **file:** output/rank.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **author:** Scott Klum
+* **properties:** None
+
+---
+
+# rrOutput
+
+Rank retrieval output.
+
+* **file:** output/rr.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **authors:** Josh Klontz, Scott Klum
+* **properties:** None
+
+---
+
+# tailOutput
+
+The highest scoring matches.
+
+* **file:** output/tail.cpp
+* **inherits:** [Output](../cpp_api.md#output)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# txtOutput
+
+Text file output.
+
+* **file:** output/txt.cpp
+* **inherits:** [MatrixOutput](../cpp_api.md#matrixoutput)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# AggregateFrames
+
+Passes along n sequential frames to the next transform.
+
+* **file:** video/aggregate.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api.md#timevaryingtransform)
+* **author:** Josh Klontz
+* **properties:** None
+
+---
+
+# DropFrames
+
+Only use one frame every n frames.
+
+* **file:** video/drop.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Austin Blanton
+* **properties:** None
+
+---
+
+# OpticalFlowTransform
+
+Gets a one-channel dense optical flow from two images
+
+* **file:** video/opticalflow.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api.md#untrainablemetatransform)
+* **author:** Austin Blanton
+* **properties:** None
+
-# Build Instructions
-
 A hacker's guide to building, editing, and running OpenBR.
 ---
-## Linux
+# Linux
 1. Install GCC 4.7.3
@@ -83,7 +81,7 @@ A hacker&#39;s guide to building, editing, and running OpenBR.
 ---
-## OSX
+# OSX
 1. Download and install the latest "Xcode" and "Command Line Tools" from the <a href="https://developer.apple.com/downloads/index.action#">Apple Developer Downloads</a> page.
     1. <a href="http://www.cmake.org/files/v2.8/cmake-2.8.11.2.tar.gz">Download CMake 2.8.11.2</a>
@@ -175,7 +173,7 @@ A hacker&#39;s guide to building, editing, and running OpenBR.
 ---
-## Windows
+# Windows
 1. <a href="http://www.microsoft.com/en-us/download/details.aspx?id=34673">Download Visual Studio 2012 Express Edition for Windows Desktop</a> and install.
     1. Consider the free open source program <a href="http://wincdemu.sysprogs.org">WinCDEmu</a> if you need a program to mount ISO images.
@@ -246,7 +244,7 @@ A hacker&#39;s guide to building, editing, and running OpenBR.
 ---
-## Raspian
+# Raspian
 1. Install CMake 2.8.9
-# Plugins
-
-A description of all of the plugins available in OpenBR, broken down by module. This section assumes knowledge of the [C++ Plugin API](technical.md#c++ plugin api) and the [plugin abstractions](abstractions.md).
-
-## Classification
-
----
-
-#### AdaBoostTransform
-
-Wraps OpenCV's Ada Boost framework
-
-* **file:** classification/adaboost.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### EBIFTransform
-
-Face Recognition Using Early Biologically Inspired Features
-
-* **file:** classification/ebif.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ForestTransform
-
-Wraps OpenCV's random trees framework
-
-* **file:** classification/forest.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### ForestInductionTransform
-
-Wraps OpenCV's random trees framework to induce features
-
-* **file:** classification/forest.cpp
-* **inherits:** [ForestTransform](abstractions.md#foresttransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### IPC2013Initializer
-
-Initializes Intel Perceptual Computing SDK 2013
-
-* **file:** classification/ipc2013.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### IPC2013FaceRecognitionTransfrom
-
-Intel Perceptual Computing SDK 2013 Face Recognition
-
-* **file:** classification/ipc2013.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### EigenInitializer
-
-Initialize Eigen
-
-* **file:** classification/lda.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### PCATransform
-
-Projects input into learned Principal Component Analysis subspace.
-
-* **file:** classification/lda.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **authors:** Brendan Klare, Josh Klontz
-* **properties:** None
-
----
-
-#### RowWisePCATransform
-
-PCA on each row.
-
-* **file:** classification/lda.cpp
-* **inherits:** [PCATransform](abstractions.md#pcatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DFFSTransform
-
-Computes Distance From Feature Space (DFFS)
-
-* **file:** classification/lda.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### LDATransform
-
-Projects input into learned Linear Discriminant Analysis subspace.
-
-* **file:** classification/lda.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **authors:** Brendan Klare, Josh Klontz
-* **properties:** None
-
----
-
-#### SparseLDATransform
-
-Projects input into learned Linear Discriminant Analysis subspace
-
-* **file:** classification/lda.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### MLPTransform
-
-Wraps OpenCV's multi-layer perceptron framework
-
-* **file:** classification/mlp.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### NT4Initializer
-
-Initialize Neurotech SDK 4
-
-* **file:** classification/nt4.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **authors:** Josh Klontz, E. Taborsky
-* **properties:** None
-
----
-
-#### NT4DetectFace
-
-Neurotech face detection
-
-* **file:** classification/nt4.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **authors:** Josh Klontz, E. Taborsky
-* **properties:** None
-
----
-
-#### NT4EnrollFace
-
-Enroll face in Neurotech SDK 4
-
-* **file:** classification/nt4.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### NT4EnrollIris
-
-Enroll iris in Neurotech SDK 4
-
-* **file:** classification/nt4.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** E. Taborsky
-* **properties:** None
-
----
-
-#### NT4Compare
-
-Compare templates with Neurotech SDK 4
-
-* **file:** classification/nt4.cpp
-* **inherits:** [Distance](abstractions.md#distance)
-* **authors:** Josh Klontz, E. Taborsky
-* **properties:** None
-
----
-
-#### PP4Initializer
-
-Initialize PittPatt 4
-
-* **file:** classification/pp4.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### PP4EnrollTransform
-
-Enroll faces in PittPatt 4
-
-* **file:** classification/pp4.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### PP5Initializer
-
-Initialize PP5
-
-* **file:** classification/pp5.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **authors:** Josh Klontz, E. Taborsky
-* **properties:** None
-
----
-
-#### PP5EnrollTransform
-
-Enroll faces in PP5
-
-* **file:** classification/pp5.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **authors:** Josh Klontz, E. Taborsky
-* **properties:** None
-
----
-
-#### PP5CompareDistance
-
-Compare templates with PP5
-
-* **file:** classification/pp5.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **authors:** Josh Klontz, E. Taborsky
-* **properties:** None
-
----
-
-#### SVMTransform
-
-C. Burges. "A tutorial on support vector machines for pattern recognition,"
-
-* **file:** classification/svm.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SVMDistance
-
-SVM Regression on template absolute differences.
-
-* **file:** classification/svm.cpp
-* **inherits:** [Distance](abstractions.md#distance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### TurkClassifierTransform
-
-Convenience class for training turk attribute regressors
-
-* **file:** classification/turk.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
-## Cluster
-
----
-
-#### CollectNNTransform
-
-Collect nearest neighbors and append them to metadata.
-
-* **file:** cluster/collectnn.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### KMeansTransform
-
-Wraps OpenCV kmeans and flann.
-
-* **file:** cluster/kmeans.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### KNNTransform
-
-K nearest neighbors classifier.
-
-* **file:** cluster/knn.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### LogNNTransform
-
-Log nearest neighbors to specified file.
-
-* **file:** cluster/lognn.cpp
-* **inherits:** [TimeVaryingTransform](abstractions.md#timevaryingtransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### RandomCentroidsTransform
-
-Chooses k random points to be centroids.
-
-* **file:** cluster/randomcentroids.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Austin Blanton
-* **properties:** None
-
-## Core
-
----
-
-#### AlgorithmsInitializer
-
-Initializes global abbreviations with implemented algorithms
-
-* **file:** core/algorithms.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ProcrustesAlignTransform
-
-Improved procrustes alignment of points, to include a post processing scaling of points
-
-* **file:** core/align.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### TextureMapTransform
-
-Maps texture from one set of points to another. Assumes that points are rigidly transformed
-
-* **file:** core/align.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **authors:** Brendan Klare, Scott Klum
-* **properties:** None
-
----
-
-#### SynthesizePointsTransform
-
-Synthesize additional points via triangulation.
-
-* **file:** core/align.cpp
-* **inherits:** [MetadataTransform](abstractions.md#metadatatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ProcrustesInitializer
-
-Initialize Procrustes croppings
-
-* **file:** core/align.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### AttributeAlgorithmsInitializer
-
-Initializes global abbreviations with implemented algorithms for attributes
-
-* **file:** core/attributealgorithms.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Babatunde Ogunfemi
-* **properties:** None
-
----
-
-#### CacheTransform
-
-Caches br::Transform::project() results.
-
-* **file:** core/cache.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ContractTransform
-
-It's like the opposite of ExpandTransform, but not really
-
-* **file:** core/contract.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### CrossValidateTransform
-
-Cross validate a trainable transform.
-
-* **file:** core/crossvalidate.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **authors:** Josh Klontz, Scott Klum
-* **properties:** None
-
----
-
-#### DiscardTransform
-
-Removes all template's matrices.
-
-* **file:** core/discard.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ExpandTransform
-
-Performs an expansion step on input templatelists
-
-* **file:** core/expand.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### FirstTransform
-
-Removes all but the first matrix from the template.
-
-* **file:** core/first.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ForkTransform
-
-Transforms in parallel.
-
-* **file:** core/fork.cpp
-* **inherits:** [CompositeTransform](abstractions.md#compositetransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### FTETransform
-
-Flags images that failed to enroll based on the specified transform.
-
-* **file:** core/fte.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### GalleryCompareTransform
-
-Compare each template to a fixed gallery (with name = galleryName), using the specified distance.
-
-* **file:** core/gallerycompare.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### IdentityTransform
-
-A no-op transform.
-
-* **file:** core/identity.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### IndependentTransform
-
-Clones the transform so that it can be applied independently.
-
-* **file:** core/independent.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### JNIInitializer
-
-Initialize JNI
-
-* **file:** core/jni.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Jordan Cheney
-* **properties:** None
-
----
-
-#### LikelyTransform
-
-Generic interface to Likely JIT compiler
-
-* **file:** core/likely.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### LoadStoreTransform
-
-Caches transform training.
-
-* **file:** core/loadstore.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### PipeTransform
-
-Transforms in series.
-
-* **file:** core/pipe.cpp
-* **inherits:** [CompositeTransform](abstractions.md#compositetransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ProcessWrapperTransform
-
-Interface to a separate process
-
-* **file:** core/processwrapper.cpp
-* **inherits:** [WrapperTransform](abstractions.md#wrappertransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### Registrar
-
-Register custom objects with Qt meta object system.
-
-* **file:** core/registrar.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### RestTransform
-
-Removes the first matrix from the template.
-
-* **file:** core/rest.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SchrodingerTransform
-
-Generates two templates, one of which is passed through a transform and the other
-
-* **file:** core/schrodinger.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### SingletonTransform
-
-A globally shared transform.
-
-* **file:** core/singleton.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
-## Distance
-
----
-
-#### AttributeDistance
-
-Attenuation function based distance from attributes
-
-* **file:** distance/attribute.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### BayesianQuantizationDistance
-
-Bayesian quantization distance
-
-* **file:** distance/bayesianquantization.cpp
-* **inherits:** [Distance](abstractions.md#distance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ByteL1Distance
-
-Fast 8-bit L1 distance
-
-* **file:** distance/byteL1.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CrossValidateDistance
-
-Cross validate a distance metric.
-
-* **file:** distance/crossvalidate.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DefaultDistance
-
-DistDistance wrapper.
-
-* **file:** distance/default.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DistDistance
-
-Standard distance metrics
-
-* **file:** distance/dist.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### FilterDistance
-
-Checks target metadata against filters.
-
-* **file:** distance/filter.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### FuseDistance
-
-Fuses similarity scores across multiple matrices of compared templates
-
-* **file:** distance/fuse.cpp
-* **inherits:** [Distance](abstractions.md#distance)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### HalfByteL1Distance
-
-Fast 4-bit L1 distance
-
-* **file:** distance/halfbyteL1.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### HeatMapDistance
-
-1v1 heat map comparison
-
-* **file:** distance/heatmap.cpp
-* **inherits:** [Distance](abstractions.md#distance)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### IdenticalDistance
-
-Returns
-
-* **file:** distance/identical.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### KeyPointMatcherDistance
-
-Wraps OpenCV Key Point Matcher
-
-* **file:** distance/keypointmatcher.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### L1Distance
-
-L1 distance computed using eigen.
-
-* **file:** distance/L1.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### L2Distance
-
-L2 distance computed using eigen.
-
-* **file:** distance/L2.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### MatchProbabilityDistance
-
-Match Probability
-
-* **file:** distance/matchprobability.cpp
-* **inherits:** [Distance](abstractions.md#distance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### MetadataDistance
-
-Checks target metadata against query metadata.
-
-* **file:** distance/metadata.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### NegativeLogPlusOneDistance
-
-Returns -log(distance(a,b)+1)
-
-* **file:** distance/neglogplusone.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### OnlineDistance
-
-Online distance metric to attenuate match scores across multiple frames
-
-* **file:** distance/online.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Brendan klare
-* **properties:** None
-
----
-
-#### PipeDistance
-
-Distances in series.
-
-* **file:** distance/pipe.cpp
-* **inherits:** [Distance](abstractions.md#distance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RejectDistance
-
-Sets distance to -FLOAT_MAX if a target template has/doesn't have a key.
-
-* **file:** distance/reject.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### SumDistance
-
-Sum match scores across multiple distances
-
-* **file:** distance/sum.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### TurkDistance
-
-Unmaps Turk HITs to be compared against query mats
-
-* **file:** distance/turk.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### UnitDistance
-
-Linear normalizes of a distance so the mean impostor score is 0 and the mean genuine score is 1.
-
-* **file:** distance/unit.cpp
-* **inherits:** [Distance](abstractions.md#distance)
-* **author:** Josh Klontz
-* **properties:** None
-
-## Format
-
----
-
-#### binaryFormat
-
-A simple binary matrix format.
-
-* **file:** format/binary.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### csvFormat
-
-Reads a comma separated value file.
-
-* **file:** format/csv.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ebtsFormat
-
-Reads FBI EBTS transactions.
-
-* **file:** format/ebts.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### lffsFormat
-
-Reads a NIST LFFS file.
-
-* **file:** format/lffs.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### lmatFormat
-
-Likely matrix format
-
-* **file:** format/lmat.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### matFormat
-
-MATLAB <tt>.mat</tt> format.
-
-* **file:** format/mat.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### mtxFormat
-
-Reads a NIST BEE similarity matrix.
-
-* **file:** format/mtx.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### maskFormat
-
-Reads a NIST BEE mask matrix.
-
-* **file:** format/mtx.cpp
-* **inherits:** [mtxFormat](abstractions.md#mtxformat)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### nullFormat
-
-Returns an empty matrix.
-
-* **file:** format/null.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### postFormat
-
-Handle POST requests
-
-* **file:** format/post.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### rawFormat
-
-RAW format
-
-* **file:** format/raw.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### scoresFormat
-
-Reads in scores or ground truth from a text table.
-
-* **file:** format/scores.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### urlFormat
-
-Reads image files from the web.
-
-* **file:** format/url.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### videoFormat
-
-Read all frames of a video using OpenCV
-
-* **file:** format/video.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### webcamFormat
-
-Retrieves an image from a webcam.
-
-* **file:** format/video.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DefaultFormat
-
-Reads image files.
-
-* **file:** format/video.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### xmlFormat
-
-Decodes images from Base64 xml
-
-* **file:** format/xml.cpp
-* **inherits:** [Format](abstractions.md#format)
-* **authors:** Scott Klum, Josh Klontz
-* **properties:** None
-
-## Gallery
-
----
-
-#### arffGallery
-
-Weka ARFF file format.
-
-* **file:** gallery/arff.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### galGallery
-
-A binary gallery.
-
-* **file:** gallery/binary.cpp
-* **inherits:** [BinaryGallery](abstractions.md#binarygallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### utGallery
-
-A contiguous array of br_universal_template.
-
-* **file:** gallery/binary.cpp
-* **inherits:** [BinaryGallery](abstractions.md#binarygallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### urlGallery
-
-Newline-separated URLs.
-
-* **file:** gallery/binary.cpp
-* **inherits:** [BinaryGallery](abstractions.md#binarygallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### jsonGallery
-
-Newline-separated JSON objects.
-
-* **file:** gallery/binary.cpp
-* **inherits:** [BinaryGallery](abstractions.md#binarygallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### crawlGallery
-
-Crawl a root location for image files.
-
-* **file:** gallery/crawl.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### csvGallery
-
-Treats each line as a file.
-
-* **file:** gallery/csv.cpp
-* **inherits:** [FileGallery](abstractions.md#filegallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### dbGallery
-
-Database input.
-
-* **file:** gallery/db.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DefaultGallery
-
-Treats the gallery as a br::Format.
-
-* **file:** gallery/default.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### EmptyGallery
-
-Reads/writes templates to/from folders.
-
-* **file:** gallery/empty.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### FDDBGallery
-
-Implements the FDDB detection format.
-
-* **file:** gallery/fddb.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### flatGallery
-
-Treats each line as a call to File::flat()
-
-* **file:** gallery/flat.cpp
-* **inherits:** [FileGallery](abstractions.md#filegallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### googleGallery
-
-Input from a google image search.
-
-* **file:** gallery/google.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### keyframesGallery
-
-Read key frames of a video with LibAV
-
-* **file:** gallery/keyframes.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Ben Klein
-* **properties:** None
-
----
-
-#### mp4Gallery
-
-Read key frames of a .mp4 video file with LibAV
-
-* **file:** gallery/keyframes.cpp
-* **inherits:** [keyframesGallery](abstractions.md#keyframesgallery)
-* **author:** Ben Klein
-* **properties:** None
-
----
-
-#### landmarksGallery
-
-Text format for associating anonymous landmarks with images.
-
-* **file:** gallery/landmarks.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### lmatGallery
-
-Likely matrix format
-
-* **file:** gallery/lmat.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### matrixGallery
-
-Combine all templates into one large matrix and process it as a br::Format
-
-* **file:** gallery/matrix.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### MemoryGalleries
-
-Initialization support for memGallery.
-
-* **file:** gallery/mem.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### memGallery
-
-A gallery held in memory.
-
-* **file:** gallery/mem.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### postGallery
-
-Handle POST requests
-
-* **file:** gallery/post.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### statGallery
-
-Print template statistics.
-
-* **file:** gallery/stat.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### templateGallery
-
-Treat the file as a single binary template.
-
-* **file:** gallery/template.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### turkGallery
-
-For Amazon Mechanical Turk datasets
-
-* **file:** gallery/turk.cpp
-* **inherits:** [Gallery](abstractions.md#gallery)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### txtGallery
-
-Treats each line as a file.
-
-* **file:** gallery/txt.cpp
-* **inherits:** [FileGallery](abstractions.md#filegallery)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### xmlGallery
-
-A
-
-* **file:** gallery/xml.cpp
-* **inherits:** [FileGallery](abstractions.md#filegallery)
-* **author:** Josh Klontz
-* **properties:** None
-
-## Gui
-
----
-
-#### AdjacentOverlayTransform
-
-Load the image named in the specified property, draw it on the current matrix adjacent to the rect specified in the other property.
-
-* **file:** gui/adjacentoverlay.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### DrawTransform
-
-Renders metadata onto the image.
-
-* **file:** gui/draw.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DrawDelaunayTransform
-
-Creates a Delaunay triangulation based on a set of points
-
-* **file:** gui/drawdelaunay.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### DrawGridLinesTransform
-
-Draws a grid on the image
-
-* **file:** gui/drawgridlines.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DrawOpticalFlow
-
-Draw a line representing the direction and magnitude of optical flow at the specified points.
-
-* **file:** gui/drawopticalflow.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### DrawPropertiesPointTransform
-
-Draw the values of a list of properties at the specified point on the image
-
-* **file:** gui/drawpropertiespoint.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### DrawPropertyPointTransform
-
-Draw the value of the specified property at the specified point on the image
-
-* **file:** gui/drawpropertypoint.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### DrawSegmentation
-
-Fill in the segmentations or draw a line between intersecting segments.
-
-* **file:** gui/drawsegmentation.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### ShowTransform
-
-Displays templates in a GUI pop-up window using QT.
-
-* **file:** gui/show.cpp
-* **inherits:** [TimeVaryingTransform](abstractions.md#timevaryingtransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### ShowTrainingTransform
-
-Show the training data
-
-* **file:** gui/show.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ManualTransform
-
-Manual selection of landmark locations
-
-* **file:** gui/show.cpp
-* **inherits:** [ShowTransform](abstractions.md#showtransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### ManualRectsTransform
-
-Manual select rectangular regions on an image.
-
-* **file:** gui/show.cpp
-* **inherits:** [ShowTransform](abstractions.md#showtransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### ElicitTransform
-
-Elicits metadata for templates in a pretty GUI
-
-* **file:** gui/show.cpp
-* **inherits:** [ShowTransform](abstractions.md#showtransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### SurveyTransform
-
-Display an image, and asks a yes/no question about it
-
-* **file:** gui/show.cpp
-* **inherits:** [ShowTransform](abstractions.md#showtransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### FPSLimit
-
-Limits the frequency of projects going through this transform to the input targetFPS
-
-* **file:** gui/show.cpp
-* **inherits:** [TimeVaryingTransform](abstractions.md#timevaryingtransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### FPSCalc
-
-Calculates the average FPS of projects going through this transform, stores the result in AvgFPS
-
-* **file:** gui/show.cpp
-* **inherits:** [TimeVaryingTransform](abstractions.md#timevaryingtransform)
-* **author:** Charles Otto
-* **properties:** None
-
-## Imgproc
-
----
-
-#### AbsTransform
-
-Computes the absolute value of each element.
-
-* **file:** imgproc/abs.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### AbsDiffTransform
-
-Take the absolute difference of two matrices.
-
-* **file:** imgproc/absdiff.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### AdaptiveThresholdTransform
-
-Wraps OpenCV's adaptive thresholding.
-
-* **file:** imgproc/adaptivethreshold.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### AffineTransform
-
-Performs a two or three point registration.
-
-* **file:** imgproc/affine.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### AndTransform
-
-Logical AND of two matrices.
-
-* **file:** imgproc/and.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ApplyMaskTransform
-
-Applies a mask from the metadata.
-
-* **file:** imgproc/applymask.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### BayesianQuantizationTransform
-
-Quantize into a space where L1 distance approximates log-likelihood.
-
-* **file:** imgproc/bayesianquantization.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### BinarizeTransform
-
-Approximate floats as signed bit.
-
-* **file:** imgproc/binarize.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### BlendTransform
-
-Alpha-blend two matrices
-
-* **file:** imgproc/blend.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### BlurTransform
-
-Gaussian blur
-
-* **file:** imgproc/blur.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ByRowTransform
-
-Turns each row into its own matrix.
-
-* **file:** imgproc/byrow.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CannyTransform
-
-Warpper to OpenCV Canny edge detector
-
-* **file:** imgproc/canny.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### CatTransform
-
-Concatenates all input matrices into a single matrix.
-
-* **file:** imgproc/cat.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CatColsTransform
-
-Concatenates all input matrices by column into a single matrix.
-
-* **file:** imgproc/catcols.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### CatRowsTransform
-
-Concatenates all input matrices by row into a single matrix.
-
-* **file:** imgproc/catrows.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CenterTransform
-
-Normalize each dimension based on training data.
-
-* **file:** imgproc/center.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ContrastEqTransform
-
-Xiaoyang Tan; Triggs, B.;
-
-* **file:** imgproc/contrasteq.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CropTransform
-
-Crops about the specified region of interest.
-
-* **file:** imgproc/crop.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CropBlackTransform
-
-Crop out black borders
-
-* **file:** imgproc/cropblack.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CropFromMaskTransform
-
-Crops image based on mask metadata
-
-* **file:** imgproc/cropfrommask.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### CropSquareTransform
-
-Trim the image so the width and the height are the same size.
-
-* **file:** imgproc/cropsquare.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CryptographicHashTransform
-
-Wraps QCryptographicHash
-
-* **file:** imgproc/cryptographichash.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CvtTransform
-
-Colorspace conversion.
-
-* **file:** imgproc/cvt.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CvtFloatTransform
-
-Convert to floating point format.
-
-* **file:** imgproc/cvtfloat.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### CvtUCharTransform
-
-Convert to uchar format
-
-* **file:** imgproc/cvtuchar.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### NLMeansDenoisingTransform
-
-Wraps OpenCV Non-Local Means Denoising
-
-* **file:** imgproc/denoising.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DiscardAlphaTransform
-
-Drop the alpha channel (if exists).
-
-* **file:** imgproc/discardalpha.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### DivTransform
-
-Enforce a multiple of
-
-* **file:** imgproc/div.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DoGTransform
-
-Difference of gaussians
-
-* **file:** imgproc/dog.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DownsampleTransform
-
-Downsample the rows and columns of a matrix.
-
-* **file:** imgproc/downsample.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Lacey Best-Rowden
-* **properties:** None
-
----
-
-#### DupTransform
-
-Duplicates the template data.
-
-* **file:** imgproc/dup.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### EnsureChannelsTransform
-
-Enforce the matrix has a certain number of channels by adding or removing channels.
-
-* **file:** imgproc/ensurechannels.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### EqualizeHistTransform
-
-Histogram equalization
-
-* **file:** imgproc/equalizehist.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### FlipTransform
-
-Flips the image about an axis.
-
-* **file:** imgproc/flip.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### FloodTransform
-
-Fill black pixels with the specified color.
-
-* **file:** imgproc/flood.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### GaborTransform
-
-http://en.wikipedia.org/wiki/Gabor_filter
-
-* **file:** imgproc/gabor.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### GaborJetTransform
-
-A vector of gabor wavelets applied at a point.
-
-* **file:** imgproc/gabor.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### GammaTransform
-
-Gamma correction
-
-* **file:** imgproc/gamma.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### GradientTransform
-
-Computes magnitude and/or angle of image.
-
-* **file:** imgproc/gradient.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### GradientMaskTransform
-
-Masks image according to pixel change.
-
-* **file:** imgproc/gradientmask.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### GroupTransform
-
-Group all input matrices into a single matrix.
-
-* **file:** imgproc/group.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### HistTransform
-
-Histograms the matrix
-
-* **file:** imgproc/hist.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### HistBinTransform
-
-Quantizes the values into bins.
-
-* **file:** imgproc/histbin.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### HistEqQuantizationTransform
-
-Approximate floats as uchar with different scalings for each dimension.
-
-* **file:** imgproc/histeqquantization.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### HoGDescriptorTransform
-
-OpenCV HOGDescriptor wrapper
-
-* **file:** imgproc/hog.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### InpaintTransform
-
-Wraps OpenCV inpainting
-
-* **file:** imgproc/inpaint.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### IntegralTransform
-
-Computes integral image.
-
-* **file:** imgproc/integral.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### IntegralHistTransform
-
-An integral histogram
-
-* **file:** imgproc/integralhist.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### IntegralSamplerTransform
-
-Sliding window feature extraction from a multi-channel integral image.
-
-* **file:** imgproc/integralsampler.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### KernelHashTransform
-
-Kernel hash
-
-* **file:** imgproc/kernelhash.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### KeyPointDescriptorTransform
-
-Wraps OpenCV Key Point Descriptor
-
-* **file:** imgproc/keypointdescriptor.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### LargestConvexAreaTransform
-
-Set the template's label to the area of the largest convex hull.
-
-* **file:** imgproc/largestconvexarea.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### LBPTransform
-
-Ahonen, T.; Hadid, A.; Pietikainen, M.;
-
-* **file:** imgproc/lbp.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### LimitSizeTransform
-
-Limit the size of the template
-
-* **file:** imgproc/limitsize.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### LTPTransform
-
-Tan, Xiaoyang, and Bill Triggs. "Enhanced local texture feature sets for face recognition under difficult lighting conditions." Analysis and Modeling of Faces and Gestures. Springer Berlin Heidelberg, 2007. 168-182.
-
-* **file:** imgproc/ltp.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **authors:** Brendan Klare, Josh Klontz
-* **properties:** None
-
----
-
-#### MAddTransform
-
-dst = a*src+b
-
-* **file:** imgproc/madd.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### MaskTransform
-
-Applies an eliptical mask
-
-* **file:** imgproc/mask.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### MatStatsTransform
-
-Statistics
-
-* **file:** imgproc/matstats.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### MeanTransform
-
-Computes the mean of a set of templates.
-
-* **file:** imgproc/mean.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### MeanFillTransform
-
-Fill 0 pixels with the mean of non-0 pixels.
-
-* **file:** imgproc/meanfill.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### MergeTransform
-
-Wraps OpenCV merge
-
-* **file:** imgproc/merge.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### MorphTransform
-
-Morphological operator
-
-* **file:** imgproc/morph.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### BuildScalesTransform
-
-Document me
-
-* **file:** imgproc/multiscale.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### NormalizeTransform
-
-Normalize matrix to unit length
-
-* **file:** imgproc/normalize.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:**
-
-	* **NormType**-  Values are NORM_INF, NORM_L1, NORM_L2, NORM_MINMAX
-	* **ByRow**-  If true normalize each row independently otherwise normalize the entire matrix.
-	* **alpha**-  Lower bound if using NORM_MINMAX. Value to normalize to otherwise.
-	* **beta**-  Upper bound if using NORM_MINMAX. Not used otherwise.
-	* **squareRoot**-  If true compute the signed square root of the output after normalization.
-
-
----
-
-#### OrigLinearRegressionTransform
-
-Prediction with magic numbers from jmp; must get input as blue;green;red
-
-* **file:** imgproc/origlinearregression.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** E. Taborsky
-* **properties:** None
-
----
-
-#### PackTransform
-
-Compress two uchar into one uchar.
-
-* **file:** imgproc/pack.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### PowTransform
-
-Raise each element to the specified power.
-
-* **file:** imgproc/pow.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ProductQuantizationDistance
-
-Distance in a product quantized space
-
-* **file:** imgproc/productquantization.cpp
-* **inherits:** [UntrainableDistance](abstractions.md#untrainabledistance)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ProductQuantizationTransform
-
-Product quantization
-
-* **file:** imgproc/productquantization.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### QuantizeTransform
-
-Approximate floats as uchar.
-
-* **file:** imgproc/quantize.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RankTransform
-
-Converts each element to its rank-ordered value.
-
-* **file:** imgproc/rank.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RectRegionsTransform
-
-Subdivide matrix into rectangular subregions.
-
-* **file:** imgproc/rectregions.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RecursiveIntegralSamplerTransform
-
-Construct template in a recursive decent manner.
-
-* **file:** imgproc/recursiveintegralsampler.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RedLinearRegressionTransform
-
-Prediction using only the red wavelength; magic numbers from jmp
-
-* **file:** imgproc/redlinearregression.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** E. Taborsky
-* **properties:** None
-
----
-
-#### ReshapeTransform
-
-Reshape the each matrix to the specified number of rows.
-
-* **file:** imgproc/reshape.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ResizeTransform
-
-Resize the template
-
-* **file:** imgproc/resize.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RevertAffineTransform
-
-Designed for use after eye detection + Stasm, this will
-
-* **file:** imgproc/revertaffine.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### RGTransform
-
-Normalized RG color space.
-
-* **file:** imgproc/rg.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RndPointTransform
-
-Generates a random landmark.
-
-* **file:** imgproc/rndpoint.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RndRegionTransform
-
-Selects a random region.
-
-* **file:** imgproc/rndregion.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RndRotateTransform
-
-Randomly rotates an image in a specified range.
-
-* **file:** imgproc/rndrotate.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### RndSubspaceTransform
-
-Generates a random subspace.
-
-* **file:** imgproc/rndsubspace.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ROITransform
-
-Crops the rectangular regions of interest.
-
-* **file:** imgproc/roi.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ROIFromPtsTransform
-
-Crops the rectangular regions of interest from given points and sizes.
-
-* **file:** imgproc/roifrompoints.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### RootNormTransform
-
-dst=sqrt(norm_L1(src)) proposed as RootSIFT in
-
-* **file:** imgproc/rootnorm.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RowWiseMeanCenterTransform
-
-Remove the row-wise training set average.
-
-* **file:** imgproc/rowwisemeancenter.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SampleFromMaskTransform
-
-Samples pixels from a mask.
-
-* **file:** imgproc/samplefrommask.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### ScaleTransform
-
-Scales using the given factor
-
-* **file:** imgproc/scale.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### SIFTDescriptorTransform
-
-Specialize wrapper OpenCV SIFT wrapper
-
-* **file:** imgproc/sift.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SkinMaskTransform
-
-http://worldofcameras.wordpress.com/tag/skin-detection-opencv/
-
-* **file:** imgproc/skinmask.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SlidingWindowTransform
-
-Applies a transform to a sliding window.
-
-* **file:** imgproc/slidingwindow.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### IntegralSlidingWindowTransform
-
-Overloads SlidingWindowTransform for integral images that should be
-
-* **file:** imgproc/slidingwindow.cpp
-* **inherits:** [SlidingWindowTransform](abstractions.md#slidingwindowtransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SplitChannelsTransform
-
-Split a multi-channel matrix into several single-channel matrices.
-
-* **file:** imgproc/splitchannels.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SubdivideTransform
-
-Divide the matrix into 4 smaller matricies of equal size.
-
-* **file:** imgproc/subdivide.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SubtractTransform
-
-Subtract two matrices.
-
-* **file:** imgproc/subtract.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ThresholdTransform
-
-Wraps OpenCV's adaptive thresholding.
-
-* **file:** imgproc/threshold.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### WatershedSegmentationTransform
-
-Applies watershed segmentation.
-
-* **file:** imgproc/watershedsegmentation.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Austin Blanton
-* **properties:** None
-
-## Io
-
----
-
-#### DecodeTransform
-
-Decodes images
-
-* **file:** io/decode.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DownloadTransform
-
-Downloads an image from a URL
-
-* **file:** io/download.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### IncrementalOutputTransform
-
-Incrementally output templates received to a gallery, based on the current filename
-
-* **file:** io/incrementaloutput.cpp
-* **inherits:** [TimeVaryingTransform](abstractions.md#timevaryingtransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### OpenTransform
-
-Applies br::Format to br::Template::file::name and appends results.
-
-* **file:** io/open.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### PrintTransform
-
-Prints the template's file to stdout or stderr.
-
-* **file:** io/print.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ReadTransform
-
-Read images
-
-* **file:** io/read.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ReadLandmarksTransform
-
-Read landmarks from a file and associate them with the correct templates.
-
-* **file:** io/readlandmarks.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### WriteTransform
-
-Write all mats to disk as images.
-
-* **file:** io/write.cpp
-* **inherits:** [TimeVaryingTransform](abstractions.md#timevaryingtransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### YouTubeFacesDBTransform
-
-Implements the YouTubesFaceDB
-
-* **file:** io/youtubefacesdb.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
-## Metadata
-
----
-
-#### AnonymizeLandmarksTransform
-
-Remove a name from a point/rect
-
-* **file:** metadata/anonymizelandmarks.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### AsTransform
-
-Change the br::Template::file extension
-
-* **file:** metadata/as.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### AveragePointsTransform
-
-Averages a set of landmarks into a new landmark
-
-* **file:** metadata/averagepoints.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### CascadeTransform
-
-Wraps OpenCV cascade classifier
-
-* **file:** metadata/cascade.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **authors:** Josh Klontz, David Crouse
-* **properties:** None
-
----
-
-#### CheckTransform
-
-Checks the template for NaN values.
-
-* **file:** metadata/check.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ClearPointsTransform
-
-Clears the points from a template
-
-* **file:** metadata/clearpoints.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### ConsolidateDetectionsTransform
-
-Consolidate redundant/overlapping detections.
-
-* **file:** metadata/consolidatedetections.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### CropRectTransform
-
-Crops the width and height of a template's rects by input width and height factors.
-
-* **file:** metadata/croprect.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### DelaunayTransform
-
-Creates a Delaunay triangulation based on a set of points
-
-* **file:** metadata/delaunay.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### ExpandRectTransform
-
-Expand the width and height of a template's rects by input width and height factors.
-
-* **file:** metadata/expandrect.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### ExtractMetadataTransform
-
-Create matrix from metadata values.
-
-* **file:** metadata/extractmetadata.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ASEFEyesTransform
-
-Bolme, D.S.; Draper, B.A.; Beveridge, J.R.;
-
-* **file:** metadata/eyes.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **authors:** David Bolme, Josh Klontz
-* **properties:** None
-
----
-
-#### FilterDupeMetadataTransform
-
-Removes duplicate templates based on a unique metadata key
-
-* **file:** metadata/filterdupemetadata.cpp
-* **inherits:** [TimeVaryingTransform](abstractions.md#timevaryingtransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### GridTransform
-
-Add landmarks to the template in a grid layout
-
-* **file:** metadata/grid.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### GroundTruthTransform
-
-Add any ground truth to the template using the file's base name.
-
-* **file:** metadata/groundtruth.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### HOGPersonDetectorTransform
-
-Detects objects with OpenCV's built-in HOG detection.
-
-* **file:** metadata/hogpersondetector.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### IfMetadataTransform
-
-Clear templates without the required metadata.
-
-* **file:** metadata/ifmetadata.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ImpostorUniquenessMeasureTransform
-
-Impostor Uniqueness Measure
-
-* **file:** metadata/imposteruniquenessmeasure.cpp
-* **inherits:** [Transform](abstractions.md#transform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### JSONTransform
-
-Represent the metadata as JSON template data.
-
-* **file:** metadata/json.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### KeepMetadataTransform
-
-Retains only the values for the keys listed, to reduce template size
-
-* **file:** metadata/keepmetadata.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### KeyPointDetectorTransform
-
-Wraps OpenCV Key Point Detector
-
-* **file:** metadata/keypointdetector.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### KeyToRectTransform
-
-Convert values of key_X, key_Y, key_Width, key_Height to a rect.
-
-* **file:** metadata/keytorect.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Jordan Cheney
-* **properties:** None
-
----
-
-#### MongooseInitializer
-
-Initialize mongoose server
-
-* **file:** metadata/mongoose.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Unknown
-* **properties:** None
-
----
-
-#### NameTransform
-
-Sets the template's matrix data to the br::File::name.
-
-* **file:** metadata/name.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### NameLandmarksTransform
-
-Name a point/rect
-
-* **file:** metadata/namelandmarks.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### NormalizePointsTransform
-
-Normalize points to be relative to a single point
-
-* **file:** metadata/normalizepoints.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### PointDisplacementTransform
-
-Normalize points to be relative to a single point
-
-* **file:** metadata/pointdisplacement.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### PointsToMatrixTransform
-
-Converts either the file::points() list or a QList<QPointF> metadata item to be the template's matrix
-
-* **file:** metadata/pointstomatrix.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### ProcrustesTransform
-
-Procrustes alignment of points
-
-* **file:** metadata/procrustes.cpp
-* **inherits:** [MetadataTransform](abstractions.md#metadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### RectsToTemplatesTransform
-
-For each rectangle bounding box in src, a new
-
-* **file:** metadata/rectstotemplates.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### RegexPropertyTransform
-
-Apply the input regular expression to the value of inputProperty, store the matched portion in outputProperty.
-
-* **file:** metadata/regexproperty.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### RemoveMetadataTransform
-
-Removes a metadata field from all templates
-
-* **file:** metadata/removemetadata.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### RemoveTemplatesTransform
-
-Remove templates with the specified file extension or metadata value.
-
-* **file:** metadata/removetemplates.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RenameTransform
-
-Rename metadata key
-
-* **file:** metadata/rename.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### RenameFirstTransform
-
-Rename first found metadata key
-
-* **file:** metadata/renamefirst.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### ReorderPointsTransform
-
-Reorder the points such that points[from[i]] becomes points[to[i]] and
-
-* **file:** metadata/reorderpoints.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### RestoreMatTransform
-
-Set the last matrix of the input template to a matrix stored as metadata with input propName.
-
-* **file:** metadata/restoremat.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### SaveMatTransform
-
-Store the last matrix of the input template as a metadata key with input property name.
-
-* **file:** metadata/savemat.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### SelectPointsTransform
-
-Retains only landmarks/points at the provided indices
-
-* **file:** metadata/selectpoints.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Brendan Klare
-* **properties:** None
-
----
-
-#### SetMetadataTransform
-
-Sets the metadata key/value pair.
-
-* **file:** metadata/setmetadata.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### SetPointsInRectTransform
-
-Set points relative to a rect
-
-* **file:** metadata/setpointsinrect.cpp
-* **inherits:** [UntrainableMetadataTransform](abstractions.md#untrainablemetadatatransform)
-* **author:** Jordan Cheney
-* **properties:** None
-
----
-
-#### StasmInitializer
-
-Initialize Stasm
-
-* **file:** metadata/stasm4.cpp
-* **inherits:** [Initializer](abstractions.md#initializer)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### StasmTransform
-
-Wraps STASM key point detector
-
-* **file:** metadata/stasm4.cpp
-* **inherits:** [UntrainableTransform](abstractions.md#untrainabletransform)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### StopWatchTransform
-
-Gives time elapsed over a specified transform as a function of both images (or frames) and pixels.
-
-* **file:** metadata/stopwatch.cpp
-* **inherits:** [MetaTransform](abstractions.md#metatransform)
-* **authors:** Jordan Cheney, Josh Klontz
-* **properties:** None
-
-## Output
-
----
-
-#### bestOutput
-
-The highest scoring matches.
-
-* **file:** output/best.cpp
-* **inherits:** [Output](abstractions.md#output)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### csvOutput
-
-Comma separated values output.
-
-* **file:** output/csv.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DefaultOutput
-
-Adaptor class -- write a matrix output using Format classes.
-
-* **file:** output/default.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **author:** Charles Otto
-* **properties:** None
-
----
-
-#### EmptyOutput
-
-Output to the terminal.
-
-* **file:** output/empty.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### evalOutput
-
-Evaluate the output matrix.
-
-* **file:** output/eval.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### heatOutput
-
-Matrix-like output for heat maps.
-
-* **file:** output/heat.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### histOutput
-
-Score histogram.
-
-* **file:** output/hist.cpp
-* **inherits:** [Output](abstractions.md#output)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### meltOutput
-
-One score per row.
-
-* **file:** output/melt.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### mtxOutput
-
-
-
-* **file:** output/mtx.cpp
-* **inherits:** [Output](abstractions.md#output)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### nullOutput
-
-Discards the scores.
-
-* **file:** output/null.cpp
-* **inherits:** [Output](abstractions.md#output)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### rankOutput
-
-Outputs highest ranked matches with scores.
-
-* **file:** output/rank.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **author:** Scott Klum
-* **properties:** None
-
----
-
-#### rrOutput
-
-Rank retrieval output.
-
-* **file:** output/rr.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **authors:** Josh Klontz, Scott Klum
-* **properties:** None
-
----
-
-#### tailOutput
-
-The highest scoring matches.
-
-* **file:** output/tail.cpp
-* **inherits:** [Output](abstractions.md#output)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### txtOutput
-
-Text file output.
-
-* **file:** output/txt.cpp
-* **inherits:** [MatrixOutput](abstractions.md#matrixoutput)
-* **author:** Josh Klontz
-* **properties:** None
-
-## Video
-
----
-
-#### AggregateFrames
-
-Passes along n sequential frames to the next transform.
-
-* **file:** video/aggregate.cpp
-* **inherits:** [TimeVaryingTransform](abstractions.md#timevaryingtransform)
-* **author:** Josh Klontz
-* **properties:** None
-
----
-
-#### DropFrames
-
-Only use one frame every n frames.
-
-* **file:** video/drop.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Austin Blanton
-* **properties:** None
-
----
-
-#### OpticalFlowTransform
-
-Gets a one-channel dense optical flow from two images
-
-* **file:** video/opticalflow.cpp
-* **inherits:** [UntrainableMetaTransform](abstractions.md#untrainablemetatransform)
-* **author:** Austin Blanton
-* **properties:** None
-
-# Technical Overview of the OpenBR System
-
----
-
-## Algorithms in OpenBR
+# Algorithms in OpenBR
 **So you've run `scripts/helloWorld.sh` and it generally makes sense, except you have no idea what    `'Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(128,128,0.33,0.45)+CvtFloat+PCA(0.95):Dist(L2)'` means or how it is executed.**
@@ -38,7 +34,7 @@ These make calls are defined in the public [C++ plugin API](#the c++ plugin api)
 Below we discuss some of the source code for `Transform::make` in `openbr/openbr_plugin.cpp`.
 Note, the make functions for other plugin types are similar in spirit and will not be covered.
-One of the first steps when converting the template enrollment description into a [Transform](abstractions.md#Transform) is to replace the operators, like '+', with their full form:
+One of the first steps when converting the template enrollment description into a [Transform](docs/cpp_api.md#Transform) is to replace the operators, like '+', with their full form:
     { // Check for use of '+' as shorthand for Pipe(...)
          QStringList words = parse(str, '+');
@@ -46,15 +42,15 @@ One of the first steps when converting the template enrollment description into 
              return make("Pipe([" + words.join(",") + "])", parent);
     }
-A pipe (see [PipeTransform](plugins.md#pipetransform)) is the standard way of chaining together multiple steps in series to form more sophisticated algorithms.
-PipeTransform takes a list of transforms, and <i>projects</i> templates through each transform in order.
+A pipe (see [PipeTransform](docs/plugins/core.md#pipetransform)) is the standard way of chaining together multiple steps in series to form more sophisticated algorithms.
+PipeTransform takes a list of transforms, and *projects* templates through each transform in order.
 After operator expansion, the template enrollment description forms a tree, and the transform is constructed from this description starting recursively starting at the root of the tree:
     Transform *transform = Factory<Transform>::make("." + str);
 At this point we reach arguably the most important code in the entire framework, the *object factory* in `openbr/openbr_plugin.h`.
-The [Factory](abstractions.md#factory) class is responsible for constructing an object from a string:
+The [Factory](docs/cpp_api.md#factory) class is responsible for constructing an object from a string:
     static T *make(const File &file)
     {
@@ -70,11 +66,11 @@ The [Factory](abstractions.md#factory) class is responsible for constructing an 
         return object;
     }
-Going back to our original example, a [PipeTransform](plugins.md#pipetransform) will be created with [OpenTransform](plugins.md#opentransform), [CvtTransform](plugins.md#cvttransform), [CascadeTransform](plugins.md#cascadetransform), [ASEFEyesTransform](plugins.md#asefeyestransform), [AffineTransform](plugins.md#affinetransform), [CvtFloatTransform](plugins.md#cvtfloattransform), and [PCATransform](plugins.md#pcatransform) as its children.
+Going back to our original example, a [PipeTransform](docs/plugins/core.md#pipetransform) will be created with [OpenTransform](docs/plugins/io.md#opentransform), [CvtTransform](docs/plugins/imgproc.md#cvttransform), [CascadeTransform](docs/plugins/metadata.md#cascadetransform), [ASEFEyesTransform](docs/plugins/metadata.md#asefeyestransform), [AffineTransform](docs/plugins/imgproc.md#affinetransform), [CvtFloatTransform](docs/plugins/imgproc.md#cvtfloattransform), and [PCATransform](docs/plugins/classification.md#pcatransform) as its children.
-If you want all the tedious details about what exactly this algoritm does, then you should read the [project](abstractions.md#transform#project) function implemented by each of these plugins.
+If you want all the tedious details about what exactly this algoritm does, then you should read the [project](docs/cpp_api.md#project) function implemented by each of these plugins.
 The brief explanation is that it *reads the image from disk, converts it to grayscale, runs the face detector, runs the eye detector on any detected faces, uses the eye locations to normalize the face for rotation and scale, converts to floating point format, and then embeds it in a PCA subspaced trained on face images*.
 If you are familiar with face recognition, you will likely recognize this as the Eigenfaces \cite turk1991eigenfaces algorithm.
 As a final note, the Eigenfaces algorithms uses the Euclidean distance (or L2-norm) to compare templates.
-Since OpenBR expects *similarity* values when comparing templates, and not *distances*, the [DistDistance](plugins.md#distdistance) will return *-log(distance+1)* so that larger values indicate more similarity.
+Since OpenBR expects *similarity* values when comparing templates, and not *distances*, the [DistDistance](docs/plugins/distance.md#distdistance) will return *-log(distance+1)* so that larger values indicate more similarity.
-# Tutorials
-Learn OpenBR!
+Welcome to OpenBR! Here we have a series of tutorials designed to get you up to speed on what OpenBR is, how it works, its command line interface, and the C API. These tutorials aren't meant to be completed in a specific order so feel free to hop around. If you need help, feel free to [contact us](index.md#help).
 ---
-Welcome to OpenBR! Here we have a series of tutorials designed to get you up to speed on what OpenBR is, how it works, its command line interface, and the C API. These tutorials aren't meant to be completed in a specific order so feel free to hop around. If you need help, feel free to [contact us](index.md#help).
+# OpenBR in 10 minutes or less!
----
+This tutorial is meant to familiarize you with the ideas, objects and motivations behind OpenBR using some fun examples. **Note:** parts of this tutorial require a webcam.
+
+OpenBR is a C++ library built on top of QT and OpenCV. It can either be used from the command line using the **br** application, or from interfacing with the [C API](#c-api). The command line is the easiest and fastest way to get started and this tutorial will use it for all of the examples.
+
+First, make sure that OpenBR has been installed on your system using the steps described in the [installation section](#install.md). Then open up your terminal or command prompt and enter:
+
+    $ br -gui -algorithm "Open+Show(false)" -enroll 0.webcam
+
+If everything goes well your webcam should have opened up and is streaming. Look you are using OpenBR! Let's talk about what's happening in this command. OpenBR expects flags to be prepended by a *-* and arguments to follow the flags and be separated by spaces. Flags normally require a specific number of flags. All of the possible flags and their values are [documented here](#docs/cl_api.md). Let's step through the individual arguments and values. **-gui** is the flag that tells OpenBR to open up a GUI window. Take a look at the [GUI plugins](#docs/plugins/gui.md) for other plugins that require the **-gui** flag. **-algorithm** is one of the most important flags in OpenBR. It expects one argument called the *algorithm string*. This string determines the pipeline that images and metadata propagate through. Finally, **-enroll** reads files from disk and *enrolls* them into the image pipeline. It takes one input argument (0.webcam in our example) and an optional output argument. OpenBR has a range of formats that can be enrolled into algorithms, some examples include .jpg, .png, .csv, and .xml. .webcam tells OpenBR to enroll frames from the computers webcam.
+
+Let's try a slightly more complicated example, after all OpenBR can do way more then just open webcams! Face detection is normally the first step in a [face recognition](#face recognition) algorithm. Let's do face detection in OpenBR. Open up the terminal again and enter:
-## OpenBR in 10 minutes or less!
+    $ br -gui -algorithm "Open+Cvt(Gray)+Cascade(FrontalFace)+Draw+Show(false)" -enroll 0.webcam
-This tutorial is meant to familiarize you with the ideas, objects and motivations behind OpenBR. If all you want to do is use some OpenBR applications or API calls the next tutorials might be more relevant to you.
-OpenBR is a C++ library built on top of QT and OpenCV. It was built primarily as a platform for [face recognition](#face recognition) but has grown to do other things like [age recognition](#age recognition) and [gender recognition](#gender recognition). The different functionalities of OpenBR are specified by algorithms which are passed in as strings. The algorithm to do face recognition is
+It was built primarily as a platform for [face recognition](#face recognition) but has grown to do other things like [age recognition](#age recognition) and [gender recognition](#gender recognition). The different functionalities of OpenBR are specified by algorithms which are passed in as strings. The algorithm to do face recognition is
     $ Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(88,88,0.25,0.35)+<Mask+DenseSIFT/DenseLBP+DownsampleTraining(PCA(0.95),instances=1)+Normalize(L2)+Cat>+<Dup(12)+RndSubspace(0.05,1)+DownsampleTraining(LDA(0.98),instances=-2)+Cat+DownsampleTraining(PCA(768),instances=1)>+<Normalize(L1)+Quantize)>+SetMetadata(AlgorithmID,-1):Unit(ByteL1)
 Woah, that's a lot! Face recognition is a pretty complicated process! We will break this whole string down in just a second, but first we can showcase one of the founding principles of OpenBR. In the face recognition algorithm there are a series of steps separated by +'s (and a few other symbols but they will all be explained); these steps are called plugins and they are the building blocks of all OpenBR algorithms. Each plugin is completely independent of all of the other plugins around it and each one can be swapped, inserted or removed at any time to form new algorithms. This makes it really easy to test new ideas as you come up with them!
-So, now lets talk about the basics of algorithms in OpenBR. We know that algorithms are just a series of plugins joined together using the + symbol. What about the : symbol right at the end of the algorithm however? :'s separate the processing part of the algorithm (also called enrollment or generation), from the evaluation part. OpenBR actually has different types of plugins to handle each part. Plugins to the left are called [transforms](abstractions.md#transform) and plugins to the right are called [distances](abstractions.md#distance). Transforms operate on the images as they pass through the algorithm and distances compare (or find the distance between) the images as they finish, usually constructing a similarity matrix in the process.
+So, now lets talk about the basics of algorithms in OpenBR. We know that algorithms are just a series of plugins joined together using the + symbol. What about the : symbol right at the end of the algorithm however? :'s separate the processing part of the algorithm (also called enrollment or generation), from the evaluation part. OpenBR actually has different types of plugins to handle each part. Plugins to the left are called [transforms](docs/cpp_api.md#transform) and plugins to the right are called [distances](docs/cpp_api.md#distance). Transforms operate on the images as they pass through the algorithm and distances compare (or find the distance between) the images as they finish, usually constructing a similarity matrix in the process.
-This leads us on a small tangent to discuss how images are handled in OpenBR. OpenBR has two structures dedicated to handling data as it passes through an algorithm, [Files](abstractions.md#file) and [Templates](abstractions.md#template). Files handle metadata, the text and other information that can be associated with an image, and templates act as a container for images (we use OpenCV mats) and files. These templates are passed from transform to transform through the algorithm and are *transformed* (see, the name makes sense!) as they go.
+This leads us on a small tangent to discuss how images are handled in OpenBR. OpenBR has two structures dedicated to handling data as it passes through an algorithm, [Files](docs/cpp_api.md#file) and [Templates](docs/cpp_api.md#template). Files handle metadata, the text and other information that can be associated with an image, and templates act as a container for images (we use OpenCV mats) and files. These templates are passed from transform to transform through the algorithm and are *transformed* (see, the name makes sense!) as they go.
-Great, you now know how data is handled in OpenBR but we still have a lot to cover in that algorithm string! Next lets talk about all of the parentheses next to each plugin. Many plugins have parameters that can be set at runtime. For example, [Cvt](plugins.md#cvttransform) (short for convert) changes the colorspace of an image. For face recognition we want to change it to gray so we pass in Gray as the parameter to Cvt. Pretty simple right? Parameters can either be passed in in the order they appear in the code, or they can use a key-value pairing. Cvt(Gray) is equivalent to Cvt(ColorSpace=Gray), check out the docs for the properties of each plugin.
+Great, you now know how data is handled in OpenBR but we still have a lot to cover in that algorithm string! Next lets talk about all of the parentheses next to each plugin. Many plugins have parameters that can be set at runtime. For example, [Cvt](docs/plugins/imgproc.md#cvttransform) (short for convert) changes the colorspace of an image. For face recognition we want to change it to gray so we pass in Gray as the parameter to Cvt. Pretty simple right? Parameters can either be passed in in the order they appear in the code, or they can use a key-value pairing. Cvt(Gray) is equivalent to Cvt(ColorSpace=Gray), check out the docs for the properties of each plugin.
-The last symbol we need to cover is <>. In OpenBR <> represents i/o. Transforms within these brackets will try and load their parameters from the hard drive if they can (they also still take parameters from the command line as you can see). Plugin i/o won't be covered here because it isn't critically important to making OpenBR work for you out of the gate. Stay tuned for a later tutorial on this. 
+The last symbol we need to cover is <>. In OpenBR <> represents i/o. Transforms within these brackets will try and load their parameters from the hard drive if they can (they also still take parameters from the command line as you can see). Plugin i/o won't be covered here because it isn't critically important to making OpenBR work for you out of the gate. Stay tuned for a later tutorial on this.
 site_name: OpenBR
+theme: readthedocs
+
 pages:
-- [index.md, Home]
-- [install.md, Install]
-- [tutorials.md, Tutorials]
-- [technical.md, Technical Overview]
-- [abstractions.md, Docs, Abstractions]
-- [plugins.md, Docs, Plugins]
-theme: flatly
+- [index.md, OpenBR]
+- [install.md, Home, Install]
+- [tutorials.md, Home, Tutorials]
+- [technical.md, Home, Technical Overview]
+- [contribute.md, Home, Contribute]
+- [docs/c_api.md, API Docs, C API]
+- [docs/cpp_api.md, API Docs, C++ Plugin API]
+- [docs/cl_api.md, API Docs, Command Line API]
+- [docs/plugins/classification.md, Plugin Docs, Classification]
+- [docs/plugins/cluster.md, Plugin Docs, Cluster]
+- [docs/plugins/core.md, Plugin Docs, Core]
+- [docs/plugins/distance.md, Plugin Docs, Distance]
+- [docs/plugins/format.md, Plugin Docs, Format]
+- [docs/plugins/gallery.md, Plugin Docs, Gallery]
+- [docs/plugins/gui.md, Plugin Docs, GUI]
+- [docs/plugins/imgproc.md, Plugin Docs, Image Processing]
+- [docs/plugins/io.md, Plugin Docs, I/O]
+- [docs/plugins/metadata.md, Plugin Docs, Metadata]
+- [docs/plugins/output.md, Plugin Docs, Output]
+- [docs/plugins/video.md, Plugin Docs, Video]
@@ -7,6 +7,12 @@ def subfiles(path):
 def subdirs(path):
     return [name for name in os.listdir(path) if os.path.isdir(os.path.join(path, name))]
+def formatModule(module):
+    if module == 'io':
+        return 'i/o'
+    else:
+        return module.capitalize()
+
 def parse(group):
     docs = re.compile('/\*\!(.*?)\*/', re.DOTALL)
@@ -44,18 +50,14 @@ def parseProperties(properties):
 def main():
     plugins_dir = '../../openbr/plugins/'
-    output_file = open('../docs/plugins.md', 'w+')
-
-    output_file.write("# Plugins\n\n" +
-                      "A description of all of the plugins available in OpenBR, broken down" +
-                      " by module. This section assumes knowledge of the [C++ Plugin API](technical.md#c++ plugin api)" +
-                      " and the [plugin abstractions](abstractions.md).\n\n")
+    output_dir = '../docs/docs/plugins/'
     for module in subdirs(plugins_dir):
         if module == "cmake":
             continue
-        output_file.write("## " + module.capitalize() + "\n\n")
+        output_file = open(os.path.join(output_dir, module + '.md'), 'w+')
+
         for plugin in subfiles(os.path.join(plugins_dir, module)):
             f = open(os.path.join(os.path.join(plugins_dir, module), plugin), 'r')
             content = f.read()
@@ -68,10 +70,10 @@ def main():
                     continue
                 output_file.write("---\n\n")
-                output_file.write("#### " + attributes["Name"] + "\n\n")
+                output_file.write("# " + attributes["Name"] + "\n\n")
                 output_file.write(attributes["brief"][0] + "\n\n")
                 output_file.write("* **file:** " + os.path.join(module, plugin) + "\n")
-                output_file.write("* **inherits:** [" + attributes["Parent"] + "](abstractions.md#" + attributes["Parent"].lower() + ")\n")
+                output_file.write("* **inherits:** [" + attributes["Parent"] + "](../cpp_api.md#" + attributes["Parent"].lower() + ")\n")
                 authors = attributes["author"]
                 if len(authors) > 1: