Updated plugin documentation, documented command line API and added to C++ Plugin API

Jordan Cheney
1 parent 53b24eed
Showing 183 changed files with 2628 additions and 2772 deletions
app/br/br.cpp
docs/docs/api_docs/c_api/functions.md
docs/docs/api_docs/cl_api.md
docs/docs/api_docs/cpp_api.md
docs/docs/api_docs/cpp_api/compositetransform/compositetransform.md
docs/docs/api_docs/cpp_api/filegallery/constructors.md
docs/docs/api_docs/cpp_api/filegallery/filegallery.md
docs/docs/api_docs/cpp_api/filegallery/functions.md
docs/docs/api_docs/cpp_api/filegallery/members.md
docs/docs/api_docs/cpp_api/filegallery/statics.md
docs/docs/api_docs/cpp_api/gallery/gallery.md
docs/docs/api_docs/cpp_api/metadatatransform/metadatatransform.md
docs/docs/api_docs/cpp_api/transform/functions.md
docs/docs/api_docs/cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md
docs/docs/api_docs/cpp_api/untrainabletransform/untrainabletransform.md
docs/docs/api_docs/cpp_api/wrappertransform/constructors.md
docs/docs/api_docs/cpp_api/wrappertransform/functions.md
docs/docs/api_docs/cpp_api/wrappertransform/members.md
docs/docs/api_docs/cpp_api/wrappertransform/properties.md
docs/docs/api_docs/cpp_api/wrappertransform/statics.md
@@ -251,19 +251,22 @@ private:
                "-train <gallery> ... <gallery> [{model}]\n"
                "-enroll <input_gallery> ... <input_gallery> {output_gallery}\n"
                "-compare <target_gallery> <query_gallery> [{output}]\n"
+               "-pairwiseCompare <target_gallery> <query_gallery> [{output}]\n"
                "-eval <simmat> [<mask>] [{csv}] [{matches}]\n"
+               "-inplaceEval <simmat> <target> <query> [{csv}]\n"
                "-plot <file> ... <file> {destination}\n"
                "\n"
                "==== Other Commands ====\n"
                "-fuse <simmat> ... <simmat> (None|MinMax|ZScore|WScore) (Min|Max|Sum[W1:W2:...:Wn]|Replace|Difference|None) {simmat}\n"
                "-cluster <simmat> ... <simmat> <aggressiveness> {csv}\n"
                "-makeMask <target_gallery> <query_gallery> {mask}\n"
+               "-makePairwiseMask <target_gallery> <query_gallery> {mask}\n"
                "-combineMasks <mask> ... <mask> {mask} (And|Or)\n"
                "-cat <gallery> ... <gallery> {gallery}\n"
                "-convert (Format|Gallery|Output) <input_file> {output_file}\n"
                "-evalClassification <predicted_gallery> <truth_gallery> <predicted property name> <ground truth proprty name>\n"
                "-evalClustering <clusters> <gallery>\n"
-               "-evalDetection <predicted_gallery> <truth_gallery> [{csv}] [{normalize}] [{minSize}]\n"
+               "-evalDetection <predicted_gallery> <truth_gallery> [{csv}] [{normalize}] [{minSize}] [{maxSize}]\n"
                "-evalLandmarking <predicted_gallery> <truth_gallery> [{csv} [<normalization_index_a> <normalization_index_b>] [sample_index] [total_examples]]\n"
                "-evalRegression <predicted_gallery> <truth_gallery> <predicted property name> <ground truth property name>\n"
                "-assertEval <simmat> <mask> <accuracy>\n"
@@ -271,6 +274,7 @@ private:
                "-plotLandmarking <file> ... <file> {destination}\n"
                "-plotMetadata <file> ... <file> <columns>\n"
                "-project <input_gallery> {output_gallery}\n"
+               "-deduplicate <input_gallery> <output_gallery> <threshold>"
                "-getHeader <matrix>\n"
                "-setHeader {<matrix>} <target_gallery> <query_gallery>\n"
                "-<key> <value>\n"
@@ -282,6 +286,7 @@ private:
                "-about\n"
                "-version\n"
                "-daemon\n"
+               "-slave\n"
                "-exit\n");
     }
 };
@@ -263,7 +263,7 @@ Creates a **.csv** file containing performance metrics from evaluating the simil
  
 ## br_assert_eval
  
-Evaluates the similarity matrix using the mask matrix.  Function aborts ff TAR @ FAR = 0.001 does not meet an expected performance value.
+Evaluates the similarity matrix using the mask matrix.  Function aborts if TAR @ FAR = 0.001 does not meet an expected performance value.
  
 * **function definition:**
  
@@ -794,7 +794,7 @@ Returns the full path to the root of the SDK.
  
 ## br_get_header
  
-Retrieve the target and query inputs in the [BEE matrix](../../technical.md#the-evaluation-harness) header. See the bullets at the top of this page on managed return values.
+Retrieve the target and query inputs in the [BEE matrix](../../technical.md#the-evaluation-harness) header. For information on managed return values see [here](../c_api.md#memory).
  
 * **function definition:**
  
@@ -900,8 +900,8 @@ Convenience function for training on multiple inputs
 	Parameter | Type | Description
 	--- | --- | ---
 	num_inputs | int | Size of **inputs**
-	inputs[] | const char * | An array of [galleries](../cpp_api.md#gallery) to train on.
-	modell | const char *model = | (Optional) String specifying the binary file to serialize training results to. The trained algorithm can be recovered by using this file as the algorithm. By default the trained algorithm will not be serialized to disk.
+	inputs[] | const char * | An array of [galleries](../cpp_api/gallery/gallery.md) to train on.
+	model | const char * | (Optional) String specifying the binary file to serialize training results to. The trained algorithm can be recovered by using this file as the algorithm. By default the trained algorithm will not be serialized to disk.
  
 * **output:** (void)
 * **see:** [br_train](#br_train)
@@ -922,6 +922,24 @@ Get the current OpenBR version.
  
 ---
  
+## br_slave_process
+
+For internal use via [ProcessWrapperTransform](../plugins/core.md#processwrappertransform)
+
+* **function definition:**
+
+		void br_slave_process(const char * baseKey)
+
+* **parameters:**
+
+	Parameter | Type | Description
+	--- | --- | ---
+	baseKey | const char * | base key for the slave process
+
+* **output:** (void)
+
+---
+
 ## br_load_img
  
 Load an image from a string buffer. This is an easy way to pass an image in memory from another programming language to openbr.
@@ -1179,7 +1197,7 @@ Enroll a [Template](../cpp_api/template/template.md) from the C API!
  
 	Parameter | Type | Description
 	--- | --- | ---
-	tmpl | br_template | Pointer to a [Template](../cpp_api.md#template).
+	tmpl | br_template | Pointer to a [Template](../cpp_api/template/template.md).
  
 * **output:** ([br_template_list](typedefs.md#br_template_list)) Returns a pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
  
+The command line API is a tool to run OpenBR from the command line. The command line is the easiest and fastest way to run OpenBR! 
+
+The following is a detailed description of the command line API. The command line API is really just a set of wrappers to call the [C API](c_api.md). All of the flags in this API have a corresponding C API call. To help display the examples the following shorthand definitions will be used:
+
+Shortcut | Definition
+--- | ---
+<arg> | <> Represent an input argument
+{arg} | {} Represent an output argument
+[arg] | [] Represent an optional argument
+(arg0|...|argN) | (...|...) Represent a choice. 
+
+## Algorithms
+
+Almost every command line process needs to specify an algorithm to work properly. Algorithms in OpenBR are described in detail [here](../tutorials.md#algorithms-in-openbr). To specify algorithms to the command line use the <tt>-algorithm</tt> flag like so:
+
+		-algorithm "AlgorithmString"
+
+Make sure you use the quotes if your algorithm is longer than one plugin because special characters in OpenBR are also special characters (with very different meanings!) in Bash.
+
+## Core Commands 
+
+### -train {: #train }
+
+Train a model
+
+* **arguments:**
+
+		-train <gallery> ... <gallery> [{model}]
+
+* **wraps:** [br_train_n](c_api/functions.md#br_train_n)
+
+### -enroll {: #enroll }
+
+Enroll a [Gallery](cpp_api/gallery/gallery.md) through an algorithm
+
+* **arguments:**
+
+		-enroll <input_gallery> ... <input_gallery> {output_gallery}
+
+* **wraps:** [br_enroll](c_api/functions.md#br_enroll) or [br_enroll_n](c_api/functions.md#br_enroll_n) depending on the input size
+
+### -compare {: #compare }
+
+Compare query [Templates](cpp_api/template/template.md) against a target [Gallery](cpp_api/gallery/gallery.md)
+
+* **arguments:**
+
+		-compare <target_gallery> <query_gallery> [{output}]
+		
+* **wraps:** [br_compare](c_api/functions.md#br_compare)
+
+### -pairwiseCompare {: #pairwisecompare }
+
+DOCUMENT ME
+
+* **arguments:**
+
+		-pairwiseCompare <target_gallery> <query_gallery> [{output}]
+
+* **wraps:** [br_pairwise_compare](c_api/functions.md#br_pairwise_compare)
+
+### -eval {: #eval }
+
+Evaluate a similarity matrix
+
+* **arguments:**
+
+		-eval <simmat> [<mask>] [{csv}] [{matches}]
+
+* **wraps:** [br_eval](c_api/functions.md#br_eval)
+
+### -inplaceEval {: #inplaceeval }
+
+DOCUMENT ME
+
+* **arguments:**
+
+		-inplaceEval <simmat> <target> <query> [{output}]
+
+* **wraps:** [br_inplace_eval](c_api/functions.md#br_inplace_eval)
+
+### -plot {: #inplaceeval}
+
+Plot the results of an evaluation
+
+* **arguments:**
+
+               -plot <file> ... <file> {destination}
+
+* **wraps:** [br_plot](c_api/functions.md#br_plot)
+
+
+## Other Commands
+
+### -fuse {: #fuse }
+
+Perform score level fusion on similarity matrices.
+
+* **arguments:**
+
+		-fuse <simmat> ... <simmat> (None|MinMax|ZScore|WScore) (Min|Max|Sum[W1:W2:...:Wn]|Replace|Difference|None) {simmat}
+		
+* **wraps:** [br_fuse](c_api/functions.md#br_fuse)
+
+### -cluster {: #cluster }
+
+Clusters one or more similarity matrices into a list of subjects
+
+* **arguments:**
+
+		-cluster <simmat> ... <simmat> <aggressiveness> {csv}
+
+* **wraps:** [br_cluster](c_api/functions.md#br_cluster)
+
+### -makeMask {: #makemask }
+
+Constructs a mask from target and query inputs
+
+* **arguments:**
+
+		-makeMask <target_gallery> <query_gallery> {mask}
+
+* **wraps:** [br_make_mask](c_api/functions.md#br_make_mask)
+
+### -makePairwiseMask {: #makepairwisemask }
+
+Constructs a mask from target and query inputs considering the target and input sets to be definite pairwise comparisons.
+
+* **arguments:**
+
+		-makePairwiseMask <target_gallery> <query_gallery> {mask}
+		
+* **wraps:** [br_make_pairwise_mask](c_api/functions.md#br_make_pairwise_mask)
+
+### -combineMasks {: #combinemask }
+
+Combines several equal-sized mask matrices. A comparison may not be simultaneously indentified as both a genuine and an imposter by different input masks.
+
+* **arguments:**
+
+		-combineMasks <mask> ... <mask> {mask} (And|Or)
+ 
+* **wraps:** [br_combine_masks](c_api/functions.md#br_combine_masks)
+
+### -cat {: #cat }
+
+Concatenates a list of galleries into 1 gallery
+
+* **arguments:**
+
+		-cat <gallery> ... <gallery> {gallery}
+
+* **wraps:** [br_cat](c_api/functions.md#br_cat)
+
+### -convert {: #convert }
+
+Convert a file to a different type. Files can only be converted to types within the same group. For example formats can only be converted to other formats.
+
+* **arguments:**
+
+		-convert (Format|Gallery|Output) <input_file> {output_file}
+
+* **wraps:** [br_convert](c_api/functions.md#br_convert)
+
+### -evalClassification {: #evalclassification }
+
+Evaluates and prints classification accuracy to terminal
+
+* **arguments:**
+
+		-evalClassification <predicted_gallery> <truth_gallery> <predicted property name> <ground truth property name>
+
+* **wraps:** [br_eval_classification](c_api/functions.md#br_eval_classification)
+
+### -evalClustering {: #evalclustering }
+
+Evaluates and prints clustering accuracy to the terminal
+
+* **arguments:**
+
+		-evalClustering <clusters> <gallery>
+
+* **wraps:** [br_eval_clustering](c_api/functions.md#br_eval_clustering)
+
+### -evalDetection {: #evaldetection }
+
+Evaluates and prints detection accuracy to terminal
+
+* **arguments:**
+
+		-evalDetection <predicted_gallery> <truth_gallery> [{csv}] [{normalize}] [{minSize}] [{maxSize}]
+		
+* **wraps:** [br_eval_detection](c_api/functions.md#br_eval_detection)
+
+### -evalLandmarking {: #evallandmarking }
+
+Evaluates and prints landmarking accuracy to terminal
+
+* **arguments:**
+
+		-evalLandmarking <predicted_gallery> <truth_gallery> [{csv} [<normalization_index_a> <normalization_index_b>] [sample_index] [total_examples]]
+		
+* **wraps:** [br_eval_landmarking](c_api/functions.md#br_eval_landmarking)
+
+
+### -evalRegression {: #evalregression }
+
+Evaluates regression accuracy to disk
+
+* **arguments:**
+
+		-evalRegression <predicted_gallery> <truth_gallery> <predicted property name> <ground truth property name>
+		
+* **wraps:** [br_eval_regression](c_api/functions.md#br_eval_regression)
+
+### -assertEval {: #asserteval }
+
+Evaluates the similarity matrix using the mask matrix.  Function aborts if TAR @ FAR = 0.001 does not meet an expected performance value.
+
+* **arguments:**
+
+		-assertEval <simmat> <mask> <accuracy>
+		
+* **wraps:** [br_assert_eval](c_api/functions.md#br_assert_eval)
+
+### -plotDetection {: #plotdetection }
+
+Renders detection performance figures for a set of .csv files created by [-evalDetection](#evaldetection).
+
+* **arguments:**
+
+		-plotDetection <file> ... <file> {destination}
+		
+* **wraps:** [br_plot_detection](c_api/functions.md#br_plot_detection)
+
+### -plotLandmarking {: #plotlandmarking }
+
+Renders landmarking performance figures for a set of .csv files created by [-evalLandmarking](#evallandmarking)
+
+* **arguments:**
+
+		-plotLandmarking <file> ... <file> {destination}
+
+* **wraps:** [br_plot_landmarking](c_api/functions.md#br_plot_landmarking)
+
+### -plotMetadata {: #plotmetadata }
+
+Renders metadata figures for a set of .csv files with specified columns
+
+* **arguments:**
+
+		-plotMetadata <file> ... <file> <columns>
+
+* **wraps:** [br_plot_metadata](c_api/functions.md#br_plot_metadata)
+
+### -project {: #project }
+
+A naive alternative to [-enroll](#enroll)
+
+* **arguments:**
+
+		-project <input_gallery> {output_gallery}
+
+* **wraps:** [br_project](c_api/functions.md#br_project)
+
+### -getHeader {: #getheader }
+
+Retrieve the target and query inputs in the [BEE matrix](../technical.md#the-evaluation-harness) header
+
+* **arguments:**
+
+		-getHeader <matrix>
+
+* **wraps:** [br_get_header](c_api/functions.md#br_get_header)
+
+### -setHeader {: #setheader }
+
+Update the target and query inputs in the [BEE matrix](../technical.md#the-evaluation-harness) header
+
+* **arguments:**
+
+		-setHeader {<matrix>} <target_gallery> <query_gallery>
+		
+* **wraps:** [br_set_header](c_api/functions.md#br_set_header)
+
+### -&lt;key&gt; &lt;value&gt; {: #setproperty }
+
+Appends a provided value to the [global metadata](cpp_api/context/context.md) using a provided key
+
+* **arguments:**
+
+		-<key> <value>
+		
+* **wraps:** [br_set_property](c_api/functions.md#br_set_property)
+
+
+## Miscellaneous
+
+### -help {: #help }
+
+Print command line API documentation to the terminal
+
+* **arguments:**
+
+		-help
+		
+* **wraps:** N/A
+
+### -gui {: #gui }
+
+If this flag is set OpenBR will enable GUI windows to be launched. It must be the first flag set.
+
+* **arguments:**
+
+		br -gui
+		
+* **wraps:** N/A
+
+### -objects {: #objects }
+
+Returns names and parameters for the requested objects. Each object is newline seperated. Arguments are seperated from the object name with a tab. This function uses [QRegExp][QRegExp] syntax
+
+* **arguments:**
+
+		-objects [abstraction [implementation]]
+		
+* **wraps:** [br_objects](c_api/functions.md#br_objects)
+
+### -about {: #about }
+
+Get a string with the name, version, and copyright of the project. This string is suitable for printing or terminal
+
+* **arguments:**
+
+		-about
+		
+* **wraps:** [br_about](c_api/functions.md#br_about)
+
+### -version {: #version }
+
+Get the current OpenBR version
+
+* **arguments:**
+
+		-version
+
+* **wraps:** [br_version](c_api/functions.md#br_version)
+
+### -slave {: #slave }
+
+For internal use via [ProcessWrapperTransform](../plugins/core.md#processwrappertransform)
+
+* **arguments:**
+
+		-slave <baseKey>
+
+* **wraps:** [br_slave_process](c_api/functions.md#br_slave_process)
+
+### -daemon {: #daemon }
+
+DOCUMENT ME
+
+* **arguments:**
+
+		-daemon <daemon_pipe>
+
+* **wraps:** N/A
+
+### -exit
+
+Exit the application
+
+* **arguments:**
+
+		-exit
+
+* **wraps:** N/A
 \ No newline at end of file
 # C++ Plugin API
  
-The C++ Plugin API is a pluggable API designed to allow the succinct expression of biometrics algorithms as a series of independent plugins. The API exposes a number of data structures and plugin abstractions to use as simple building blocks for complex algorithms. 
+The C++ Plugin API is a pluggable API designed to allow the succinct expression of biometrics algorithms as a series of independent plugins. The API exposes a number of data structures and plugin abstractions to use as simple building blocks for complex algorithms.
  
 ## Data Structures
  
-The API defines two data structures: 
+The API defines two data structures:
  
 * [Files](cpp_api/file/file.md)
 * [Templates](cpp_api/template/template.md)
  
-[Files](cpp_api/file/file.md) are used for storing textual data and [Templates](cpp_api/template/template.md) act as containers that hold images, stored as OpenCV [Mats][Mat], and [Files](cpp_api/file/file.md). 
+[Files](cpp_api/file/file.md) are used for storing textual data and [Templates](cpp_api/template/template.md) act as containers that hold images, stored as OpenCV [Mats][Mat], and [Files](cpp_api/file/file.md).
  
 ## Plugin Abstractions
  
@@ -25,20 +25,19 @@ Plugin | Function
 [Output](cpp_api/output/output.md) | Used for I/O. Outputs handle the results of Distance comparisons.
 [Representation](cpp_api/representation/representation.md) | Converts images into feature vectors. Slightly different then Transforms in implementation and available API calls.
 [Classifier](cpp_api/classifier/classifier.md) | Classifies feature vectors as members of specific classes
- 
+
  Additionally, there are several child-abstractions for specific use cases. They are:
- 
+
  Plugin | Parent | Function
  --- | --- | ---
  [UntrainableTransform](cpp_api/untrainabletransform/untrainabletransform.md) | [Transform](cpp_api/transform/transform.md) | A [Transform](cpp_api/transform/transform.md) that cannot be trained
  [MetaTransform](cpp_api/metatransform/metatransform.md) | [Transform](cpp_api/transform/transform.md)  | A [Transform](cpp_api/transform/transform.md) that is *not* [independent](cpp_api/transform/members.md#independent)
  [UntrainableMetaTransform](cpp_api/untrainablemetatransform/untrainablemetatransform.md) | [UntrainableTransform](cpp_api/untrainabletransform/untrainabletransform.md) | A [Transform](cpp_api/transform/transform.md) that is *not* [independent](cpp_api/transform/members.md#independent) and cannot be trained
- [MetadataTransform](cpp_api/metadatatransform/metadatatransform.md) | [Transform](cpp_api/transform/transform.md) | A [Transform](cpp_api/transform/transform.md) that operates only on [Transform](cpp_api/transform/transform.md) [metadata](cpp_api/transform/members.md#file)
+ [MetadataTransform](cpp_api/metadatatransform/metadatatransform.md) | [Transform](cpp_api/transform/transform.md) | A [Transform](cpp_api/transform/transform.md) that operates only on [Template](cpp_api/template/template.md) [metadata](cpp_api/template/members.md#file)
  [UntrainableMetadataTransform](cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md) | [MetadataTransform](cpp_api/metadatatransform/metadatatransform.md) | A [MetadataTransform](cpp_api/metadatatransform/metadatatransform.md) that cannot be trained
  [TimeVaryingTransform](cpp_api/timevaryingtransform/timevaryingtransform.md) | [Transform](cpp_api/transform/transform.md) | A [Transform](cpp_api/transform/transform.md) that changes at runtime as a result of the input
  [UntrainableDistance](cpp_api/untrainabledistance/untrainabledistance.md) | [Distance](cpp_api/distance/distance.md) | A [Distance](cpp_api/distance/distance.md) that cannot be trained
  [FileGallery](cpp_api/filegallery/filegallery.md) | [Gallery](cpp_api/gallery/gallery.md) | DOCUMENT ME
  [MatrixOutput](cpp_api/matrixoutput/matrixoutput.md) | [Output](cpp_api/output/output.md) | A [Output](cpp_api/output/output.md) that outputs data as a matrix
- 
+
  As was stated before, all plugins in OpenBR are constructed using strings stored as [Files](cpp_api/file/file.md). The construction is done at runtime by a [Factory](cpp_api/factory/factory.md) class. The [Factory](cpp_api/factory/factory.md) expects strings of the form "PluginName(property1=value1,propert2=value2...propertyN=valueN)". It then looks up the "PluginName" in a static registry and builds the plugin if found. The registry is populated using a special macro [BR_REGISTER](cpp_api/factory/macros.md#br_register); each plugin needs to register itself and its base abstraction in the factory to enable construction. The purpose of this is to allow algorithms to be described completely by strings. For more information on algorithms in OpenBR please see the [tutorial](../tutorials.md#algorithms-in-openbr)
- 
 \ No newline at end of file
+<!-- CompositeTransform -->
+
+Inherits [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md)
+
+Base class for [Transforms](../transform/transform.md) that aggregate subtransforms.
+
+See:
+
+* [Properties](properties.md)
+* [Members](members.md)
+* [Constructors](constructors.md)
+* [Static Functions](statics.md)
+* [Functions](functions.md)
+
+A CompositeTransform is a wrapper around a list of child transforms. It is used internally for plugins like pipes and forks. It offers
 \ No newline at end of file
+Constructor / Destructor | Description
+--- | ---
+virtual ~FileGallery() | Default destructor. Closes [f](members.md#f)
 \ No newline at end of file
 <!-- FILE GALLERY -->
  
 Inherits [Gallery](../gallery/gallery.md)
+
+A [Gallery](../gallery/gallery.md) that handles data stored on disk (as opposed to data already in memory).
+
+See:
+
+* [Members](members.md)
+* [Constructors](constructors.md)
+* [Static Functions](statics.md)
+* [Functions](functions.md)
+
+[FileGalleries](filegallery.md) are the base abstraction for all [Galleries](../gallery/gallery.md) that handle I/O with the hard drive. They automatically track the size and current position of a file and also provide convienience opererators for opening them for reading and writing.
 \ No newline at end of file
+## void init() {: #init }
+
+Initialize the [FileGallery](filegallery.md). This sets [f](members.md#f) using the file name from [file](../object/members.md#file). It also calls [Gallery](../gallery/gallery.md)::[init](../gallery/functions.md#init).
+
+* **function definition:**
+		
+		void init()
+
+* **parameters:** NONE
+* **output:** (void)
+
+## qint64 totalSize() {: #totalsize }
+
+Get the total size of the file. This is useful for estimating progress.
+
+* **function definition:**
+		
+		qint64 totalSize()
+
+* **parameters:** NONE
+* **output:** (qint64) Returns the total size of the file in bytes
+
+## qint64 position() {: #pos }
+
+Get the current index in the file. This is useful for reading and writing blocks of data
+
+* **function definition:**
+
+		qint64 position()
+
+* **parameters:** NONE
+* **output:** (qint64) Returns the current position in the file
+
+## bool readOpen() {: #readopen }
+
+Open [f](members.md#f) in read-only mode
+
+* **function definition:**
+
+		bool readOpen()
+		
+* **parameters:** NONE
+* **output:** (bool) Returns true if the file was opened successfully, false otherwise
+
+## void writeOnly() {: #writeonly }
+
+Open [f](members.md#f) in write-only mode
+
+* **function definition:**
+
+		void writeOpen()
+
+* **parameters:** NONE
+* **output:** (void)
 \ No newline at end of file
+Member | Type | Description
+--- | --- | ---
+<a class="table-anchor" id="f"></a>f | [QFile][QFile] | The file on disk. It has the same name as [file](../object/members.md#file)
+NONE
 \ No newline at end of file
@@ -6,6 +6,7 @@ Plugin base class for storing a list of enrolled templates.
  
 See:
  
+* [Properties](properties.md)
 * [Members](members.md)
 * [Constructors](constructors.md)
 * [Static Functions](statics.md)
@@ -11,4 +11,4 @@ See:
 * [Static Functions](statics.md)
 * [Functions](functions.md)
  
-[MetadataTransforms](metadatatransform.md) are [Transforms](../transform/transform.md) that operate soley on textual [metadata](../transform/members.md#file). They are *not* [independent](../transform/members.md#independent) because [Templates](../template/template.md) can only every have one collection of [metadata](../template/members.md#file).
+[MetadataTransforms](metadatatransform.md) are [Transforms](../transform/transform.md) that operate soley on textual [metadata](../template/members.md#file). They are *not* [independent](../transform/members.md#independent) because [Templates](../template/template.md) can only every have one collection of [metadata](../template/members.md#file).
@@ -380,7 +380,7 @@ Convenience function to call [smartCopy](#smartcopy-1) without arguments
  
 ## [Transform](transform.md) \*simplify(bool &newTransform) {: #simplify }
  
-This is a virtual function. Get a simplified version of the transform for use at project time. The simplified version of the [Transform](transform.md) does not include any [Transforms](transform.md) that are only active at train time. It also removes any [LoadStore](../../plugins/core.md#loadstoretransform) transforms and keeps only their children. Transforms that only are active at train time (see [DownsampleTransform](../../plugins/core.md#downsampletransform) as an example) should overload this function and return their children if they have any or NULL if they do not.
+This is a virtual function. Get a simplified version of the transform for use at project time. The simplified version of the [Transform](transform.md) does not include any [Transforms](transform.md) that are only active at train time. It also removes any [LoadStore](../../plugins/core.md#loadstoretransform) transforms and keeps only their children. Transforms that only are active at train time (see [DownsampleTrainingTransform](../../plugins/core.md#downsampletrainingtransform) as an example) should overload this function and return their children if they have any or NULL if they do not.
  
 * **function definition:**
  
@@ -11,4 +11,4 @@ See:
 * [Static Functions](statics.md)
 * [Functions](functions.md)
  
-[UntrainableMetadataTransforms](untrainablemetadatatransform.md) are [Transforms](../transform/transform.md) that operate soley on textual [metadata](../transform/members.md#file). They are *not* [independent](../transform/members.md#independent), because [Templates](../template/template.md) can only every have one collection of [metadata](../template/members.md#file), and they are *not* [trainable](../transform/members.md#trainable).
+[UntrainableMetadataTransforms](untrainablemetadatatransform.md) are [Transforms](../transform/transform.md) that operate soley on textual [metadata](../template/members.md#file). They are *not* [independent](../transform/members.md#independent), because [Templates](../template/template.md) can only every have one collection of [metadata](../template/members.md#file), and they are *not* [trainable](../transform/members.md#trainable).
@@ -11,4 +11,4 @@ See:
 * [Static Functions](statics.md)
 * [Functions](functions.md)
  
-This is a base class for [Transforms](../transform/transform.md) that are not trainable. It overloads [train](../transform/functions.md#train-1), [load](../transform/functions.md#load), and [store](../transform/functions.md#store) so that they cannot be used in derived classes. Load and store are overloaded because a [Transform](../transform/transform.md) that doesn't train should also have nothing to save.
 \ No newline at end of file
+This is a base class for [Transforms](../transform/transform.md) that are not trainable. It overloads [train](../transform/functions.md#train-1), [load](../object/functions.md#load), and [store](../object/functions.md#store) so that they cannot be used in derived classes. Load and store are overloaded because a [Transform](../transform/transform.md) that doesn't train should also have nothing to save.
+<!-- WrapperTransform -->
+
+Inherits [Transform](../transform/transform.md)
+
+Base class for [Transforms](../transform/transform.md) that act as decorators of another [Transform](../transform/transform.md)
+
+See:
+
+* [Properties](properties.md)
+* [Members](members.md)
+* [Constructors](constructors.md)
+* [Static Functions](statics.md)
+* [Functions](functions.md)
 \ No newline at end of file
 # AdaBoostTransform
  
 Wraps OpenCV's Ada Boost framework
+ 
  
 * **file:** classification/adaboost.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
+* **author(s):** [Scott Klum][sklum]
 * **see:** [http://docs.opencv.org/modules/ml/doc/boosting.html](http://docs.opencv.org/modules/ml/doc/boosting.html)
-* **author:** Scott Klum
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-type | enum | Type of Adaboost to perform. Options are:<ul><li>Discrete</li><li>Real</li><li>Logit</li><li>Gentle</li></ul>Default is Real.
-splitCriteria | enum | Splitting criteria used to choose optimal splits during a weak tree construction. Options are:<ul><li>Default</li><li>Gini</li><li>Misclass</li><li>Sqerr</li></ul>Default is Default.
-weakCount | int | Maximum number of weak classifiers per stage. Default is 100.
-trimRate | float | A threshold between 0 and 1 used to save computational time. Samples with summary weight
-folds | int | OpenCV parameter variable. Default value is 0.
-maxDepth | int | Maximum height of each weak classifier tree. Default is 1 (stumps).
-returnConfidence | bool | Return the confidence value of the classification or the class value of the classification. Default is true (return confidence value).
-overwriteMat | bool | If true, the output template will be a 1x1 matrix with value equal to the confidence or classification (depending on returnConfidence). If false the output template will be the same as the input template. Default is true.
-inputVariable | QString | Metadata variable storing the label for each template. Default is "Label".
-outputVariable | QString | Metadata variable to store the confidence or classification of each template (depending on returnConfidence). If overwriteMat is true nothing will be written here. Default is "".
+	Property | Type | Description
+	--- | --- | ---
+	enum | type | Type of Adaboost to perform. Options are:<ul><li>Discrete</li><li>Real</li><li>Logit</li><li>Gentle</li></ul>Default is Real.
+	enum | splitCriteria | Splitting criteria used to choose optimal splits during a weak tree construction. Options are:<ul><li>Default</li><li>Gini</li><li>Misclass</li><li>Sqerr</li></ul>Default is Default.
+	int | weakCount | Maximum number of weak classifiers per stage. Default is 100.
+	float | trimRate | A threshold between 0 and 1 used to save computational time. Samples with summary weight
+	int | folds | OpenCV parameter variable. Default value is 0.
+	int | maxDepth | Maximum height of each weak classifier tree. Default is 1 (stumps).
+	bool | returnConfidence | Return the confidence value of the classification or the class value of the classification. Default is true (return confidence value).
+	bool | overwriteMat | If true, the output template will be a 1x1 matrix with value equal to the confidence or classification (depending on returnConfidence). If false the output template will be the same as the input template. Default is true.
+	QString | inputVariable | Metadata variable storing the label for each template. Default is "Label".
+	QString | outputVariable | Metadata variable to store the confidence or classification of each template (depending on returnConfidence). If overwriteMat is true nothing will be written here. Default is "".
  
 ---
  
 # DFFSTransform
  
-Computes Distance From Feature Space (DFFS)
+Computes [Distance](../cpp_api/distance/distance.md) From Feature Space (DFFS)
+ 
  
 * **file:** classification/lda.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Moghaddam, Baback, and Alex Pentland.*
+	 **"Probabilistic visual learning for object representation."**
+	 Pattern Analysis and Machine Intelligence, IEEE Transactions on 19.7 (1997): 696-710.
+
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-keep | float | Sets PCA keep property. Default is 0.95.
+	Property | Type | Description
+	--- | --- | ---
+	keep | float | Sets PCA keep property. Default is 0.95.
  
 ---
  
 # EBIFTransform
  
 Face Recognition Using Early Biologically Inspired Features
+ 
  
 * **file:** classification/ebif.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **see:** [Min Li (IBM China Research Lab, China), Nalini Ratha (IBM Watson Research Center, USA), Weihong Qian (IBM China Research Lab, China), Shenghua Bao (IBM China Research Lab, China), Zhong Su (IBM China Research Lab, China)](#min li (ibm china research lab, china), nalini ratha (ibm watson research center, usa), weihong qian (ibm china research lab, china), shenghua bao (ibm china research lab, china), zhong su (ibm china research lab, china))
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Li, Min, et al.*
+	 **"Face recognition using early biologically inspired features."**
+	 Biometrics: Theory, Applications and Systems (BTAS), 2013 IEEE Sixth International Conference on. IEEE, 2013.
+
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-N | int | The number of scales. Default is 6.
-M | int | The number of orientations between 0 and pi. Default is 9.
+	Property | Type | Description
+	--- | --- | ---
+	N | int | The number of scales. Default is 6.
+	M | int | The number of orientations between 0 and pi. Default is 9.
  
 ---
  
 # ForestInductionTransform
  
 Wraps OpenCV's random trees framework to induce features
+ 
  
 * **file:** classification/forest.cpp
 * **inherits:** [ForestTransform](#foresttransform)
+* **author(s):** [Scott Klum][sklum]
 * **see:** [https://lirias.kuleuven.be/bitstream/123456789/316661/1/icdm11-camready.pdf](https://lirias.kuleuven.be/bitstream/123456789/316661/1/icdm11-camready.pdf)
-* **author:** Scott Klum
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-useRegressionValue | bool | SCOTT FILL ME IN.
+	Property | Type | Description
+	--- | --- | ---
+	useRegressionValue | bool | SCOTT FILL ME IN.
  
 ---
  
 # ForestTransform
  
 Wraps OpenCV's random trees framework
+ 
  
 * **file:** classification/forest.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
+* **author(s):** [Scott Klum][sklum]
 * **see:** [http://docs.opencv.org/modules/ml/doc/random_trees.html](http://docs.opencv.org/modules/ml/doc/random_trees.html)
-* **author:** Scott Klum
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-classification | bool | If true the labels are expected to be categorical. Otherwise they are expected to be numerical. Default is true.
-splitPercentage | float | Used to calculate the minimum number of samples per split in a random tree. The minimum number of samples is calculated as the number of samples x splitPercentage. Default is 0.01.
-maxDepth | int | The maximum depth of each decision tree. Default is std::numeric_limits<int>::max() and typically should be set by the user.
-maxTrees | int | The maximum number of trees in the forest. Default is 10.
-forestAccuracy | float | A sufficient accuracy for the forest for training to terminate. Used if termCrit is EPS or Both. Default is 0.1.
-returnConfidence | bool | If both classification and returnConfidence are use a fuzzy class label as the output of the forest. Default is true.
-overwriteMat | bool | If true set dst to be a 1x1 Mat with the forest response as its value. Otherwise append the forest response to metadata using outputVariable as a key. Default is true.
-inputVariable | QString | The metadata key for each templates label. Default is "Label".
-outputVariable | QString | The metadata key for the forest response if overwriteMat is false. Default is "".
-weight | bool | If true and classification is true the random forest will use prior accuracies. Default is false.
-termCrit | enum | Termination criteria for training the random forest. Options are Iter, EPS and Both. Iter terminates when the maximum number of trees is reached. EPS terminates when forestAccuracy is met. Both terminates when either is true. Default is Iter.
+	Property | Type | Description
+	--- | --- | ---
+	classification | bool | If true the labels are expected to be categorical. Otherwise they are expected to be numerical. Default is true.
+	splitPercentage | float | Used to calculate the minimum number of samples per split in a random tree. The minimum number of samples is calculated as the number of samples x splitPercentage. Default is 0.01.
+	maxDepth | int | The maximum depth of each decision tree. Default is std::numeric_limits<int>::max() and typically should be set by the user.
+	maxTrees | int | The maximum number of trees in the forest. Default is 10.
+	forestAccuracy | float | A sufficient accuracy for the forest for training to terminate. Used if termCrit is EPS or Both. Default is 0.1.
+	returnConfidence | bool | If both classification and returnConfidence are use a fuzzy class label as the output of the forest. Default is true.
+	overwriteMat | bool | If true set dst to be a 1x1 Mat with the forest response as its value. Otherwise append the forest response to metadata using outputVariable as a key. Default is true.
+	inputVariable | QString | The metadata key for each templates label. Default is "Label".
+	outputVariable | QString | The metadata key for the forest response if overwriteMat is false. Default is "".
+	weight | bool | If true and classification is true the random forest will use prior accuracies. Default is false.
+	termCrit | enum | Termination criteria for training the random forest. Options are Iter, EPS and Both. Iter terminates when the maximum number of trees is reached. EPS terminates when forestAccuracy is met. Both terminates when either is true. Default is Iter.
  
 ---
  
 # IPC2013FaceRecognitionTransform
  
 Intel Perceptual Computing SDK 2013 Face Recognition
+ 
  
 * **file:** classification/ipc2013.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -112,52 +129,68 @@ Intel Perceptual Computing SDK 2013 Face Recognition
 # LDATransform
  
 Projects input into learned Linear Discriminant Analysis subspace.
+ 
  
 * **file:** classification/lda.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **authors:** Brendan Klare, Josh Klontz
+* **author(s):** [Brendan Klare][bklare], [Josh Klontz][jklontz]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-pcaKeep | float | BRENDAN OR JOSH FILL ME IN. Default is 0.98.
-pcaWhiten | bool | BRENDAN OR JOSH FILL ME IN. Default is false.
-directLDA | int | BRENDAN OR JOSH FILL ME IN. Default is 0.
-directDrop | float | BRENDAN OR JOSH FILL ME IN. Default is 0.1.
-inputVariable | QString | BRENDAN OR JOSH FILL ME IN. Default is "Label".
-isBinary | bool | BRENDAN OR JOSH FILL ME IN. Default is false.
-normalize | bool | BRENDAN OR JOSH FILL ME IN. Default is true.
+	Property | Type | Description
+	--- | --- | ---
+	pcaKeep | float | BRENDAN OR JOSH FILL ME IN. Default is 0.98.
+	pcaWhiten | bool | BRENDAN OR JOSH FILL ME IN. Default is false.
+	directLDA | int | BRENDAN OR JOSH FILL ME IN. Default is 0.
+	directDrop | float | BRENDAN OR JOSH FILL ME IN. Default is 0.1.
+	inputVariable | QString | BRENDAN OR JOSH FILL ME IN. Default is "Label".
+	isBinary | bool | BRENDAN OR JOSH FILL ME IN. Default is false.
+	normalize | bool | BRENDAN OR JOSH FILL ME IN. Default is true.
+
+---
+
+# Linear
+
+DOCUMENT ME SCOTT
+ 
+
+* **file:** classification/liblinear.cpp
+* **inherits:** [Transform](../cpp_api/transform/transform.md)
+* **author(s):** [Scott Klum][sklum]
+* **properties:** None
+
  
 ---
  
 # MLPTransform
  
 Wraps OpenCV's multi-layer perceptron framework
+ 
  
 * **file:** classification/mlp.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
+* **author(s):** [Scott Klum][sklum]
 * **see:** [http://docs.opencv.org/modules/ml/doc/neural_networks.html](http://docs.opencv.org/modules/ml/doc/neural_networks.html)
-* **author:** Scott Klum
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-kernel | enum | Type of MLP kernel to use. Options are Identity, Sigmoid, Gaussian. Default is Sigmoid.
-alpha | float | Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.
-beta | float | Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.
-inputVariables | QStringList | Metadata keys for the labels associated with each template. There should be the same number of keys in the list as there are neurons in the final layer. Default is QStringList().
-outputVariables | QStringList | Metadata keys to store the output of the neural network. There should be the same number of keys in the list as there are neurons in the final layer. Default is QStringList().
-neuronsPerLayer | QList<int> | The number of neurons in each layer of the net. Default is QList<int>() << 1 << 1.
+	Property | Type | Description
+	--- | --- | ---
+	kernel | enum | Type of MLP kernel to use. Options are Identity, Sigmoid, Gaussian. Default is Sigmoid.
+	alpha | float | Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.
+	beta | float | Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.
+	inputVariables | QStringList | Metadata keys for the labels associated with each template. There should be the same number of keys in the list as there are neurons in the final layer. Default is QStringList().
+	outputVariables | QStringList | Metadata keys to store the output of the neural network. There should be the same number of keys in the list as there are neurons in the final layer. Default is QStringList().
+	neuronsPerLayer | QList<int> | The number of neurons in each layer of the net. Default is QList<int>() << 1 << 1.
  
 ---
  
 # NT4Compare
  
 Compare templates with Neurotech SDK 4
+ 
  
 * **file:** classification/nt4.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **authors:** Josh Klontz, E. Taborsky
+* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]
 * **properties:** None
  
  
@@ -166,10 +199,11 @@ Compare templates with Neurotech SDK 4
 # NT4DetectFace
  
 Neurotech face detection
+ 
  
 * **file:** classification/nt4.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **authors:** Josh Klontz, E. Taborsky
+* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]
 * **properties:** None
  
  
@@ -178,10 +212,11 @@ Neurotech face detection
 # NT4EnrollFace
  
 Enroll face in Neurotech SDK 4
+ 
  
 * **file:** classification/nt4.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -190,10 +225,11 @@ Enroll face in Neurotech SDK 4
 # NT4EnrollIris
  
 Enroll iris in Neurotech SDK 4
+ 
  
 * **file:** classification/nt4.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** E. Taborsky
+* **author(s):** [E. Taborsky][mmtaborsky]
 * **properties:** None
  
  
@@ -202,27 +238,29 @@ Enroll iris in Neurotech SDK 4
 # PCATransform
  
 Projects input into learned Principal Component Analysis subspace.
+ 
  
 * **file:** classification/lda.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **authors:** Brendan Klare, Josh Klontz
+* **author(s):** [Brendan Klare][bklare], [Josh Klontz][jklontz]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-keep | float | Options are:<ul><li>keep < 0 - All eigenvalues are retained</li><li>keep == 0 - No PCA is performed and the eigenvectors form an identity matrix</li><li>0 < keep < 1 - Keep is the fraction of the variance to retain</li><li>keep >= 1 - keep is the number of leading eigenvectors to retain</li></ul>Default is 0.95.
-drop | int | BRENDAN OR JOSH FILL ME IN. Default is 0.
-whiten | bool | BRENDAN OR JOSH FILL ME IN. Default is false.
+	Property | Type | Description
+	--- | --- | ---
+	keep | float | Options are:<ul><li>keep < 0 - All eigenvalues are retained</li><li>keep == 0 - No PCA is performed and the eigenvectors form an identity matrix</li><li>0 < keep < 1 - Keep is the fraction of the variance to retain</li><li>keep >= 1 - keep is the number of leading eigenvectors to retain</li></ul>Default is 0.95.
+	drop | int | BRENDAN OR JOSH FILL ME IN. Default is 0.
+	whiten | bool | BRENDAN OR JOSH FILL ME IN. Default is false.
  
 ---
  
 # PP4Compare
  
 Compare faces using PittPatt 4.
+ 
  
 * **file:** classification/pp4.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -231,25 +269,27 @@ Compare faces using PittPatt 4.
 # PP4EnrollTransform
  
 Enroll faces in PittPatt 4
+ 
  
 * **file:** classification/pp4.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-detectOnly | bool | If true, return all detected faces. Otherwise, return only faces that are suitable for recognition. Default is false.
+	Property | Type | Description
+	--- | --- | ---
+	detectOnly | bool | If true, return all detected faces. Otherwise, return only faces that are suitable for recognition. Default is false.
  
 ---
  
 # PP5CompareDistance
  
-Compare templates with PP5
+Compare templates with PP5. PP5 distance is known to be asymmetric
+ 
  
 * **file:** classification/pp5.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **authors:** Josh Klontz, E. Taborsky
+* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]
 * **properties:** None
  
  
@@ -258,30 +298,45 @@ Compare templates with PP5
 # PP5EnrollTransform
  
 Enroll faces in PP5
+ 
  
 * **file:** classification/pp5.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **authors:** Josh Klontz, E. Taborsky
+* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-detectOnly | bool | If true, enroll all detected faces. Otherwise, only enroll faces suitable for recognition. Default is false.
-requireLandmarks | bool | If true, require the right eye, left eye, and nose base to be detectable by PP5. If this does not happen FTE is set to true for that template. Default is false.
-adaptiveMinSize | float | The minimum face size as a percentage of total image width. 0.1 corresponds to a minimum face size of 10% the total image width. Default is 0.01.
-minSize | int | The absolute minimum face size to search for. This is not a pixel value. Please see PittPatt documentation for the relationship between minSize and pixel IPD. Default is 4.
-landmarkRange | enum | Range of landmarks to search for. Options are Frontal, Extended, Full, and Comprehensive. Default is Comprehensive.
-searchPruningAggressiveness | int | The amount of aggressiveness involved in search for faces in images. 0 means all scales and locations are searched. 1 means fewer detectors are used in the early stages but all scales are still searched. 2-4 means that the largest faces are found first and then fewer scales are searched. Default is 0.
+	Property | Type | Description
+	--- | --- | ---
+	detectOnly | bool | If true, enroll all detected faces. Otherwise, only enroll faces suitable for recognition. Default is false.
+	requireLandmarks | bool | If true, require the right eye, left eye, and nose base to be detectable by PP5. If this does not happen FTE is set to true for that template. Default is false.
+	adaptiveMinSize | float | The minimum face size as a percentage of total image width. 0.1 corresponds to a minimum face size of 10% the total image width. Default is 0.01.
+	minSize | int | The absolute minimum face size to search for. This is not a pixel value. Please see PittPatt documentation for the relationship between minSize and pixel IPD. Default is 4.
+	landmarkRange | enum | Range of landmarks to search for. Options are Frontal, Extended, Full, and Comprehensive. Default is Comprehensive.
+	searchPruningAggressiveness | int | The amount of aggressiveness involved in search for faces in images. 0 means all scales and locations are searched. 1 means fewer detectors are used in the early stages but all scales are still searched. 2-4 means that the largest faces are found first and then fewer scales are searched. Default is 0.
+
+---
+
+# PP5GalleryTransform
+
+DOCUMENT ME
+ 
+
+* **file:** classification/pp5.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
+* **author(s):** [Unknown][unknown]
+* **properties:** None
+
  
 ---
  
 # RowWisePCATransform
  
 PCA on each row.
+ 
  
 * **file:** classification/lda.cpp
 * **inherits:** [PCATransform](#pcatransform)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -290,63 +345,68 @@ PCA on each row.
 # SVMTransform
  
 Wraps OpenCV's SVM framework.
+ 
  
 * **file:** classification/svm.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **see:**
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://docs.opencv.org/modules/ml/doc/support_vector_machines.html](http://docs.opencv.org/modules/ml/doc/support_vector_machines.html)
+* **read:**
  
-	* [http://docs.opencv.org/modules/ml/doc/support_vector_machines.html](http://docs.opencv.org/modules/ml/doc/support_vector_machines.html)
-	* [C. Burges. "A tutorial on support vector machines for pattern recognition", Knowledge Discovery and Data Mining 2(2), 1998.](C. Burges. "A tutorial on support vector machines for pattern recognition", Knowledge Discovery and Data Mining 2(2), 1998.)
+	1. *C. Burges.*
+	 **"A tutorial on support vector machines for pattern recognition"**
+	 Knowledge Discovery and Data Mining 2(2), 1998.
  
-* **author:** Josh Klontz
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-Kernel | enum | The type of SVM kernel to use. Options are Linear, Poly, RBF, Sigmoid. Default is Linear.
-Type | enum | The type of SVM to do. Options are C_SVC, NU_SVC, ONE_CLASS, EPS_SVR, NU_SVR. Default is C_SVC.
-C | float | Parameter C of an SVM optimization problem. Needed when Type is C_SVC, EPS_SVR or NU_SVR. Default is -1.
-gamma | float | Parameter gamma of a kernel function. Needed when Kernel is Poly, RBF, or Sigmoid. Default is -1.
-inputVariable | QString | Metadata variable storing the label for each template. Default is "Label".
-outputVariable | QString | Metadata variable to store the prediction value of the trained SVM. If type is EPS_SVR or NU_SVR the stored value is the output of the SVM. Otherwise the value is the output of the SVM mapped through the reverse lookup table. Default is "".
-returnDFVal | bool | If true, dst is set to a 1x1 Mat with value equal to the predicted output of the SVM. Default is false.
-termCriteria | int | The maximum number of training iterations. Default is 1000.
-folds | int | Cross validation parameter used for autoselecting other parameters. Default is 5.
-balanceFolds | bool | If true and the problem is 2-class classification then more balanced cross validation subsets are created. Default is false.
+	Property | Type | Description
+	--- | --- | ---
+	Kernel | enum | The type of SVM kernel to use. Options are Linear, Poly, RBF, Sigmoid. Default is Linear.
+	Type | enum | The type of SVM to do. Options are C_SVC, NU_SVC, ONE_CLASS, EPS_SVR, NU_SVR. Default is C_SVC.
+	C | float | Parameter C of an SVM optimization problem. Needed when Type is C_SVC, EPS_SVR or NU_SVR. Default is -1.
+	gamma | float | Parameter gamma of a kernel function. Needed when Kernel is Poly, RBF, or Sigmoid. Default is -1.
+	inputVariable | QString | Metadata variable storing the label for each template. Default is "Label".
+	outputVariable | QString | Metadata variable to store the prediction value of the trained SVM. If type is EPS_SVR or NU_SVR the stored value is the output of the SVM. Otherwise the value is the output of the SVM mapped through the reverse lookup table. Default is "".
+	returnDFVal | bool | If true, dst is set to a 1x1 Mat with value equal to the predicted output of the SVM. Default is false.
+	termCriteria | int | The maximum number of training iterations. Default is 1000.
+	folds | int | Cross validation parameter used for autoselecting other parameters. Default is 5.
+	balanceFolds | bool | If true and the problem is 2-class classification then more balanced cross validation subsets are created. Default is false.
  
 ---
  
 # SparseLDATransform
  
 Projects input into learned Linear Discriminant Analysis subspace learned on a sparse subset of features with the highest weight in the original LDA algorithm.
+ 
  
 * **file:** classification/lda.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-varThreshold | float | BRENDAN FILL ME IN. Default is 1.5.
-pcaKeep | float | BRENDAN FILL ME IN. Default is 0.98.
-normalize | bool | BRENDAN FILL ME IN. Default is true.
+	Property | Type | Description
+	--- | --- | ---
+	varThreshold | float | BRENDAN FILL ME IN. Default is 1.5.
+	pcaKeep | float | BRENDAN FILL ME IN. Default is 0.98.
+	normalize | bool | BRENDAN FILL ME IN. Default is true.
  
 ---
  
 # TurkClassifierTransform
  
 Convenience class for training turk attribute regressors
+ 
  
 * **file:** classification/turk.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-key | QString | Metadata key to pass input values to SVM. Actual lookup key is "key_value" where value is each value in the parameter values. Default is "".
-values | QStringList | Metadata keys to pass input values to SVM. Actual lookup key is "key_value" where key is the parameter key and value is each value in this list. Each passed value trains a new SVM with the input values found in metadata<ul><li>"key_value"</li></ul>. Default is "".
-isMeta | bool | If true, "Average+SaveMat(predicted_key_value)" is appended to each classifier. If false, nothing is appended. Default is false.
+	Property | Type | Description
+	--- | --- | ---
+	key | QString | Metadata key to pass input values to SVM. Actual lookup key is "key_value" where value is each value in the parameter values. Default is "".
+	values | QStringList | Metadata keys to pass input values to SVM. Actual lookup key is "key_value" where key is the parameter key and value is each value in this list. Each passed value trains a new SVM with the input values found in metadata<ul><li>"key_value"</li></ul>. Default is "".
+	isMeta | bool | If true, "Average+SaveMat(predicted_key_value)" is appended to each classifier. If false, nothing is appended. Default is false.
  
 ---
  
 # CollectNNTransform
  
 Collect nearest neighbors and append them to metadata.
+ 
  
 * **file:** cluster/collectnn.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-keep | int | The maximum number of nearest neighbors to keep. Default is 20.
+	Property | Type | Description
+	--- | --- | ---
+	keep | int | The maximum number of nearest neighbors to keep. Default is 20.
  
 ---
  
 # KMeansTransform
  
 Wraps OpenCV kmeans and flann.
+ 
  
 * **file:** cluster/kmeans.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
+* **author(s):** [Josh Klontz][jklontz]
 * **see:** [http://docs.opencv.org/modules/flann/doc/flann_fast_approximate_nearest_neighbor_search.html](http://docs.opencv.org/modules/flann/doc/flann_fast_approximate_nearest_neighbor_search.html)
-* **author:** Josh Klontz
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-kTrain | int | The number of random centroids to make at train time. Default is 256.
-kSearch | int | The number of nearest neighbors to search for at runtime. Default is 1.
+	Property | Type | Description
+	--- | --- | ---
+	kTrain | int | The number of random centroids to make at train time. Default is 256.
+	kSearch | int | The number of nearest neighbors to search for at runtime. Default is 1.
  
 ---
  
 # KNNTransform
  
 K nearest neighbors classifier.
+ 
  
 * **file:** cluster/knn.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -45,32 +48,34 @@ K nearest neighbors classifier.
 # LogNNTransform
  
 Log nearest neighbors to specified file.
+ 
  
 * **file:** cluster/lognn.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-fileName | QString | The name of the log file. An empty fileName won't be written to. Default is "".
+	Property | Type | Description
+	--- | --- | ---
+	fileName | QString | The name of the log file. An empty fileName won't be written to. Default is "".
  
 ---
  
 # RandomCentroidsTransform
  
 Chooses k random points to be centroids.
+ 
  
 * **file:** cluster/randomcentroids.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
+* **author(s):** [Austin Blanton][imaus10]
 * **see:** [http://docs.opencv.org/modules/flann/doc/flann_fast_approximate_nearest_neighbor_search.html](http://docs.opencv.org/modules/flann/doc/flann_fast_approximate_nearest_neighbor_search.html)
-* **author:** Austin Blanton
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-kTrain | int | The number of random centroids to make at train time. Default is 256.
-kSearch | int | The number of nearest neighbors to search for at runtime. Default is 1.
+	Property | Type | Description
+	--- | --- | ---
+	kTrain | int | The number of random centroids to make at train time. Default is 256.
+	kSearch | int | The number of nearest neighbors to search for at runtime. Default is 1.
  
 ---
  
 # CacheTransform
  
-Caches br::Transform::project() results.
+Caches [Transform](../cpp_api/transform/transform.md)::project() results.
+ 
  
 * **file:** core/cache.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -13,10 +14,11 @@ Caches br::Transform::project() results.
 # CollectOutputTransform
  
 DOCUMENT ME CHARLES
+ 
  
 * **file:** core/stream.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -26,9 +28,12 @@ DOCUMENT ME CHARLES
  
 It's like the opposite of ExpandTransform, but not really
  
+Given a [TemplateList](../cpp_api/templatelist/templatelist.md) as input, concatenate them into a single [Template](../cpp_api/template/template.md)
+ 
+
 * **file:** core/contract.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -36,11 +41,15 @@ It&#39;s like the opposite of ExpandTransform, but not really
  
 # CrossValidateTransform
  
-Cross validate a trainable transform.
+Cross validate a trainable [Transform](../cpp_api/transform/transform.md).
+
+To use an extended [Gallery](../cpp_api/gallery/gallery.md), add an allPartitions="true" flag to the gallery sigset for those images that should be compared
+against for all testing partitions.
+ 
  
 * **file:** core/crossvalidate.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **authors:** Josh Klontz, Scott Klum
+* **author(s):** [Josh Klontz][jklontz], [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -49,10 +58,24 @@ Cross validate a trainable transform.
 # DirectStreamTransform
  
 DOCUMENT ME CHARLES
+ 
  
 * **file:** core/stream.cpp
-* **inherits:** [CompositeTransform](#compositetransform)
-* **author:** Charles Otto
+* **inherits:** [CompositeTransform](../cpp_api/compositetransform/compositetransform.md)
+* **author(s):** [Charles Otto][caotto]
+* **properties:** None
+
+
+---
+
+# DiscardTemplatesTransform
+
+DOCUMENT ME
+ 
+
+* **file:** core/discardtemplates.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -60,12 +83,25 @@ DOCUMENT ME CHARLES
  
 # DiscardTransform
  
-Removes all template's matrices.
+Removes all matrices from a [Template](../cpp_api/template/template.md).
+ 
  
 * **file:** core/discard.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **see:** [IdentityTransform FirstTransform RestTransform RemoveTransform](#identitytransform firsttransform resttransform removetransform)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# DistributeTemplateTransform
+
+DOCUMENT ME
+ 
+
+* **file:** core/distributetemplate.cpp
+* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -74,10 +110,24 @@ Removes all template&#39;s matrices.
 # DownsampleTrainingTransform
  
 DOCUMENT ME JOSH
+ 
  
 * **file:** core/downsampletraining.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# EventTransform
+
+DOCUMENT ME
+ 
+
+* **file:** core/event.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -85,12 +135,12 @@ DOCUMENT ME JOSH
  
 # ExpandTransform
  
-Performs an expansion step on input templatelists
+Performs an expansion step on an input [TemplateList](../cpp_api/templatelist/templatelist.md). Each matrix in each input [Template](../cpp_api/template/template.md) is expanded into its own [Template](../cpp_api/template/template.md).
+ 
  
 * **file:** core/expand.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **see:** [PipeTransform](#pipetransform)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -98,11 +148,12 @@ Performs an expansion step on input templatelists
  
 # FTETransform
  
-Flags images that failed to enroll based on the specified transform.
+Flags images that failed to enroll based on the specified [Transform](../cpp_api/transform/transform.md).
+ 
  
 * **file:** core/fte.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -110,12 +161,12 @@ Flags images that failed to enroll based on the specified transform.
  
 # FirstTransform
  
-Removes all but the first matrix from the template.
+Removes all but the first matrix from the [Template](../cpp_api/template/template.md).
+ 
  
 * **file:** core/first.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **see:** [IdentityTransform DiscardTransform RestTransform RemoveTransform](#identitytransform discardtransform resttransform removetransform)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -125,10 +176,12 @@ Removes all but the first matrix from the template.
  
 Transforms in parallel.
  
+The source [Template](../cpp_api/template/template.md) is seperately given to each transform and the results are appended together.
+ 
+
 * **file:** core/fork.cpp
-* **inherits:** [CompositeTransform](#compositetransform)
-* **see:** [PipeTransform](#pipetransform)
-* **author:** Josh Klontz
+* **inherits:** [CompositeTransform](../cpp_api/compositetransform/compositetransform.md)
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -136,11 +189,13 @@ Transforms in parallel.
  
 # GalleryCompareTransform
  
-Compare each template to a fixed gallery (with name = galleryName), using the specified distance.
+Compare each [Template](../cpp_api/template/template.md) to a fixed [Gallery](../cpp_api/gallery/gallery.md) (with name = galleryName), using the specified distance.
+dst will contain a 1 by n vector of scores.
+ 
  
 * **file:** core/gallerycompare.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -148,12 +203,12 @@ Compare each template to a fixed gallery (with name = galleryName), using the sp
  
 # IdentityTransform
  
-A no-op transform.
+A no-op [Transform](../cpp_api/transform/transform.md).
+ 
  
 * **file:** core/identity.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **see:** [DiscardTransform FirstTransform RestTransform RemoveTransform](#discardtransform firsttransform resttransform removetransform)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -161,11 +216,27 @@ A no-op transform.
  
 # IndependentTransform
  
-Clones the transform so that it can be applied independently.
+Clones the [Transform](../cpp_api/transform/transform.md) so that it can be applied independently.
+
+Independent [Transform](../cpp_api/transform/transform.md)s expect single-matrix [Template](../cpp_api/template/template.md).
+ 
  
 * **file:** core/independent.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# JNITransform
+
+Execute Java code from OpenBR using the JNI
+ 
+
+* **file:** core/jni.cpp
+* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
+* **author(s):** [Jordan Cheney][jcheney]
 * **properties:** None
  
  
@@ -174,10 +245,12 @@ Clones the transform so that it can be applied independently.
 # LikelyTransform
  
 Generic interface to Likely JIT compiler
+ 
  
 * **file:** core/likely.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [www.liblikely.org](www.liblikely.org)
 * **properties:** None
  
  
@@ -185,11 +258,12 @@ Generic interface to Likely JIT compiler
  
 # LoadStoreTransform
  
-Caches transform training.
+Caches [Transform](../cpp_api/transform/transform.md) training.
+ 
  
 * **file:** core/loadstore.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -199,14 +273,12 @@ Caches transform training.
  
 Transforms in series.
  
-* **file:** core/pipe.cpp
-* **inherits:** [CompositeTransform](#compositetransform)
-* **see:**
-
-	* [ExpandTransform](ExpandTransform)
-	* [ForkTransform](ForkTransform)
+The source [Template](../cpp_api/template/template.md) is given to the first transform and the resulting [Template](../cpp_api/template/template.md) is passed to the next transform, etc.
+ 
  
-* **author:** Josh Klontz
+* **file:** core/pipe.cpp
+* **inherits:** [CompositeTransform](../cpp_api/compositetransform/compositetransform.md)
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -215,10 +287,11 @@ Transforms in series.
 # ProcessWrapperTransform
  
 Interface to a separate process
+ 
  
 * **file:** core/processwrapper.cpp
-* **inherits:** [WrapperTransform](#wrappertransform)
-* **author:** Charles Otto
+* **inherits:** [WrapperTransform](../cpp_api/wrappertransform/wrappertransform.md)
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -227,10 +300,43 @@ Interface to a separate process
 # ProcrustesAlignTransform
  
 Improved procrustes alignment of points, to include a post processing scaling of points
+to faciliate subsequent texture mapping.
+ 
  
 * **file:** core/align.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
+* **properties:**
+
+	Property | Type | Description
+	--- | --- | ---
+	width | float | Width of output coordinate space (before padding)
+	padding | float | Amount of padding around the coordinate space
+	useFirst | bool | Whether or not to use the first instance as the reference object
+
+---
+
+# ProgressCounterTransform
+
+DOCUMENT ME
+ 
+
+* **file:** core/progresscounter.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
+* **author(s):** [Unknown][unknown]
+* **properties:** None
+
+
+---
+
+# RemoveTransform
+
+Removes the matrix from the [Template](../cpp_api/template/template.md) at the specified index.
+ 
+
+* **file:** core/remove.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -238,12 +344,12 @@ Improved procrustes alignment of points, to include a post processing scaling of
  
 # RestTransform
  
-Removes the first matrix from the template.
+Removes the first matrix from the [Template](../cpp_api/template/template.md).
+ 
  
 * **file:** core/rest.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **see:** [IdentityTransform DiscardTransform FirstTransform RemoveTransform](#identitytransform discardtransform firsttransform removetransform)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -251,11 +357,13 @@ Removes the first matrix from the template.
  
 # SchrodingerTransform
  
-Generates two templates, one of which is passed through a transform and the other
+Generates two [Template](../cpp_api/template/template.md), one of which is passed through a [Transform](../cpp_api/transform/transform.md) and the other
+is not. No cats were harmed in the making of this [Transform](../cpp_api/transform/transform.md).
+ 
  
 * **file:** core/schrodinger.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -263,11 +371,12 @@ Generates two templates, one of which is passed through a transform and the othe
  
 # SingletonTransform
  
-A globally shared transform.
+A globally shared [Transform](../cpp_api/transform/transform.md).
+ 
  
 * **file:** core/singleton.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -276,10 +385,11 @@ A globally shared transform.
 # StreamTransform
  
 DOCUMENT ME CHARLES
+ 
  
 * **file:** core/stream.cpp
-* **inherits:** [WrapperTransform](#wrappertransform)
-* **author:** Charles Otto
+* **inherits:** [WrapperTransform](../cpp_api/wrappertransform/wrappertransform.md)
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -288,10 +398,11 @@ DOCUMENT ME CHARLES
 # SynthesizePointsTransform
  
 Synthesize additional points via triangulation.
+ 
  
 * **file:** core/align.cpp
 * **inherits:** [MetadataTransform](../cpp_api/metadatatransform/metadatatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -300,10 +411,11 @@ Synthesize additional points via triangulation.
 # TextureMapTransform
  
 Maps texture from one set of points to another. Assumes that points are rigidly transformed
+ 
  
 * **file:** core/align.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **authors:** Brendan Klare, Scott Klum
+* **author(s):** [Brendan Klare][bklare], [Scott Klum][sklum]
 * **properties:** None
  
  
 # AttributeDistance
  
 Attenuation function based distance from attributes
+ 
  
 * **file:** distance/attribute.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -12,11 +13,12 @@ Attenuation function based distance from attributes
  
 # BayesianQuantizationDistance
  
-Bayesian quantization distance
+Bayesian quantization [Distance](../cpp_api/distance/distance.md)
+ 
  
 * **file:** distance/bayesianquantization.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -25,10 +27,11 @@ Bayesian quantization distance
 # ByteL1Distance
  
 Fast 8-bit L1 distance
+ 
  
 * **file:** distance/byteL1.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -36,11 +39,12 @@ Fast 8-bit L1 distance
  
 # CrossValidateDistance
  
-Cross validate a distance metric.
+Cross validate a [Distance](../cpp_api/distance/distance.md) metric.
+ 
  
 * **file:** distance/crossvalidate.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -49,10 +53,11 @@ Cross validate a distance metric.
 # DefaultDistance
  
 DistDistance wrapper.
+ 
  
 * **file:** distance/default.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -60,11 +65,12 @@ DistDistance wrapper.
  
 # DistDistance
  
-Standard distance metrics
+Standard [Distance](../cpp_api/distance/distance.md) metrics
+ 
  
 * **file:** distance/dist.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -73,10 +79,11 @@ Standard distance metrics
 # FilterDistance
  
 Checks target metadata against filters.
+ 
  
 * **file:** distance/filter.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -84,23 +91,28 @@ Checks target metadata against filters.
  
 # FuseDistance
  
-Fuses similarity scores across multiple matrices of compared templates
+Fuses similarity scores across multiple matrices of compared [Template](../cpp_api/template/template.md)
+ 
  
 * **file:** distance/fuse.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author:** Scott Klum
-* **properties:** None
+* **author(s):** [Scott Klum][sklum]
+* **properties:**
  
+	Property | Type | Description
+	--- | --- | ---
+	Operation | enum | Possible values are:<ul><li>Mean</li><li>sum</li><li>min</li><li>max</li></ul>.
  
 ---
  
 # HalfByteL1Distance
  
 Fast 4-bit L1 distance
+ 
  
 * **file:** distance/halfbyteL1.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -109,10 +121,11 @@ Fast 4-bit L1 distance
 # HeatMapDistance
  
 1v1 heat map comparison
+ 
  
 * **file:** distance/heatmap.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -120,11 +133,12 @@ Fast 4-bit L1 distance
  
 # IdenticalDistance
  
-Returns
+Returns true if the [Template](../cpp_api/template/template.md) are identical, false otherwise.
+ 
  
 * **file:** distance/identical.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -133,10 +147,12 @@ Returns
 # KeyPointMatcherDistance
  
 Wraps OpenCV Key Point Matcher
+ 
  
 * **file:** distance/keypointmatcher.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://docs.opencv.org/modules/features2d/doc/common_interfaces_of_feature_detectors.html](http://docs.opencv.org/modules/features2d/doc/common_interfaces_of_feature_detectors.html)
 * **properties:** None
  
  
@@ -145,10 +161,11 @@ Wraps OpenCV Key Point Matcher
 # L1Distance
  
 L1 distance computed using eigen.
+ 
  
 * **file:** distance/L1.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -157,10 +174,11 @@ L1 distance computed using eigen.
 # L2Distance
  
 L2 distance computed using eigen.
+ 
  
 * **file:** distance/L2.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -169,10 +187,11 @@ L2 distance computed using eigen.
 # MatchProbabilityDistance
  
 Match Probability
+ 
  
 * **file:** distance/matchprobability.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -181,10 +200,11 @@ Match Probability
 # MetadataDistance
  
 Checks target metadata against query metadata.
+ 
  
 * **file:** distance/metadata.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -193,10 +213,11 @@ Checks target metadata against query metadata.
 # NegativeLogPlusOneDistance
  
 Returns -log(distance(a,b)+1)
+ 
  
 * **file:** distance/neglogplusone.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -204,11 +225,12 @@ Returns -log(distance(a,b)+1)
  
 # OnlineDistance
  
-Online distance metric to attenuate match scores across multiple frames
+Online [Distance](../cpp_api/distance/distance.md) metric to attenuate match scores across multiple frames
+ 
  
 * **file:** distance/online.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Brendan klare
+* **author(s):** [Brendan klare][bklare]
 * **properties:** None
  
  
@@ -218,9 +240,14 @@ Online distance metric to attenuate match scores across multiple frames
  
 Distances in series.
  
+The [Template](../cpp_api/template/template.md) are compared using each [Distance](../cpp_api/distance/distance.md) in order.
+If the result of the comparison with any given distance is -FLOAT_MAX then this result is returned early.
+Otherwise the returned result is the value of comparing the [Template](../cpp_api/template/template.md) using the last [Distance](../cpp_api/distance/distance.md).
+ 
+
 * **file:** distance/pipe.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -228,11 +255,12 @@ Distances in series.
  
 # RejectDistance
  
-Sets distance to -FLOAT_MAX if a target template has/doesn't have a key.
+Sets [Distance](../cpp_api/distance/distance.md) to -FLOAT_MAX if a target [Template](../cpp_api/template/template.md) has/doesn't have a key.
+ 
  
 * **file:** distance/reject.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -240,11 +268,12 @@ Sets distance to -FLOAT_MAX if a target template has/doesn&#39;t have a key.
  
 # SVMDistance
  
-SVM Regression on template absolute differences.
+SVM Regression on [Template](../cpp_api/template/template.md) absolute differences.
+ 
  
 * **file:** distance/svm.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -252,11 +281,12 @@ SVM Regression on template absolute differences.
  
 # SumDistance
  
-Sum match scores across multiple distances
+Sum match scores across multiple [Distance](../cpp_api/distance/distance.md)
+ 
  
 * **file:** distance/sum.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -265,10 +295,11 @@ Sum match scores across multiple distances
 # TurkDistance
  
 Unmaps Turk HITs to be compared against query mats
+ 
  
 * **file:** distance/turk.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -276,11 +307,25 @@ Unmaps Turk HITs to be compared against query mats
  
 # UnitDistance
  
-Linear normalizes of a distance so the mean impostor score is 0 and the mean genuine score is 1.
+Linear normalizes of a [Distance](../cpp_api/distance/distance.md) so the mean impostor score is 0 and the mean genuine score is 1.
+ 
  
 * **file:** distance/unit.cpp
 * **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# ZScoreDistance
+
+DOCUMENT ME
+ 
+
+* **file:** distance/zscore.cpp
+* **inherits:** [Distance](../cpp_api/distance/distance.md)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
 # DefaultFormat
  
 Reads image files.
+ 
  
 * **file:** format/video.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -13,10 +14,12 @@ Reads image files.
 # binaryFormat
  
 A simple binary matrix format.
+ 
  
 * **file:** format/binary.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **format:** First 4 bytes indicate the number of rows. Second 4 bytes indicate the number of columns. The rest of the bytes are 32-bit floating data elements in row-major order. 
 * **properties:** None
  
  
@@ -25,10 +28,11 @@ A simple binary matrix format.
 # csvFormat
  
 Reads a comma separated value file.
+ 
  
 * **file:** format/csv.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -37,10 +41,12 @@ Reads a comma separated value file.
 # ebtsFormat
  
 Reads FBI EBTS transactions.
+ 
  
 * **file:** format/ebts.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
+* **see:** [https://www.fbibiospecs.org/ebts.html](https://www.fbibiospecs.org/ebts.html)
 * **properties:** None
  
  
@@ -49,10 +55,11 @@ Reads FBI EBTS transactions.
 # lffsFormat
  
 Reads a NIST LFFS file.
+ 
  
 * **file:** format/lffs.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -61,10 +68,12 @@ Reads a NIST LFFS file.
 # lmatFormat
  
 Likely matrix format
+ 
  
 * **file:** format/lmat.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [www.liblikely.org](www.liblikely.org)
 * **properties:** None
  
  
@@ -73,10 +82,11 @@ Likely matrix format
 # maskFormat
  
 Reads a NIST BEE mask matrix.
+ 
  
 * **file:** format/mtx.cpp
 * **inherits:** [mtxFormat](#mtxformat)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -86,9 +96,13 @@ Reads a NIST BEE mask matrix.
  
 MATLAB <tt>.mat</tt> format.
  
+matFormat is known not to work with compressed matrices
+ 
+
 * **file:** format/mat.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://www.mathworks.com/help/pdf_doc/matlab/matfile_format.pdf](http://www.mathworks.com/help/pdf_doc/matlab/matfile_format.pdf)
 * **properties:** None
  
  
@@ -97,10 +111,11 @@ MATLAB &lt;tt&gt;.mat&lt;/tt&gt; format.
 # mtxFormat
  
 Reads a NIST BEE similarity matrix.
+ 
  
 * **file:** format/mtx.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -109,10 +124,11 @@ Reads a NIST BEE similarity matrix.
 # nullFormat
  
 Returns an empty matrix.
+ 
  
 * **file:** format/null.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -121,10 +137,11 @@ Returns an empty matrix.
 # postFormat
  
 Handle POST requests
+ 
  
 * **file:** format/post.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -133,10 +150,12 @@ Handle POST requests
 # rawFormat
  
 RAW format
+ 
  
 * **file:** format/raw.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://www.nist.gov/srd/nistsd27.cfm](http://www.nist.gov/srd/nistsd27.cfm)
 * **properties:** None
  
  
@@ -145,10 +164,14 @@ RAW format
 # scoresFormat
  
 Reads in scores or ground truth from a text table.
+ 
  
 * **file:** format/scores.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **format:** Example of the format: <pre><code>2.2531514    FALSE   99990377    99990164
+2.2549822    TRUE    99990101    99990101
+</code></pre>
 * **properties:** None
  
  
@@ -157,10 +180,11 @@ Reads in scores or ground truth from a text table.
 # urlFormat
  
 Reads image files from the web.
+ 
  
 * **file:** format/url.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -169,10 +193,11 @@ Reads image files from the web.
 # videoFormat
  
 Read all frames of a video using OpenCV
+ 
  
 * **file:** format/video.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -181,10 +206,11 @@ Read all frames of a video using OpenCV
 # webcamFormat
  
 Retrieves an image from a webcam.
+ 
  
 * **file:** format/video.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -193,10 +219,11 @@ Retrieves an image from a webcam.
 # xmlFormat
  
 Decodes images from Base64 xml
+ 
  
 * **file:** format/xml.cpp
 * **inherits:** [Format](../cpp_api/format/format.md)
-* **authors:** Scott Klum, Josh Klontz
+* **author(s):** [Scott Klum][sklum], [Josh Klontz][jklontz]
 * **properties:** None
  
  
 # BinaryGallery
  
 An abstract gallery for handling binary data
+ 
  
 * **file:** gallery/binary.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Unknown
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -12,11 +13,12 @@ An abstract gallery for handling binary data
  
 # DefaultGallery
  
-Treats the gallery as a br::Format.
+Treats the gallery as a [Format](../cpp_api/format/format.md).
+ 
  
 * **file:** gallery/default.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -25,22 +27,28 @@ Treats the gallery as a br::Format.
 # EmptyGallery
  
 Reads/writes templates to/from folders.
+ 
  
 * **file:** gallery/empty.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
-* **properties:** None
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:**
  
+	Property | Type | Description
+	--- | --- | ---
+	regexp | QString | An optional regular expression to match against the files extension.
  
 ---
  
 # FDDBGallery
  
 Implements the FDDB detection format.
+ 
  
 * **file:** gallery/fddb.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://vis-www.cs.umass.edu/fddb/README.txt](http://vis-www.cs.umass.edu/fddb/README.txt)
 * **properties:** None
  
  
@@ -49,10 +57,25 @@ Implements the FDDB detection format.
 # arffGallery
  
 Weka ARFF file format.
+ 
  
 * **file:** gallery/arff.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://weka.wikispaces.com/ARFF+%28stable+version%29](http://weka.wikispaces.com/ARFF+%28stable+version%29)
+* **properties:** None
+
+
+---
+
+# aviGallery
+
+Read videos of format .avi
+ 
+
+* **file:** gallery/video.cpp
+* **inherits:** [videoGallery](#videogallery)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -61,10 +84,11 @@ Weka ARFF file format.
 # crawlGallery
  
 Crawl a root location for image files.
+ 
  
 * **file:** gallery/crawl.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -73,11 +97,12 @@ Crawl a root location for image files.
 # csvGallery
  
 Treats each line as a file.
+ 
  
 * **file:** gallery/csv.cpp
 * **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)
-* **see:** [txtGallery](#txtgallery)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **format:** Columns should be comma separated with first row containing headers. The first column in the file should be the path to the file to enroll. Other columns will be treated as file metadata. 
 * **properties:** None
  
  
@@ -86,10 +111,11 @@ Treats each line as a file.
 # dbGallery
  
 Database input.
+ 
  
 * **file:** gallery/db.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -97,11 +123,12 @@ Database input.
  
 # flatGallery
  
-Treats each line as a call to File::flat()
+Treats each line as a call to [File](../cpp_api/file/file.md)::flat()
+ 
  
 * **file:** gallery/flat.cpp
 * **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -111,9 +138,13 @@ Treats each line as a call to File::flat()
  
 A binary gallery.
  
+Designed to be a literal translation of templates to disk.
+Compatible with [TemplateList](../cpp_api/templatelist/templatelist.md)::fromBuffer.
+ 
+
 * **file:** gallery/binary.cpp
 * **inherits:** [BinaryGallery](#binarygallery)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -122,10 +153,11 @@ A binary gallery.
 # googleGallery
  
 Input from a google image search.
+ 
  
 * **file:** gallery/google.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -134,10 +166,11 @@ Input from a google image search.
 # jsonGallery
  
 Newline-separated JSON objects.
+ 
  
 * **file:** gallery/binary.cpp
 * **inherits:** [BinaryGallery](#binarygallery)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -146,10 +179,11 @@ Newline-separated JSON objects.
 # keyframesGallery
  
 Read key frames of a video with LibAV
+ 
  
 * **file:** gallery/keyframes.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Ben Klein
+* **author(s):** [Ben Klein][bhklein]
 * **properties:** None
  
  
@@ -158,10 +192,16 @@ Read key frames of a video with LibAV
 # landmarksGallery
  
 Text format for associating anonymous landmarks with images.
+ 
  
 * **file:** gallery/landmarks.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **format:** The input should be formatted as follows: <pre><code>file_name:x1,y1,x2,y2,...,xn,yn
+file_name:x1,y1,x2,y2,...,xn,yn
+...
+file_name:x1,y1,x2,y2,...,xn,yn
+</code></pre>
 * **properties:** None
  
  
@@ -170,10 +210,12 @@ Text format for associating anonymous landmarks with images.
 # lmatGallery
  
 Likely matrix format
+ 
  
 * **file:** gallery/lmat.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [www.liblikely.org](www.liblikely.org)
 * **properties:** None
  
  
@@ -181,11 +223,12 @@ Likely matrix format
  
 # matrixGallery
  
-Combine all templates into one large matrix and process it as a br::Format
+Combine all [Template](../cpp_api/template/template.md) into one large matrix and process it as a [Format](../cpp_api/format/format.md)
+ 
  
 * **file:** gallery/matrix.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -194,10 +237,11 @@ Combine all templates into one large matrix and process it as a br::Format
 # memGallery
  
 A gallery held in memory.
+ 
  
 * **file:** gallery/mem.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -206,10 +250,11 @@ A gallery held in memory.
 # mp4Gallery
  
 Read key frames of a .mp4 video file with LibAV
+ 
  
 * **file:** gallery/keyframes.cpp
 * **inherits:** [keyframesGallery](#keyframesgallery)
-* **author:** Ben Klein
+* **author(s):** [Ben Klein][bhklein]
 * **properties:** None
  
  
@@ -218,10 +263,24 @@ Read key frames of a .mp4 video file with LibAV
 # postGallery
  
 Handle POST requests
+ 
  
 * **file:** gallery/post.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# seqGallery
+
+DOCUMENT ME
+ 
+
+* **file:** gallery/seq.cpp
+* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -229,11 +288,12 @@ Handle POST requests
  
 # statGallery
  
-Print template statistics.
+Print [Template](../cpp_api/template/template.md) statistics.
+ 
  
 * **file:** gallery/stat.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -241,11 +301,12 @@ Print template statistics.
  
 # templateGallery
  
-Treat the file as a single binary template.
+Treat the file as a single binary [Template](../cpp_api/template/template.md).
+ 
  
 * **file:** gallery/template.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -254,10 +315,11 @@ Treat the file as a single binary template.
 # turkGallery
  
 For Amazon Mechanical Turk datasets
+ 
  
 * **file:** gallery/turk.cpp
 * **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -266,11 +328,20 @@ For Amazon Mechanical Turk datasets
 # txtGallery
  
 Treats each line as a file.
+ 
  
 * **file:** gallery/txt.cpp
 * **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)
-* **see:** [csvGallery](#csvgallery)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **format:** The entire line is treated as the file path. <pre><code>&lt;FILE&gt;
+&lt;FILE&gt;
+...
+&lt;FILE&gt;
+</code></pre>An optional label may be specified using a space ' ' separator: <pre><code>&lt;FILE&gt; &lt;LABEL&gt;
+&lt;FILE&gt; &lt;LABEL&gt;
+...
+&lt;FILE&gt; &lt;LABEL&gt;
+</code></pre>
 * **properties:** None
  
  
@@ -279,10 +350,11 @@ Treats each line as a file.
 # urlGallery
  
 Newline-separated URLs.
+ 
  
 * **file:** gallery/binary.cpp
 * **inherits:** [BinaryGallery](#binarygallery)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -291,10 +363,63 @@ Newline-separated URLs.
 # utGallery
  
 A contiguous array of br_universal_template.
+ 
  
 * **file:** gallery/binary.cpp
 * **inherits:** [BinaryGallery](#binarygallery)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# vbbGallery
+
+DOCUMENT ME
+ 
+
+* **file:** gallery/vbb.cpp
+* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
+* **author(s):** [Unknown][unknown]
+* **properties:** None
+
+
+---
+
+# videoGallery
+
+Read a video frame by frame using cv::VideoCapture
+ 
+
+* **file:** gallery/video.cpp
+* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
+* **author(s):** [Unknown][unknown]
+* **properties:** None
+
+
+---
+
+# webcamGallery
+
+Read a video from the webcam
+ 
+
+* **file:** gallery/video.cpp
+* **inherits:** [videoGallery](#videogallery)
+* **author(s):** [Unknown][unknown]
+* **properties:** None
+
+
+---
+
+# wmvGallery
+
+Read videos of format .wmv
+ 
+
+* **file:** gallery/video.cpp
+* **inherits:** [videoGallery](#videogallery)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -302,11 +427,12 @@ A contiguous array of br_universal_template.
  
 # xmlGallery
  
-A
+A sigset input.
+ 
  
 * **file:** gallery/xml.cpp
 * **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **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/transform/transform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -13,10 +14,11 @@ Load the image named in the specified property, draw it on the current matrix ad
 # DrawDelaunayTransform
  
 Creates a Delaunay triangulation based on a set of points
+ 
  
 * **file:** gui/drawdelaunay.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -25,10 +27,11 @@ Creates a Delaunay triangulation based on a set of points
 # DrawGridLinesTransform
  
 Draws a grid on the image
+ 
  
 * **file:** gui/drawgridlines.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -37,10 +40,11 @@ Draws a grid on the image
 # DrawOpticalFlow
  
 Draw a line representing the direction and magnitude of optical flow at the specified points.
+ 
  
 * **file:** gui/drawopticalflow.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -50,9 +54,12 @@ Draw a line representing the direction and magnitude of optical flow at the spec
  
 Draw the values of a list of properties at the specified point on the image
  
+The inPlace argument controls whether or not the image is cloned before it is drawn on.
+ 
+
 * **file:** gui/drawpropertiespoint.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -62,9 +69,12 @@ Draw the values of a list of properties at the specified point on the image
  
 Draw the value of the specified property at the specified point on the image
  
+The inPlace argument controls whether or not the image is cloned before it is drawn on.
+ 
+
 * **file:** gui/drawpropertypoint.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -73,10 +83,11 @@ Draw the value of the specified property at the specified point on the image
 # DrawSegmentation
  
 Fill in the segmentations or draw a line between intersecting segments.
+ 
  
 * **file:** gui/drawsegmentation.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -86,9 +97,12 @@ Fill in the segmentations or draw a line between intersecting segments.
  
 Renders metadata onto the image.
  
+The inPlace argument controls whether or not the image is cloned before the metadata is drawn.
+ 
+
 * **file:** gui/draw.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -97,10 +111,11 @@ Renders metadata onto the image.
 # ElicitTransform
  
 Elicits metadata for templates in a pretty GUI
+ 
  
 * **file:** gui/show.cpp
 * **inherits:** [ShowTransform](#showtransform)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -109,10 +124,12 @@ Elicits metadata for templates in a pretty GUI
 # FPSCalc
  
 Calculates the average FPS of projects going through this transform, stores the result in AvgFPS
+Reports an average FPS from the initialization of this transform onwards.
+ 
  
 * **file:** gui/show.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -121,10 +138,24 @@ Calculates the average FPS of projects going through this transform, stores the 
 # FPSLimit
  
 Limits the frequency of projects going through this transform to the input targetFPS
+ 
  
 * **file:** gui/show.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
+* **properties:** None
+
+
+---
+
+# FilterTransform
+
+DOCUMENT ME
+ 
+
+* **file:** gui/show.cpp
+* **inherits:** [ShowTransform](#showtransform)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -133,10 +164,13 @@ Limits the frequency of projects going through this transform to the input targe
 # ManualRectsTransform
  
 Manual select rectangular regions on an image.
+Stores marked rectangles as anonymous rectangles, or if a set of labels is provided, prompt the user
+to select one of those labels after drawing each rectangle.
+ 
  
 * **file:** gui/show.cpp
 * **inherits:** [ShowTransform](#showtransform)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -145,10 +179,11 @@ Manual select rectangular regions on an image.
 # ManualTransform
  
 Manual selection of landmark locations
+ 
  
 * **file:** gui/show.cpp
 * **inherits:** [ShowTransform](#showtransform)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -157,10 +192,11 @@ Manual selection of landmark locations
 # ShowTrainingTransform
  
 Show the training data
+ 
  
 * **file:** gui/show.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -170,9 +206,12 @@ Show the training data
  
 Displays templates in a GUI pop-up window using QT.
  
+Can be used with parallelism enabled, although it is considered TimeVarying.
+ 
+
 * **file:** gui/show.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -181,10 +220,11 @@ Displays templates in a GUI pop-up window using QT.
 # SurveyTransform
  
 Display an image, and asks a yes/no question about it
+ 
  
 * **file:** gui/show.cpp
 * **inherits:** [ShowTransform](#showtransform)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
 # AbsDiffTransform
  
 Take the absolute difference of two matrices.
+ 
  
 * **file:** imgproc/absdiff.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -13,10 +14,11 @@ Take the absolute difference of two matrices.
 # AbsTransform
  
 Computes the absolute value of each element.
+ 
  
 * **file:** imgproc/abs.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -25,10 +27,12 @@ Computes the absolute value of each element.
 # AdaptiveThresholdTransform
  
 Wraps OpenCV's adaptive thresholding.
+ 
  
 * **file:** imgproc/adaptivethreshold.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
+* **see:** [http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html](http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html)
 * **properties:** None
  
  
@@ -37,10 +41,11 @@ Wraps OpenCV&#39;s adaptive thresholding.
 # AffineTransform
  
 Performs a two or three point registration.
+ 
  
 * **file:** imgproc/affine.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -49,10 +54,11 @@ Performs a two or three point registration.
 # AndTransform
  
 Logical AND of two matrices.
+ 
  
 * **file:** imgproc/and.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -61,10 +67,11 @@ Logical AND of two matrices.
 # ApplyMaskTransform
  
 Applies a mask from the metadata.
+ 
  
 * **file:** imgproc/applymask.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -73,10 +80,11 @@ Applies a mask from the metadata.
 # BayesianQuantizationTransform
  
 Quantize into a space where L1 distance approximates log-likelihood.
+ 
  
 * **file:** imgproc/bayesianquantization.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -85,10 +93,11 @@ Quantize into a space where L1 distance approximates log-likelihood.
 # BinarizeTransform
  
 Approximate floats as signed bit.
+ 
  
 * **file:** imgproc/binarize.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -97,10 +106,11 @@ Approximate floats as signed bit.
 # BlendTransform
  
 Alpha-blend two matrices
+ 
  
 * **file:** imgproc/blend.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -109,10 +119,11 @@ Alpha-blend two matrices
 # BlurTransform
  
 Gaussian blur
+ 
  
 * **file:** imgproc/blur.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -120,11 +131,12 @@ Gaussian blur
  
 # BuildScalesTransform
  
-Document me
+DOCUMENT ME
+ 
  
 * **file:** imgproc/multiscale.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -133,10 +145,11 @@ Document me
 # ByRowTransform
  
 Turns each row into its own matrix.
+ 
  
 * **file:** imgproc/byrow.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -144,11 +157,13 @@ Turns each row into its own matrix.
  
 # CannyTransform
  
-Warpper to OpenCV Canny edge detector
+Wrapper to OpenCV Canny edge detector
+ 
  
 * **file:** imgproc/canny.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
+* **see:** [http://docs.opencv.org/doc/tutorials/imgproc/imgtrans/canny_detector/canny_detector.html](http://docs.opencv.org/doc/tutorials/imgproc/imgtrans/canny_detector/canny_detector.html)
 * **properties:** None
  
  
@@ -157,10 +172,12 @@ Warpper to OpenCV Canny edge detector
 # CatColsTransform
  
 Concatenates all input matrices by column into a single matrix.
+Use after a fork to concatenate two feature matrices by column.
+ 
  
 * **file:** imgproc/catcols.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -169,10 +186,12 @@ Concatenates all input matrices by column into a single matrix.
 # CatRowsTransform
  
 Concatenates all input matrices by row into a single matrix.
+All matricies must have the same column counts.
+ 
  
 * **file:** imgproc/catrows.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -181,10 +200,11 @@ Concatenates all input matrices by row into a single matrix.
 # CatTransform
  
 Concatenates all input matrices into a single matrix.
+ 
  
 * **file:** imgproc/cat.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -193,10 +213,11 @@ Concatenates all input matrices into a single matrix.
 # CenterTransform
  
 Normalize each dimension based on training data.
+ 
  
 * **file:** imgproc/center.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -204,11 +225,18 @@ Normalize each dimension based on training data.
  
 # ContrastEqTransform
  
-Xiaoyang Tan; Triggs, B.;
+Perform contrast equalization
+ 
  
 * **file:** imgproc/contrasteq.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Xiaoyang Tan; Triggs, B.;*
+	 **"Enhanced Local Texture Feature Sets for Face Recognition Under Difficult Lighting Conditions,"**
+	 Image Processing, IEEE Transactions on , vol.19, no.6, pp.1635-1650, June 2010
+
 * **properties:** None
  
  
@@ -217,10 +245,11 @@ Xiaoyang Tan; Triggs, B.;
 # CropBlackTransform
  
 Crop out black borders
+ 
  
 * **file:** imgproc/cropblack.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -229,10 +258,11 @@ Crop out black borders
 # CropFromMaskTransform
  
 Crops image based on mask metadata
+ 
  
 * **file:** imgproc/cropfrommask.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -241,10 +271,11 @@ Crops image based on mask metadata
 # CropSquareTransform
  
 Trim the image so the width and the height are the same size.
+ 
  
 * **file:** imgproc/cropsquare.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -253,10 +284,11 @@ Trim the image so the width and the height are the same size.
 # CropTransform
  
 Crops about the specified region of interest.
+ 
  
 * **file:** imgproc/crop.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -265,10 +297,12 @@ Crops about the specified region of interest.
 # CryptographicHashTransform
  
 Wraps QCryptographicHash
+ 
  
 * **file:** imgproc/cryptographichash.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://doc.qt.io/qt-5/qcryptographichash.html](http://doc.qt.io/qt-5/qcryptographichash.html)
 * **properties:** None
  
  
@@ -277,10 +311,11 @@ Wraps QCryptographicHash
 # CvtFloatTransform
  
 Convert to floating point format.
+ 
  
 * **file:** imgproc/cvtfloat.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -289,10 +324,11 @@ Convert to floating point format.
 # CvtTransform
  
 Colorspace conversion.
+ 
  
 * **file:** imgproc/cvt.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -301,10 +337,11 @@ Colorspace conversion.
 # CvtUCharTransform
  
 Convert to uchar format
+ 
  
 * **file:** imgproc/cvtuchar.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -313,10 +350,11 @@ Convert to uchar format
 # DiscardAlphaTransform
  
 Drop the alpha channel (if exists).
+ 
  
 * **file:** imgproc/discardalpha.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -324,11 +362,12 @@ Drop the alpha channel (if exists).
  
 # DivTransform
  
-Enforce a multiple of
+Enforce a multiple of n columns.
+ 
  
 * **file:** imgproc/div.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -337,10 +376,11 @@ Enforce a multiple of
 # DoGTransform
  
 Difference of gaussians
+ 
  
 * **file:** imgproc/dog.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -349,10 +389,11 @@ Difference of gaussians
 # DownsampleTransform
  
 Downsample the rows and columns of a matrix.
+ 
  
 * **file:** imgproc/downsample.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Lacey Best-Rowden
+* **author(s):** [Lacey Best-Rowden][lbestrowden]
 * **properties:** None
  
  
@@ -360,11 +401,12 @@ Downsample the rows and columns of a matrix.
  
 # DupTransform
  
-Duplicates the template data.
+Duplicates the [Template](../cpp_api/template/template.md) data.
+ 
  
 * **file:** imgproc/dup.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -373,10 +415,11 @@ Duplicates the template data.
 # EnsureChannelsTransform
  
 Enforce the matrix has a certain number of channels by adding or removing channels.
+ 
  
 * **file:** imgproc/ensurechannels.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -385,10 +428,11 @@ Enforce the matrix has a certain number of channels by adding or removing channe
 # EqualizeHistTransform
  
 Histogram equalization
+ 
  
 * **file:** imgproc/equalizehist.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -397,10 +441,11 @@ Histogram equalization
 # FlipTransform
  
 Flips the image about an axis.
+ 
  
 * **file:** imgproc/flip.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -409,10 +454,11 @@ Flips the image about an axis.
 # FloodTransform
  
 Fill black pixels with the specified color.
+ 
  
 * **file:** imgproc/flood.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -421,10 +467,11 @@ Fill black pixels with the specified color.
 # GaborJetTransform
  
 A vector of gabor wavelets applied at a point.
+ 
  
 * **file:** imgproc/gabor.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -432,11 +479,13 @@ A vector of gabor wavelets applied at a point.
  
 # GaborTransform
  
-http://en.wikipedia.org/wiki/Gabor_filter
+Implements a Gabor Filter
+ 
  
 * **file:** imgproc/gabor.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://en.wikipedia.org/wiki/Gabor_filter](http://en.wikipedia.org/wiki/Gabor_filter)
 * **properties:** None
  
  
@@ -445,10 +494,11 @@ http://en.wikipedia.org/wiki/Gabor_filter
 # GammaTransform
  
 Gamma correction
+ 
  
 * **file:** imgproc/gamma.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -457,10 +507,11 @@ Gamma correction
 # GradientMaskTransform
  
 Masks image according to pixel change.
+ 
  
 * **file:** imgproc/gradientmask.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -469,10 +520,11 @@ Masks image according to pixel change.
 # GradientTransform
  
 Computes magnitude and/or angle of image.
+ 
  
 * **file:** imgproc/gradient.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -482,9 +534,25 @@ Computes magnitude and/or angle of image.
  
 Group all input matrices into a single matrix.
  
+Similar to CatTransfrom but groups every _size_ adjacent matricies.
+ 
+
 * **file:** imgproc/group.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# HeatmapTransform
+
+DOCUMENT ME
+ 
+
+* **file:** imgproc/heatmap.cpp
+* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -493,10 +561,11 @@ Group all input matrices into a single matrix.
 # HistBinTransform
  
 Quantizes the values into bins.
+ 
  
 * **file:** imgproc/histbin.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -505,10 +574,11 @@ Quantizes the values into bins.
 # HistEqQuantizationTransform
  
 Approximate floats as uchar with different scalings for each dimension.
+ 
  
 * **file:** imgproc/histeqquantization.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -517,10 +587,11 @@ Approximate floats as uchar with different scalings for each dimension.
 # HistTransform
  
 Histograms the matrix
+ 
  
 * **file:** imgproc/hist.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -529,10 +600,12 @@ Histograms the matrix
 # HoGDescriptorTransform
  
 OpenCV HOGDescriptor wrapper
+ 
  
 * **file:** imgproc/hog.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
+* **see:** [http://docs.opencv.org/modules/gpu/doc/object_detection.html](http://docs.opencv.org/modules/gpu/doc/object_detection.html)
 * **properties:** None
  
  
@@ -541,10 +614,12 @@ OpenCV HOGDescriptor wrapper
 # InpaintTransform
  
 Wraps OpenCV inpainting
+ 
  
 * **file:** imgproc/inpaint.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://docs.opencv.org/modules/photo/doc/inpainting.html](http://docs.opencv.org/modules/photo/doc/inpainting.html)
 * **properties:** None
  
  
@@ -553,10 +628,11 @@ Wraps OpenCV inpainting
 # IntegralHistTransform
  
 An integral histogram
+ 
  
 * **file:** imgproc/integralhist.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -565,10 +641,11 @@ An integral histogram
 # IntegralSamplerTransform
  
 Sliding window feature extraction from a multi-channel integral image.
+ 
  
 * **file:** imgproc/integralsampler.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -577,10 +654,12 @@ Sliding window feature extraction from a multi-channel integral image.
 # IntegralSlidingWindowTransform
  
 Overloads SlidingWindowTransform for integral images that should be
+sampled at multiple scales.
+ 
  
 * **file:** imgproc/slidingwindow.cpp
 * **inherits:** [SlidingWindowTransform](#slidingwindowtransform)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -589,10 +668,11 @@ Overloads SlidingWindowTransform for integral images that should be
 # IntegralTransform
  
 Computes integral image.
+ 
  
 * **file:** imgproc/integral.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -601,10 +681,11 @@ Computes integral image.
 # KernelHashTransform
  
 Kernel hash
+ 
  
 * **file:** imgproc/kernelhash.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -613,10 +694,12 @@ Kernel hash
 # KeyPointDescriptorTransform
  
 Wraps OpenCV Key Point Descriptor
+ 
  
 * **file:** imgproc/keypointdescriptor.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://docs.opencv.org/modules/features2d/doc/common_interfaces_of_feature_detectors.html](http://docs.opencv.org/modules/features2d/doc/common_interfaces_of_feature_detectors.html)
 * **properties:** None
  
  
@@ -624,11 +707,18 @@ Wraps OpenCV Key Point Descriptor
  
 # LBPTransform
  
-Ahonen, T.; Hadid, A.; Pietikainen, M.;
+Convert the image into a feature vector using Local Binary Patterns
+ 
  
 * **file:** imgproc/lbp.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Ahonen, T.; Hadid, A.; Pietikainen, M.;*
+	 **"Face Description with Local Binary Patterns: Application to Face Recognition"**
+	 Pattern Analysis and Machine Intelligence, IEEE Transactions, vol.28, no.12, pp.2037-2041, Dec. 2006
+
 * **properties:** None
  
  
@@ -636,11 +726,18 @@ Ahonen, T.; Hadid, A.; Pietikainen, M.;
  
 # 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.
+DOCUMENT ME
+ 
  
 * **file:** imgproc/ltp.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **authors:** Brendan Klare, Josh Klontz
+* **author(s):** [Brendan Klare][bklare], [Josh Klontz][jklontz]
+* **read:**
+
+	1. *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.
+
 * **properties:** None
  
  
@@ -649,10 +746,11 @@ Tan, Xiaoyang, and Bill Triggs. &quot;Enhanced local texture feature sets for face re
 # LargestConvexAreaTransform
  
 Set the template's label to the area of the largest convex hull.
+ 
  
 * **file:** imgproc/largestconvexarea.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -661,10 +759,11 @@ Set the template&#39;s label to the area of the largest convex hull.
 # LimitSizeTransform
  
 Limit the size of the template
+ 
  
 * **file:** imgproc/limitsize.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -672,11 +771,12 @@ Limit the size of the template
  
 # MAddTransform
  
-dst = a*src+b
+dst = a src+b
+ 
  
 * **file:** imgproc/madd.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -685,10 +785,11 @@ dst = a*src+b
 # MaskTransform
  
 Applies an eliptical mask
+ 
  
 * **file:** imgproc/mask.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -697,10 +798,11 @@ Applies an eliptical mask
 # MatStatsTransform
  
 Statistics
+ 
  
 * **file:** imgproc/matstats.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -709,10 +811,11 @@ Statistics
 # MeanFillTransform
  
 Fill 0 pixels with the mean of non-0 pixels.
+ 
  
 * **file:** imgproc/meanfill.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -722,9 +825,12 @@ Fill 0 pixels with the mean of non-0 pixels.
  
 Computes the mean of a set of templates.
  
+Suitable for visualization only as it sets every projected template to the mean template.
+ 
+
 * **file:** imgproc/mean.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -733,10 +839,12 @@ Computes the mean of a set of templates.
 # MergeTransform
  
 Wraps OpenCV merge
+ 
  
 * **file:** imgproc/merge.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://docs.opencv.org/modules/core/doc/operations_on_arrays.html#merge](http://docs.opencv.org/modules/core/doc/operations_on_arrays.html#merge)
 * **properties:** None
  
  
@@ -745,10 +853,11 @@ Wraps OpenCV merge
 # MorphTransform
  
 Morphological operator
+ 
  
 * **file:** imgproc/morph.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -757,10 +866,12 @@ Morphological operator
 # NLMeansDenoisingTransform
  
 Wraps OpenCV Non-Local Means Denoising
+ 
  
 * **file:** imgproc/denoising.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://docs.opencv.org/modules/photo/doc/denoising.html](http://docs.opencv.org/modules/photo/doc/denoising.html)
 * **properties:** None
  
  
@@ -769,29 +880,31 @@ Wraps OpenCV Non-Local Means Denoising
 # NormalizeTransform
  
 Normalize matrix to unit length
+ 
  
 * **file:** imgproc/normalize.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:**
  
-Property | Type | Description
---- | --- | ---
-NormType | enum | Values are NORM_INF, NORM_L1, NORM_L2, NORM_MINMAX
-ByRow | bool | If true normalize each row independently otherwise normalize the entire matrix.
-alpha | int | Lower bound if using NORM_MINMAX. Value to normalize to otherwise.
-beta | int | Upper bound if using NORM_MINMAX. Not used otherwise.
-squareRoot | bool | If true compute the signed square root of the output after normalization.
+	Property | Type | Description
+	--- | --- | ---
+	NormType | enum | Values are:<ul><li>NORM_INF</li><li>NORM_L1</li><li>NORM_L2</li><li>NORM_MINMAX</li></ul>
+	ByRow | bool | If true normalize each row independently otherwise normalize the entire matrix.
+	alpha | int | Lower bound if using NORM_MINMAX. Value to normalize to otherwise.
+	beta | int | Upper bound if using NORM_MINMAX. Not used otherwise.
+	squareRoot | bool | 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/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** E. Taborsky
+* **author(s):** [E. Taborsky][mmtaborsky]
 * **properties:** None
  
  
@@ -800,10 +913,11 @@ Prediction with magic numbers from jmp; must get input as blue;green;red
 # PackTransform
  
 Compress two uchar into one uchar.
+ 
  
 * **file:** imgproc/pack.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -812,10 +926,11 @@ Compress two uchar into one uchar.
 # PowTransform
  
 Raise each element to the specified power.
+ 
  
 * **file:** imgproc/pow.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -824,10 +939,17 @@ Raise each element to the specified power.
 # ProductQuantizationDistance
  
 Distance in a product quantized space
+ 
  
 * **file:** imgproc/productquantization.cpp
 * **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Jegou, Herve, Matthijs Douze, and Cordelia Schmid.*
+	 **"Product quantization for nearest neighbor search."**
+	 Pattern Analysis and Machine Intelligence, IEEE Transactions on 33.1 (2011): 117-128
+
 * **properties:** None
  
  
@@ -836,10 +958,17 @@ Distance in a product quantized space
 # ProductQuantizationTransform
  
 Product quantization
+ 
  
 * **file:** imgproc/productquantization.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Jegou, Herve, Matthijs Douze, and Cordelia Schmid.*
+	 **"Product quantization for nearest neighbor search."**
+	 Pattern Analysis and Machine Intelligence, IEEE Transactions on 33.1 (2011): 117-128
+
 * **properties:** None
  
  
@@ -848,10 +977,11 @@ Product quantization
 # QuantizeTransform
  
 Approximate floats as uchar.
+ 
  
 * **file:** imgproc/quantize.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -860,10 +990,11 @@ Approximate floats as uchar.
 # RGTransform
  
 Normalized RG color space.
+ 
  
 * **file:** imgproc/rg.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -872,10 +1003,11 @@ Normalized RG color space.
 # ROIFromPtsTransform
  
 Crops the rectangular regions of interest from given points and sizes.
+ 
  
 * **file:** imgproc/roifrompoints.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -884,10 +1016,11 @@ Crops the rectangular regions of interest from given points and sizes.
 # ROITransform
  
 Crops the rectangular regions of interest.
+ 
  
 * **file:** imgproc/roi.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -896,10 +1029,11 @@ Crops the rectangular regions of interest.
 # RankTransform
  
 Converts each element to its rank-ordered value.
+ 
  
 * **file:** imgproc/rank.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -908,10 +1042,11 @@ Converts each element to its rank-ordered value.
 # RectRegionsTransform
  
 Subdivide matrix into rectangular subregions.
+ 
  
 * **file:** imgproc/rectregions.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -919,11 +1054,12 @@ Subdivide matrix into rectangular subregions.
  
 # RecursiveIntegralSamplerTransform
  
-Construct template in a recursive decent manner.
+Construct [Template](../cpp_api/template/template.md) in a recursive decent manner.
+ 
  
 * **file:** imgproc/recursiveintegralsampler.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -932,10 +1068,11 @@ Construct template in a recursive decent manner.
 # RedLinearRegressionTransform
  
 Prediction using only the red wavelength; magic numbers from jmp
+ 
  
 * **file:** imgproc/redlinearregression.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** E. Taborsky
+* **author(s):** [E. Taborsky][mmtaborsky]
 * **properties:** None
  
  
@@ -943,11 +1080,12 @@ Prediction using only the red wavelength; magic numbers from jmp
  
 # ReshapeTransform
  
-Reshape the each matrix to the specified number of rows.
+Reshape each matrix to the specified number of rows.
+ 
  
 * **file:** imgproc/reshape.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -956,22 +1094,31 @@ Reshape the each matrix to the specified number of rows.
 # ResizeTransform
  
 Resize the template
+ 
  
 * **file:** imgproc/resize.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
-* **properties:** None
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:**
  
+	Property | Type | Description
+	--- | --- | ---
+	method | enum | Resize method. Good options are:<ul><li>Area should be used for shrinking an image</li><li>Cubic for slow but accurate enlargment</li><li>Bilin for fast enlargement</li></ul>
+	preserveAspect | bool | If true, the image will be sized per specification, but a border will be applied to preserve aspect ratio.
  
 ---
  
 # RevertAffineTransform
  
 Designed for use after eye detection + Stasm, this will
+revert the detected landmarks to the original coordinate space
+before affine alignment to the stasm mean shape. The storeAffine
+parameter must be set to true when calling AffineTransform before this.
+ 
  
 * **file:** imgproc/revertaffine.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -980,10 +1127,11 @@ Designed for use after eye detection + Stasm, this will
 # RndPointTransform
  
 Generates a random landmark.
+ 
  
 * **file:** imgproc/rndpoint.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -992,10 +1140,11 @@ Generates a random landmark.
 # RndRegionTransform
  
 Selects a random region.
+ 
  
 * **file:** imgproc/rndregion.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -1004,10 +1153,11 @@ Selects a random region.
 # RndRotateTransform
  
 Randomly rotates an image in a specified range.
+ 
  
 * **file:** imgproc/rndrotate.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -1016,10 +1166,11 @@ Randomly rotates an image in a specified range.
 # RndSubspaceTransform
  
 Generates a random subspace.
+ 
  
 * **file:** imgproc/rndsubspace.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -1027,11 +1178,18 @@ Generates a random subspace.
  
 # RootNormTransform
  
-dst=sqrt(norm_L1(src)) proposed as RootSIFT in
+dst=sqrt(norm_L1(src)) proposed as RootSIFT (see paper)
+ 
  
 * **file:** imgproc/rootnorm.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Arandjelovic, Relja, and Andrew Zisserman.*
+	 **"Three things everyone should know to improve object retrieval."**
+	 Computer Vision and Pattern Recognition (CVPR), 2012 IEEE Conference on. IEEE, 2012.
+
 * **properties:** None
  
  
@@ -1040,10 +1198,11 @@ dst=sqrt(norm_L1(src)) proposed as RootSIFT in
 # RowWiseMeanCenterTransform
  
 Remove the row-wise training set average.
+ 
  
 * **file:** imgproc/rowwisemeancenter.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -1052,10 +1211,12 @@ Remove the row-wise training set average.
 # SIFTDescriptorTransform
  
 Specialize wrapper OpenCV SIFT wrapper
+ 
  
 * **file:** imgproc/sift.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://docs.opencv.org/modules/nonfree/doc/feature_detection.html](http://docs.opencv.org/modules/nonfree/doc/feature_detection.html)
 * **properties:** None
  
  
@@ -1064,10 +1225,11 @@ Specialize wrapper OpenCV SIFT wrapper
 # SampleFromMaskTransform
  
 Samples pixels from a mask.
+ 
  
 * **file:** imgproc/samplefrommask.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -1076,10 +1238,11 @@ Samples pixels from a mask.
 # ScaleTransform
  
 Scales using the given factor
+ 
  
 * **file:** imgproc/scale.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -1087,11 +1250,13 @@ Scales using the given factor
  
 # SkinMaskTransform
  
-http://worldofcameras.wordpress.com/tag/skin-detection-opencv/
+Make a mask over skin in an image
+ 
  
 * **file:** imgproc/skinmask.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://worldofcameras.wordpress.com/tag/skin-detection-opencv/](http://worldofcameras.wordpress.com/tag/skin-detection-opencv/)
 * **properties:** None
  
  
@@ -1100,10 +1265,12 @@ http://worldofcameras.wordpress.com/tag/skin-detection-opencv/
 # SlidingWindowTransform
  
 Applies a transform to a sliding window.
+Discards negative detections.
+ 
  
 * **file:** imgproc/slidingwindow.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -1112,10 +1279,11 @@ Applies a transform to a sliding window.
 # SplitChannelsTransform
  
 Split a multi-channel matrix into several single-channel matrices.
+ 
  
 * **file:** imgproc/splitchannels.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -1124,10 +1292,11 @@ Split a multi-channel matrix into several single-channel matrices.
 # SubdivideTransform
  
 Divide the matrix into 4 smaller matricies of equal size.
+ 
  
 * **file:** imgproc/subdivide.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -1136,10 +1305,11 @@ Divide the matrix into 4 smaller matricies of equal size.
 # SubtractTransform
  
 Subtract two matrices.
+ 
  
 * **file:** imgproc/subtract.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -1148,10 +1318,25 @@ Subtract two matrices.
 # ThresholdTransform
  
 Wraps OpenCV's adaptive thresholding.
+ 
  
 * **file:** imgproc/threshold.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
+* **see:** [http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html](http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html)
+* **properties:** None
+
+
+---
+
+# TransposeTransform
+
+Get the transpose of the [Template](../cpp_api/template/template.md) matrix
+ 
+
+* **file:** imgproc/transpose.cpp
+* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -1160,10 +1345,11 @@ Wraps OpenCV&#39;s adaptive thresholding.
 # WatershedSegmentationTransform
  
 Applies watershed segmentation.
+ 
  
 * **file:** imgproc/watershedsegmentation.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
 # DecodeTransform
  
 Decodes images
+ 
  
 * **file:** io/decode.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -13,10 +14,24 @@ Decodes images
 # DownloadTransform
  
 Downloads an image from a URL
+ 
  
 * **file:** io/download.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# GalleryOutputTransform
+
+DOCUMENT ME
+ 
+
+* **file:** io/galleryoutput.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
+* **author(s):** [Unknown][unknown]
 * **properties:** None
  
  
@@ -26,9 +41,16 @@ Downloads an image from a URL
  
 Incrementally output templates received to a gallery, based on the current filename
  
+When a template is received in projectUpdate for the first time since a finalize, open a new gallery based on the
+template's filename, and the galleryFormat property.
+
+[Template](../cpp_api/template/template.md) received in projectUpdate will be output to the gallery with a filename combining their original filename and
+their FrameNumber property, with the file extension specified by the fileFormat property.
+ 
+
 * **file:** io/incrementaloutput.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -36,11 +58,25 @@ Incrementally output templates received to a gallery, based on the current filen
  
 # OpenTransform
  
-Applies br::Format to br::Template::file::name and appends results.
+Applies [Format](../cpp_api/format/format.md) to [Template](../cpp_api/template/template.md) filename and appends results.
+ 
  
 * **file:** io/open.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# OutputTransform
+
+DOCUMENT ME
+ 
+
+* **file:** io/out.cpp
+* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
+* **author(s):** [Unknown][Unknown]
 * **properties:** None
  
  
@@ -48,11 +84,12 @@ Applies br::Format to br::Template::file::name and appends results.
  
 # PrintTransform
  
-Prints the template's file to stdout or stderr.
+Prints the file of the input [Template](../cpp_api/template/template.md) to stdout or stderr.
+ 
  
 * **file:** io/print.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -60,11 +97,16 @@ Prints the template&#39;s file to stdout or stderr.
  
 # ReadLandmarksTransform
  
-Read landmarks from a file and associate them with the correct templates.
+Read landmarks from a file and associate them with the correct [Template](../cpp_api/template/template.md).
+ 
  
 * **file:** io/readlandmarks.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
+* **format:** Example of the format: <pre><code>image_001.jpg:146.000000,190.000000,227.000000,186.000000,202.000000,256.000000
+image_002.jpg:75.000000,235.000000,140.000000,225.000000,91.000000,300.000000
+image_003.jpg:158.000000,186.000000,246.000000,188.000000,208.000000,233.000000
+</code></pre>
 * **properties:** None
  
  
@@ -73,10 +115,11 @@ Read landmarks from a file and associate them with the correct templates.
 # ReadTransform
  
 Read images
+ 
  
 * **file:** io/read.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -85,10 +128,11 @@ Read images
 # WriteTransform
  
 Write all mats to disk as images.
+ 
  
 * **file:** io/write.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -97,10 +141,17 @@ Write all mats to disk as images.
 # YouTubeFacesDBTransform
  
 Implements the YouTubesFaceDB
+ 
  
 * **file:** io/youtubefacesdb.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Wolf, Lior, Tal Hassner, and Itay Maoz.*
+	 **"Face recognition in unconstrained videos with matched background similarity."**
+	 Computer Vision and Pattern Recognition (CVPR), 2011 IEEE Conference on. IEEE, 2011.
+
 * **properties:** None
  
  
 # ASEFEyesTransform
  
-Bolme, D.S.; Draper, B.A.; Beveridge, J.R.;
+Find eye locations using an ASEF filter
+ 
  
 * **file:** metadata/eyes.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **authors:** David Bolme, Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **read:**
+
+	1. *Bolme, D.S.; Draper, B.A.; Beveridge, J.R.;*
+	 **"Average of Synthetic Exact Filters,"**
+	 Computer Vision and Pattern Recognition, 2009. CVPR 2009. IEEE Conference on , vol., no., pp.2105-2112, 20-25 June 2009
+
 * **properties:** None
  
  
@@ -13,10 +20,11 @@ Bolme, D.S.; Draper, B.A.; Beveridge, J.R.;
 # AnonymizeLandmarksTransform
  
 Remove a name from a point/rect
+ 
  
 * **file:** metadata/anonymizelandmarks.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -24,11 +32,12 @@ Remove a name from a point/rect
  
 # AsTransform
  
-Change the br::Template::file extension
+Change the [Template](../cpp_api/template/template.md) file extension
+ 
  
 * **file:** metadata/as.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -37,10 +46,11 @@ Change the br::Template::file extension
 # AveragePointsTransform
  
 Averages a set of landmarks into a new landmark
+ 
  
 * **file:** metadata/averagepoints.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -49,10 +59,12 @@ Averages a set of landmarks into a new landmark
 # CascadeTransform
  
 Wraps OpenCV cascade classifier
+ 
  
 * **file:** metadata/cascade.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **authors:** Josh Klontz, David Crouse
+* **author(s):** [Josh Klontz][jklontz], [David Crouse][dgcrouse]
+* **see:** [http://docs.opencv.org/modules/objdetect/doc/cascade_classification.html](http://docs.opencv.org/modules/objdetect/doc/cascade_classification.html)
 * **properties:** None
  
  
@@ -60,11 +72,12 @@ Wraps OpenCV cascade classifier
  
 # CheckTransform
  
-Checks the template for NaN values.
+Checks the [Template](../cpp_api/template/template.md) for NaN values.
+ 
  
 * **file:** metadata/check.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -72,11 +85,12 @@ Checks the template for NaN values.
  
 # ClearPointsTransform
  
-Clears the points from a template
+Clears the points from a [Template](../cpp_api/template/template.md)
+ 
  
 * **file:** metadata/clearpoints.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -85,10 +99,11 @@ Clears the points from a template
 # ConsolidateDetectionsTransform
  
 Consolidate redundant/overlapping detections.
+ 
  
 * **file:** metadata/consolidatedetections.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -96,11 +111,12 @@ Consolidate redundant/overlapping detections.
  
 # CropRectTransform
  
-Crops the width and height of a template's rects by input width and height factors.
+Crops the width and height of a [Template](../cpp_api/template/template.md) rects by input width and height factors.
+ 
  
 * **file:** metadata/croprect.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -109,10 +125,11 @@ Crops the width and height of a template&#39;s rects by input width and height facto
 # DelaunayTransform
  
 Creates a Delaunay triangulation based on a set of points
+ 
  
 * **file:** metadata/delaunay.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -120,11 +137,12 @@ Creates a Delaunay triangulation based on a set of points
  
 # ExpandRectTransform
  
-Expand the width and height of a template's rects by input width and height factors.
+Expand the width and height of a [Template](../cpp_api/template/template.md) rects by input width and height factors.
+ 
  
 * **file:** metadata/expandrect.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -133,10 +151,41 @@ Expand the width and height of a template&#39;s rects by input width and height fact
 # ExtractMetadataTransform
  
 Create matrix from metadata values.
+ 
  
 * **file:** metadata/extractmetadata.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **properties:** None
+
+
+---
+
+# FaceFromEyesTransform
+
+Create face bounding box from two eye locations.
+ 
+
+* **file:** metadata/facefromeyes.cpp
+* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
+* **author(s):** [Brendan Klare][bklare]
+* **properties:**
+
+	Property | Type | Description
+	--- | --- | ---
+	widthPadding | double | Specifies what percentage of the interpupliary distance (ipd) will be padded in both horizontal directions.
+	verticalLocation | double | specifies where vertically the eyes are within the bounding box (0.5 would be the center).
+
+---
+
+# FileExclusionTransform
+
+DOCUMENT ME
+ 
+
+* **file:** metadata/fileexclusion.cpp
+* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
+* **author(s):** [Unknown][Unknown]
 * **properties:** None
  
  
@@ -144,11 +193,12 @@ Create matrix from metadata values.
  
 # FilterDupeMetadataTransform
  
-Removes duplicate templates based on a unique metadata key
+Removes duplicate [Template](../cpp_api/template/template.md) based on a unique metadata key
+ 
  
 * **file:** metadata/filterdupemetadata.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
@@ -156,11 +206,12 @@ Removes duplicate templates based on a unique metadata key
  
 # GridTransform
  
-Add landmarks to the template in a grid layout
+Add landmarks to the [Template](../cpp_api/template/template.md) in a grid layout
+ 
  
 * **file:** metadata/grid.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -168,11 +219,12 @@ Add landmarks to the template in a grid layout
  
 # GroundTruthTransform
  
-Add any ground truth to the template using the file's base name.
+Add any ground truth to the [Template](../cpp_api/template/template.md) using the file's base name.
+ 
  
 * **file:** metadata/groundtruth.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -181,10 +233,12 @@ Add any ground truth to the template using the file&#39;s base name.
 # HOGPersonDetectorTransform
  
 Detects objects with OpenCV's built-in HOG detection.
+ 
  
 * **file:** metadata/hogpersondetector.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
+* **see:** [http://docs.opencv.org/modules/gpu/doc/object_detection.html](http://docs.opencv.org/modules/gpu/doc/object_detection.html)
 * **properties:** None
  
  
@@ -192,11 +246,12 @@ Detects objects with OpenCV&#39;s built-in HOG detection.
  
 # IfMetadataTransform
  
-Clear templates without the required metadata.
+Clear [Template](../cpp_api/template/template.md) without the required metadata.
+ 
  
 * **file:** metadata/ifmetadata.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -205,10 +260,11 @@ Clear templates without the required metadata.
 # ImpostorUniquenessMeasureTransform
  
 Impostor Uniqueness Measure
+ 
  
 * **file:** metadata/imposteruniquenessmeasure.cpp
 * **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -217,10 +273,11 @@ Impostor Uniqueness Measure
 # JSONTransform
  
 Represent the metadata as JSON template data.
+ 
  
 * **file:** metadata/json.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -229,10 +286,11 @@ Represent the metadata as JSON template data.
 # KeepMetadataTransform
  
 Retains only the values for the keys listed, to reduce template size
+ 
  
 * **file:** metadata/keepmetadata.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -241,10 +299,12 @@ Retains only the values for the keys listed, to reduce template size
 # KeyPointDetectorTransform
  
 Wraps OpenCV Key Point Detector
+ 
  
 * **file:** metadata/keypointdetector.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
+* **see:** [http://docs.opencv.org/modules/features2d/doc/common_interfaces_of_feature_detectors.html](http://docs.opencv.org/modules/features2d/doc/common_interfaces_of_feature_detectors.html)
 * **properties:** None
  
  
@@ -253,10 +313,11 @@ Wraps OpenCV Key Point Detector
 # KeyToRectTransform
  
 Convert values of key_X, key_Y, key_Width, key_Height to a rect.
+ 
  
 * **file:** metadata/keytorect.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Jordan Cheney
+* **author(s):** [Jordan Cheney][JordanCheney]
 * **properties:** None
  
  
@@ -265,10 +326,11 @@ Convert values of key_X, key_Y, key_Width, key_Height to a rect.
 # NameLandmarksTransform
  
 Name a point/rect
+ 
  
 * **file:** metadata/namelandmarks.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -276,11 +338,12 @@ Name a point/rect
  
 # NameTransform
  
-Sets the template's matrix data to the br::File::name.
+Sets the [Template](../cpp_api/template/template.md) matrix data to the br::File::name.
+ 
  
 * **file:** metadata/name.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -289,10 +352,11 @@ Sets the template&#39;s matrix data to the br::File::name.
 # NormalizePointsTransform
  
 Normalize points to be relative to a single point
+ 
  
 * **file:** metadata/normalizepoints.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -301,10 +365,11 @@ Normalize points to be relative to a single point
 # PointDisplacementTransform
  
 Normalize points to be relative to a single point
+ 
  
 * **file:** metadata/pointdisplacement.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -313,10 +378,11 @@ Normalize points to be relative to a single point
 # 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/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -325,10 +391,11 @@ Converts either the file::points() list or a QList&lt;QPointF&gt; metadata item to be 
 # ProcrustesTransform
  
 Procrustes alignment of points
+ 
  
 * **file:** metadata/procrustes.cpp
 * **inherits:** [MetadataTransform](../cpp_api/metadatatransform/metadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -336,11 +403,12 @@ Procrustes alignment of points
  
 # RectsToTemplatesTransform
  
-For each rectangle bounding box in src, a new
+For each rectangle bounding box in src, a new [Template](../cpp_api/template/template.md) is created.
+ 
  
 * **file:** metadata/rectstotemplates.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -349,10 +417,11 @@ For each rectangle bounding box in src, a new
 # 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/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -360,11 +429,12 @@ Apply the input regular expression to the value of inputProperty, store the matc
  
 # RemoveMetadataTransform
  
-Removes a metadata field from all templates
+Removes a metadata field from all [Template](../cpp_api/template/template.md)
+ 
  
 * **file:** metadata/removemetadata.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -372,11 +442,12 @@ Removes a metadata field from all templates
  
 # RemoveTemplatesTransform
  
-Remove templates with the specified file extension or metadata value.
+Remove [Template](../cpp_api/template/template.md) with the specified file extension or metadata value.
+ 
  
 * **file:** metadata/removetemplates.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -385,10 +456,11 @@ Remove templates with the specified file extension or metadata value.
 # RenameFirstTransform
  
 Rename first found metadata key
+ 
  
 * **file:** metadata/renamefirst.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -397,10 +469,11 @@ Rename first found metadata key
 # RenameTransform
  
 Rename metadata key
+ 
  
 * **file:** metadata/rename.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -409,10 +482,12 @@ Rename metadata key
 # ReorderPointsTransform
  
 Reorder the points such that points[from[i]] becomes points[to[i]] and
+vice versa
+ 
  
 * **file:** metadata/reorderpoints.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -420,11 +495,14 @@ Reorder the points such that points[from[i]] becomes points[to[i]] and
  
 # RestoreMatTransform
  
-Set the last matrix of the input template to a matrix stored as metadata with input propName.
+Set the last matrix of the input [Template](../cpp_api/template/template.md) to a matrix stored as metadata with input propName.
+
+Also removes the property from the [Template](../cpp_api/template/template.md)s metadata after restoring it.
+ 
  
 * **file:** metadata/restoremat.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -432,11 +510,12 @@ Set the last matrix of the input template to a matrix stored as metadata with in
  
 # SaveMatTransform
  
-Store the last matrix of the input template as a metadata key with input property name.
+Store the last matrix of the input [Template](../cpp_api/template/template.md) as a metadata key with input property name.
+ 
  
 * **file:** metadata/savemat.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -445,10 +524,11 @@ Store the last matrix of the input template as a metadata key with input propert
 # SelectPointsTransform
  
 Retains only landmarks/points at the provided indices
+ 
  
 * **file:** metadata/selectpoints.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Brendan Klare
+* **author(s):** [Brendan Klare][bklare]
 * **properties:** None
  
  
@@ -457,10 +537,11 @@ Retains only landmarks/points at the provided indices
 # SetMetadataTransform
  
 Sets the metadata key/value pair.
+ 
  
 * **file:** metadata/setmetadata.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -469,10 +550,11 @@ Sets the metadata key/value pair.
 # SetPointsInRectTransform
  
 Set points relative to a rect
+ 
  
 * **file:** metadata/setpointsinrect.cpp
 * **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author:** Jordan Cheney
+* **author(s):** [Jordan Cheney][JordanCheney]
 * **properties:** None
  
  
@@ -481,10 +563,11 @@ Set points relative to a rect
 # StasmTransform
  
 Wraps STASM key point detector
+ 
  
 * **file:** metadata/stasm4.cpp
 * **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -492,11 +575,12 @@ Wraps STASM key point detector
  
 # StopWatchTransform
  
-Gives time elapsed over a specified transform as a function of both images (or frames) and pixels.
+Gives time elapsed over a specified [Transform](../cpp_api/transform/transform.md) as a function of both images (or frames) and pixels.
+ 
  
 * **file:** metadata/stopwatch.cpp
 * **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **authors:** Jordan Cheney, Josh Klontz
+* **author(s):** [Jordan Cheney][JordanCheney], [Josh Klontz][jklontz]
 * **properties:** None
  
  
 # DefaultOutput
  
-Adaptor class -- write a matrix output using Format classes.
+Adaptor class -- write a matrix output using [Format](../cpp_api/format/format.md) classes.
+ 
  
 * **file:** output/default.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author:** Charles Otto
+* **author(s):** [Charles Otto][caotto]
 * **properties:** None
  
  
@@ -13,10 +14,11 @@ Adaptor class -- write a matrix output using Format classes.
 # EmptyOutput
  
 Output to the terminal.
+ 
  
 * **file:** output/empty.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -25,10 +27,11 @@ Output to the terminal.
 # bestOutput
  
 The highest scoring matches.
+ 
  
 * **file:** output/best.cpp
 * **inherits:** [Output](../cpp_api/output/output.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -37,10 +40,11 @@ The highest scoring matches.
 # csvOutput
  
 Comma separated values output.
+ 
  
 * **file:** output/csv.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -49,10 +53,11 @@ Comma separated values output.
 # evalOutput
  
 Evaluate the output matrix.
+ 
  
 * **file:** output/eval.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -61,10 +66,11 @@ Evaluate the output matrix.
 # heatOutput
  
 Matrix-like output for heat maps.
+ 
  
 * **file:** output/heat.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -73,10 +79,11 @@ Matrix-like output for heat maps.
 # histOutput
  
 Score histogram.
+ 
  
 * **file:** output/hist.cpp
 * **inherits:** [Output](../cpp_api/output/output.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -85,10 +92,11 @@ Score histogram.
 # meltOutput
  
 One score per row.
+ 
  
 * **file:** output/melt.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -96,11 +104,12 @@ One score per row.
  
 # mtxOutput
  
-
+simmat output.
+ 
  
 * **file:** output/mtx.cpp
 * **inherits:** [Output](../cpp_api/output/output.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -109,10 +118,11 @@ One score per row.
 # nullOutput
  
 Discards the scores.
+ 
  
 * **file:** output/null.cpp
 * **inherits:** [Output](../cpp_api/output/output.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -121,10 +131,11 @@ Discards the scores.
 # rankOutput
  
 Outputs highest ranked matches with scores.
+ 
  
 * **file:** output/rank.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author:** Scott Klum
+* **author(s):** [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -133,10 +144,11 @@ Outputs highest ranked matches with scores.
 # rrOutput
  
 Rank retrieval output.
+ 
  
 * **file:** output/rr.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **authors:** Josh Klontz, Scott Klum
+* **author(s):** [Josh Klontz][jklontz], [Scott Klum][sklum]
 * **properties:** None
  
  
@@ -145,10 +157,11 @@ Rank retrieval output.
 # tailOutput
  
 The highest scoring matches.
+ 
  
 * **file:** output/tail.cpp
 * **inherits:** [Output](../cpp_api/output/output.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -157,10 +170,11 @@ The highest scoring matches.
 # txtOutput
  
 Text file output.
+ 
  
 * **file:** output/txt.cpp
 * **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
 # AggregateFrames
  
-Passes along n sequential frames to the next transform.
+Passes along n sequential frames to the next [Transform](../cpp_api/transform/transform.md).
+
+For a video with m frames, AggregateFrames would create a total of m-n+1 sequences ([0,n] ... [m-n+1, m])
+ 
  
 * **file:** video/aggregate.cpp
 * **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author:** Josh Klontz
+* **author(s):** [Josh Klontz][jklontz]
 * **properties:** None
  
  
@@ -13,10 +16,13 @@ Passes along n sequential frames to the next transform.
 # DropFrames
  
 Only use one frame every n frames.
+ 
  
 * **file:** video/drop.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10
+  
+   For a video with m frames, DropFrames will pass on m/n frames.]
 * **properties:** None
  
  
@@ -25,10 +31,11 @@ Only use one frame every n frames.
 # OpticalFlowTransform
  
 Gets a one-channel dense optical flow from two images
+ 
  
 * **file:** video/opticalflow.cpp
 * **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author:** Austin Blanton
+* **author(s):** [Austin Blanton][imaus10]
 * **properties:** None
  
  
+So you want to contribute to OpenBR? That's awesome! These are some guidelines to follow so that your contribution fits nicely into our framework.
+
+## Contributing a Plugin
+
+You should consider contributing a plugin (or plugins!) if you have an algorithm you are interested in moving to OpenBR or you have an extension to an existing algorithm. Below are the steps for creating and contributing a plugin-
+
+1. Check out the [C++ Plugin API](api_docs/cpp_api.md) and decide which abstraction best suits the needs of your contribution
+2. Select a module in the <tt>openbr/plugins/</tt> directory that describes your plugin, then create a new file in that module. Your file should have the same name as your plugin.
+3. Implement your plugin! Make sure to have a look at the [Style Guide](#style-guide) so your code matches what's already there. This increases overall readability and makes it easier for newcomers to learn!
+
+### Common Mistakes
+
+Some common mistakes that will stop your plugin from working!
+
+* The entire plugin should be inside ```namespace br```
+* Make sure your plugin declares ```Q_OBJECT``` right after it's definition
+* Remember to call [BR_REGISTER](api_docs/cpp_api/factory/macros.md#br_register) at the end of your plugin!
+* Remeber to add ```#include "module/filename.moc"``` at the very bottom of your file
+
+[MAddTransform](api_docs/plugins/imgproc.md#maddtransform) is a simple and clear example of how a [Transform](api_docs/cpp_api/transform/transform.md) should look.
+
+### Documenting
+
+Documenting your plugin is very important. OpenBR supports custom, doxygen-style, in-code comments to make documentation simple, clear, and easy. Comments should appear like 
+
+		/*!
+		 * ...
+		 */
+
+Comments are organized using tags, which are of the form <tt>\tag</tt>. There are a few **required** tags that all OpenBR transforms must have.
+
+Tag | Description
+--- | ---
+\ingroup | The abstraction that your plugin belongs to
+\brief | A description of your plugin
+\author | Your name
+\cite | The citation link for the author. There must be citation tag for every author who appears. If you haven't already please add your information to <tt>openbr/docs/docs/contributors.md</tt>
+\br_property | Describes a <tt>BR_PROPERTY</tt> of your plugin. This should take the format ```\br_property type name description```. In certain cases, for enumerations for example, it is beneficial to add a bulleted list to the description. This is done using a comma seperated **[]** list. ```[item1,item2,item3]``` will appear like <ul><li>item1</li><li>item2</li><li>item3</li></ul> Each property of the plugin must have a corresponding \br_property tag.
+
+The mimimum comment would look like this
+
+		/*!
+		 * \ingroup abstraction group
+		 * \brief A description of the plugin
+		 * \author Your Name \cite Your Citation
+		 * \br_property percentage float The percentage of something
+		 * \br_property enum choice A choice with possible values: [choice1, choice2, choice3]
+		 */
+		 
+There are also a few **optional** tags to provide more information.
+
+Tag | Description
+--- | ---
+\br_link | A link to a webpage
+\br_paper | An academic paper your plugin needs to cite. This is a multi-line tag- The first line should contain the paper authors, the second line should contain the paper title, and the third should contain other information about the paper (for example conference and year). See below for an example.
+\br_related_plugin | Link to a related plugin within OpenBR. The full name of the plugin should be provided. Multiple plugins can be given and they should be seperated by a space.
+\br_format | TODO define
+
+Optional tags could look like this
+
+		/*!
+		 * \br_link http://openbiometrics.org
+		 * \br_paper Author1, Author2, Author3
+		 *           Paper Title
+		 *           Conference. Year
+		 * \br_related_plugin ExampleTransform ExampleDistance ExampleGallery
+		 */
+
+Finally, OpenBR supports automatic linking for abstractions found in comments. For example, Transform will automatically become [Transform](api_docs/cpp_api/transform/transform.md). Plural words like Transforms will also be linked but possesives like Tranform's will not. 
+
+---
+	 
+## Contributing to the API
+
+You should contribute to the API if you want to add a new abstraction or extend an existing abstraction with new functionality. Please note, this occurs *very* *very* rarely. Our goal is to leave the core API as stable and consistent as possible and change only the surrounding plugins. If you believe your idea offers exciting new functionality or greatly increases efficiency please [open an issue](https://github.com/biometrics/openbr/issues) so that it can be discussed as a community.
 \ No newline at end of file
+<!-- Contributors -->
+
+[jklontz]: https://github.com/jklontz "Joshua C. Klontz, jklontz@ieee.org"
+[mburge]: https://github.com/mburge "Dr. Mark J. Burge mburge@gmail.com"
+[bklare]: https://github.com/bklare "Dr. Brendan F. Klare brendan.klare@ieee.org"
+[mmtaborsky]: https://github.com/mmtaborsky "M. M. Taborsky mmtaborsky@gmail.com"
+[sklum]: https://github.com/sklum "Scott J. Klum scott.klum@gmail.com"
+[caotto]: https://github.com/caotto "Charles A. Otto ottochar@gmail.com"
+[lbestrowden]: https://github.com/lbestrowden "Lacey S. Best-Rowden bestrow1@msu.edu"
+[imaus10]: https://github.com/imaus10 "Austin Van Blanton imaus10@gmail.com"
+[dgcrouse]: https://github.com/dgcrouse "David G. Crouse dgcrouse@gmail.com"
+[baba1472]: https://github.com/baba1472 "Babatunde Ogunfemi ogunfemi.b@gmail.com"
+[jcheney]: https://github.com/JordanCheney "Jordan Cheney jordan.cheney@gmail.com"
-# File
-
-A file path with associated metadata.
-
-See:
-
-* [Members](members.md)
-* [Constructors](constructors.md)
-* [Static Functions](statics.md)
-* [Functions](functions.md)
-
-The File is one of two important data structures in OpenBR (the [Template](../template/template.md) 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](members.md#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 [QVariantList][QVariantList]. 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 [QRectF][QRectF].
-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 [QPointF][QPointF].
-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 [QString][QString].
-
-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 occurring standardized keys:
-
-Key             | Value          | Description
----             | ----           | -----------
-name            | QString        | Contents of [name](members.md#name)
-separator       | QString        | Separate [name](members.md#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&lt;QPointF&gt; | List of unnamed points
-Rects           | QList&lt;Rect&gt;    | 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
-## [Transform](transform.md) \*make([QString][QString] str, [QObject][QObject] \*parent) {: #make }
-
-Make a transform from a string. This function converts the abbreviation characters **+**, **/**, **{}**, **<\>**, and **()** into their full-length alternatives.
-
-Abbreviation | Translation
---- | ---
-\+ | [PipeTransform](../../plugins/core.md#pipetransform). Each [Transform](transform.md) linked by a **+** is turned into a child of a single [PipeTransform](../../plugins/core.md#pipetransform). "Example1+Example2" becomes "Pipe([Example1,Example2])". [Templates](../template/template.md) are projected through the children of a pipe in series, the output of one become the input of the next.
-/ | [ForkTransform](../../plugins/core.md#forktransform). Each [Transform](transform.md) linked by a **/** is turned into a child of a single [ForkTransform](../../plugins/core.md#forktransform). "Example1/Example2" becomes "Fork([Example1,Example2])". [Templates](../template/template.md) are projected the children of a fork in parallel, each receives the same input and the outputs are merged together.
-\{\} | [CacheTransform](../../plugins/core.md#cachetransform). Can only surround a single [Transform](transform.md). "{Example}" becomes "Cache(Example)". The results of a cached [Transform](transform.md) are stored in a global cache using the [file](../object/members.md#file) name as a key.
-<> | [LoadStoreTransform](../../plugins/core.md#loadstoretransform). Can only surround a single [Transform](transform.md). "<Example>" becomes "LoadStore(Example)". Serialize and store a [Transform](transform.md) after training or deserialize and load a [Transform](transform.md) before projecting.
-() | Order of operations. Change the order of operations using parantheses.
-
-The parsed string is then passed to [Factory](../factory/factory.md)::[make](../factory/statics.md#make) to be turned into a transform.
-
-* **function definition:**
-
-        static Transform *make(QString str, QObject *parent)
-
-* **parameters:**
-
-    Parameter | Type | Description
-    --- | --- | ---
-    str | [QString][QString] | String describing the transform
-    parent | [QObject][QObject] \* | Parent of the object to be created
-
-* **output:** ([Transform](transform.md) \*) Returns a pointer to the [Transform](transform.md) described by the string
-* **see:** [Factory::make](../factory/statics.md#make)
-* **example:**
-
-        Transform::make("Example1+Example2+<ModelFile>")->description(); // returns "Pipe(transforms=[Example1,Example2,LoadStore(ModelFile)])".
-
-
-## [QSharedPointer][QSharedPointer]&lt;[Transform](transform.md)&gt; fromAlgorithm(const [QString][QString] &algorithm, bool preprocess=false) {: #fromalgorithm }
-
-Create a [Transform](transform.md) from an OpenBR algorithm string. The [Transform](transform.md) is created using everything to the left of a **:** or a **!** in the string.
-
-* **function definition:**
-
-        static QSharedPointer<Transform> fromAlgorithm(const QString &algorithm, bool preprocess=false)
-
-* **parameters:**
-
-    Parameter | Type | Description
-    --- | --- | ---
-    algorithm | const [QString][QString] & | Algorithm string to construct the [Transform](transform.md) from
-    preprocess | bool | (Optional) If true add a [StreamTransform](../../plugins/core.md#streamtransform) as the parent of the constructed [Transform](transform.md). Default is false.
-
-* **output:** ([QSharedPointer][QSharedPointer]&lt;[Transform](transform.md)&gt;) Returns a pointer to the [Transform](transform.md) described by the algorithm.
-* **example:**
-
-    Transform::fromAlgorithm("EnrollmentTransform:Distance")->decription(); // returns "EnrollmentTransform"
-    Transform::fromAlgorithm("EnrollmentTransform!DistanceTransform")->decription(); // returns "EnrollmentTransform"
-    Transform::fromAlgorithm("EnrollmentTransform")->decription(); // returns "EnrollmentTransform"
-
-## [QSharedPointer][QSharedPointer]<[Transform](transform.md)> fromComparison(const [QString][QString] &algorithm) {: #fromcomparison }
-
-Create a[Transform](transform.md) from an OpenBR algorithm string. The [Transform](transform.md) is created using everything to the right of a **:** or a **!** in the string. If the separating symbol is a **:** the string to the right describes a distance. It is converted to a [GalleryCompareTransform](../../plugins/core.md#gallerycomparetransform) with the distance stored as a property. If the separating symbol is a **!** the string already describes a transform and is unchanged.
-
-* **function definition:**
-
-        static QSharedPointer<Transform> fromComparison(const QString &algorithm)
-
-* **parameters:**
-
-    Parameter | Type | Description
-    --- | --- | ---
-    algorithm | const [QString][QString] & | Algorithm string to construct the [Transform](transform.md) from
-
-* **output:** ([QSharedPointer][QSharedPointer]&lt;[Transform](transform.md)&gt;) Returns a pointer to the [Transform](transform.md) described by the algorithm.
-* **example:**
-
-        Transform::fromAlgorithm("EnrollmentTransform:Distance")->description(); // returns "GalleryCompare(distance=Distance)""
-        Transform::fromAlgorithm("EnrollmentTransform!DistanceTransform"); // returns "DistanceTransform"
-
-
-## [Transform](transform.md) \*deserialize([QDataStream][QDataStream] &stream) {: #deserialize }
-
-Deserialize a [Transform](transform.md) from a stream.
-
-* **function definition:**
-
-        static Transform *deserialize(QDataStream &stream)
-
-* **parameters:**
-
-    Parameter | Type | Description
-    --- | --- | ---
-    stream | [QDataStream][QDataStream] & | Stream containing the serialized transform
-
-* **output:** ([Transform](transform.md) \*) Returns the deserialized transform
-
-
-## [Template](../template/template.md) &operator&gt;&gt;([Template](../template/template.md) &srcdst, const [Transform](transform.md) &f) {: #template-operater-gtgt-1 }
-
-Convenience function for [project](functions.md#project-1)
-
-* **function definition:**
-
-        inline Template &operator>>(Template &srcdst, const Transform &f)
-
-* **parameters:**
-
-    Parameter | Type | Description
-    --- | --- | ---
-    srcdst | [Template](../template/template.md) & | Input template. Will be overwritten with the output following call to [project](functions.md#project-1)
-    f | const [Transform](transform.md) & | [Transform](transform.md) to project through.
-
-* **output:** ([Template](../template/template.md) &) Returns the output of f::[project](functions.md#project-1)
-* **example:**
-
-        Template t("picture1.jpg");
-        Transform *transform = Transform::make("Example", NULL);
-
-        t >> *transform; // projects t through Example. t is overwritten with the output of the project call
-
-<!--no italics* -->
-
-## [TemplateList](../templatelist/templatelist.md) &operator&gt;&gt;([TemplateList](../templatelist/templatelist.md) &srcdst, const [Transform](transform.md) &f) {: #template-operater-gtgt-2 }
-
-Convenience function for [project](functions.md#project-2)
-
-* **function definition:**
-
-        inline TemplateList &operator>>(TemplateList &srcdst, const Transform &f)
-
-* **parameters:**
-
-    Parameter | Type | Description
-    --- | --- | ---
-    srcdst | [TemplateList](../templatelist/templatelist.md) & | Input templates. Will be overwritten with the output following call to [project](functions.md#project-2)
-    f | const [Transform](transform.md) & | [Transform](transform.md) to project through.
-
-* **output:** ([TemplateList](../templatelist/templatelist.md) &) Returns the output of f::[project](functions.md#project-2)
-* **example:**
-
-        TemplateList tList(QList<Template>() << Template("picture1.jpg"));
-        Transform *transform = Transform::make("Example", NULL);
-
-        tList >> *transform; // projects tList through Example. tList is overwritten with the output of the project call
-
-<!--no italics* -->
-
-## [QDataStream][QDataStream] &operator&lt;&lt;([QDataStream][QDataStream] &stream, const [Transform](transform.md) &f) {: #stream-operator-ltlt}
-
-Convenience function for [store](../object/functions.md#store)
-
-* **function definition:**
-
-        inline QDataStream &operator<<(QDataStream &stream, const Transform &f)
-
-* **parameters:**
-
-    Parameter | Type | Description
-    --- | --- | ---
-    stream | [QDataStream][QDataStream] & | Stream to store the transform in
-    f | const [Transform](transform.md) & | Transform to be stored
-
-* **output:** ([QDataStream][QDataStream] &) Returns the stream with the transform stored in it
-* **example:**
-
-        Transform *transform = Transform::make("Example(property1=value1,property2=value2)");
-
-        QDataStream stream;
-        stream << *transform; // stores "Example(property1=value1,property2=value2)" in the stream
-
-<!--no italics* -->
-
-## [QDataStream][QDataStream] &operator&gt;&gt;([QDataStream][QDataStream] &stream, const [Transform](transform.md) &f)  {: #stream-operator-gtgt}
-
-Convenience function for [load](../object/functions.md#load)
-
-* **function definition:**
-
-        inline QDataStream &operator>>(QDataStream &stream, const Transform &f)
-
-* **parameters:**
-
-    Parameter | Type | Description
-    --- | --- | ---
-    stream | [QDataStream][QDataStream] & | Stream to load the transform from
-    f | const [Transform](transform.md) & | Transform to store loaded information
-
-* **output:** ([QDataStream][QDataStream] &) Returns the stream without the transform data
-* **example:**
-
-        Transform *in = Transform::make("Example(property1=value1,property2=value2)");
-
-        QDataStream stream;
-        stream << *in; // stores "Example(property1=value1,property2=value2)" in the stream
-
-        Transform out;
-        stream >> out;
-        out->description(); // returns "Example(property1=value1,property2=value2)"
@@ -83,10 +83,10 @@ The *Biometric Evaluation Environment* (BEE) is a [NIST](http://www.nist.gov/ind
  
 OpenBR implements the following portions of the BEE specification:
  
-* Signature Set- A signature set (or *sigset*) is a [Gallery](api_docs/cpp_api/gallery/gallery.md) compliant **XML** file-list specified on page 9 of [MBGC File Overview](DOCUMENT ME) and implemented in [xmlGallery](api_docs/plugins/gallery.md#xmlgallery). Sigsets are identified with a **.xml** extension.
+* Signature Set- A signature set (or *sigset*) is a [Gallery](api_docs/cpp_api/gallery/gallery.md) compliant **XML** file-list specified on page 9 of the [MBGC File Overview](misc/MBGC_file_overview.pdf) and implemented in [xmlGallery](api_docs/plugins/gallery.md#xmlgallery). Sigsets are identified with a **.xml** extension.
  
-* Similarity Matrix- A similarity matrix (or *simmat*) is an [Output](api_docs/cpp_api/output/output.md) compliant binary score matrix specified on page 12 of [MBGC File Overview](DOCUMENT ME) and implemented in [mtxOutput](api_docs/plugins/output.md#mtxoutput). Simmats are identified with a **.mtx** extension. See [br_eval](api_docs/c_api/functions.md#br_eval) for more information.
+* Similarity Matrix- A similarity matrix (or *simmat*) is an [Output](api_docs/cpp_api/output/output.md) compliant binary score matrix specified on page 12 of the [MBGC File Overview](misc/MBGC_file_overview.pdf) and implemented in [mtxOutput](api_docs/plugins/output.md#mtxoutput). Simmats are identified with a **.mtx** extension. See [br_eval](api_docs/c_api/functions.md#br_eval) for more information.
  
-* Mask Matrix- A mask matrix (or *mask*) is a binary matrix specified on page 14 of [MBGC File Overview](DOCUMENT ME) identifying the ground truth genuines and impostors of a corresponding *simmat*. Masks are identified with a **.mask** extension. See [br_make_mask](api_docs/c_api/functions.md#br_make_mask) and [br_combine_masks](api_docs/c_api/functions.md#br_combine_masks) for more information.
+* Mask Matrix- A mask matrix (or *mask*) is a binary matrix specified on page 14 of the [MBGC File Overview](misc/MBGC_file_overview.pdf) identifying the ground truth genuines and impostors of a corresponding *simmat*. Masks are identified with a **.mask** extension. See [br_make_mask](api_docs/c_api/functions.md#br_make_mask) and [br_combine_masks](api_docs/c_api/functions.md#br_combine_masks) for more information.
  
 ---
@@ -6,6 +6,7 @@ copyright: 2012 The MITRE Corporation
 theme: readthedocs
 theme_dir: themes/readthedocs/
 links_file: docs/links.md
+contributors_file: docs/contributors.md
  
 include_search: True
 include_next_prev: False
@@ -89,7 +90,6 @@ pages:
 - [api_docs/cpp_api/initializer/statics.md, Initializer, Static Functions]
 - [api_docs/cpp_api/initializer/functions.md, Initializer, Functions]
  
-
 # Transform
 - [api_docs/cpp_api/transform/transform.md, C++ Plugin API, Transform]
 - [api_docs/cpp_api/transform/members.md, Transform, Members]
@@ -135,6 +135,12 @@ pages:
 # TimeVaryingTransform
 - [api_docs/cpp_api/timevaryingtransform/timevaryingtransform.md, C++ Plugin API, TimeVaryingTransform]
  
+# CompositeTransform
+- [api_docs/cpp_api/compositetransform/compositetransform.md, C++ Plugin API, CompositeTransform]
+
+# WrapperTransform
+- [api_docs/cpp_api/wrappertransform/wrappertransform.md, C++ Plugin API, WrapperTransform]
+
 # Distance
 - [api_docs/cpp_api/distance/distance.md, C++ Plugin API, Distance]
 - [api_docs/cpp_api/distance/members.md, Distance, Members]
@@ -181,6 +187,10 @@ pages:
  
 # FileGallery
 - [api_docs/cpp_api/filegallery/filegallery.md, C++ Plugin API, FileGallery]
+- [api_docs/cpp_api/filegallery/members.md, FileGallery, Members]
+- [api_docs/cpp_api/filegallery/constructors.md, FileGallery, Constructors]
+- [api_docs/cpp_api/filegallery/statics.md, FileGallery, Static Functions]
+- [api_docs/cpp_api/filegallery/functions.md, FileGallery, Functions]
  
 # Representation
 - [api_docs/cpp_api/representation/representation.md, C++ Plugin API, Representation]
@@ -72,13 +72,19 @@ def parse(path, html):
 def check(headers, links):
     for f, file_links in links.items():
         for link in file_links:
-            if link.http:
+            if link.http: # Can't check links to other websites
                 continue
  
             link_file = f
             if link.file:
                 link_file = link.file
  
+            if link_file.endswith('.pdf'):
+                if not os.path.exists(link_file):
+                    print 'BAD PDF: ' + link_file + ' DOES NOT EXIST'
+                    print
+                continue
+
             if link_file not in headers:
                 print 'BAD FILE IN ' + f + ':', link_file
                 print
-import os
+import os, sys
 import re
  
+abstractions = ['FileList', 'File',
+                'TemplateList', 'Template',
+                'UntrainableTransform',
+                'MetaTransform', 'UntrainableMetaTransform',
+                'MetadataTransform', 'UntrainableMetadataTransform',
+                'TimeVaryingTransform',
+                'CompositeTransform', 'WrapperTransform',
+                'Transform',
+                'UntrainableDistance', 'Distance',
+                'MatrixOutput', 'Output',
+                'Format',
+                'FileGallery', 'Gallery',
+                'Representation',
+                'Classifier'
+               ]
+
 def subfiles(path):
     return [name for name in os.listdir(path) if os.path.isfile(os.path.join(path, name)) and not name[0] == '.']
  
@@ -21,14 +37,15 @@ def parse(group):
     if len(clss) == 0 or 'class' not in clss:
         return None
  
-    blocks = docsMatch.group().split('\\')[1:]
+    clean_docs = docsMatch.group()[3:-2].replace('*', ' ').strip()
+    blocks = clean_docs.split('\\')[1:]
     if len(blocks) == 0:
         return None
  
     attributes = {}
     for block in blocks:
         key = block[:block.find(' ')]
-        value = block[block.find(' '):].split('\n')[0].strip()
+        value = block[block.find(' '):].strip()
         if key in attributes:
             attributes[key].append(value)
         else:
@@ -38,51 +55,91 @@ def parse(group):
     attributes['Parent'] = clss[clss.find('public')+6:].strip().strip(',') # Handles the edge case of multiple inheritence
     return attributes
  
-def parseInheritance(inheritance):
-    abstractions = ['Transform', 'UntrainableTransform',
-                    'MetaTransform', 'UntrainableMetaTransform',
-                    'MetadataTransform', 'UntrainableMetadataTransform',
-                    'TimeVaryingTransform',
-                    'Distance', 'UntrainableDistance',
-                    'Output', 'MatrixOutput',
-                    'Format',
-                    'Gallery', 'FileGallery',
-                    'Representation',
-                    'Classifier'
-                   ]
+def parseBrief(briefs):
+    if not briefs:
+        print 'All plugins need a description!'
+        sys.exit(1)
+
+    output = ""
+    for brief in briefs:
+        for abstraction in abstractions:
+            regex = re.compile('\s' + abstraction + "'?s?")
+
+            matches = regex.finditer(brief)
+            for match in matches:
+                name = ' [' + abstraction + ']'
+                link = '(../cpp_api/' + abstraction.lower() + '/' + abstraction.lower() + '.md)'
+                brief = brief.replace(match.group(), name + link).strip() # strip removes a possible leading whitespace
+
+        for line in brief.split('\n'):
+            if not line.strip():
+                output += "\n"
+            else:
+                output += line.strip() + "\n"
+
+        output += ' '
+
+    return output + '\n\n'
  
+def parseInheritance(inheritance):
     if inheritance in abstractions:
         return '../cpp_api/' + inheritance.lower() + '/' + inheritance.lower() + '.md'
     else: # Not an abstraction must inherit in the local file!
         return '#' + inheritance.lower()
  
-def parseSees(sees):
-    if not sees:
+def parseLinks(links):
+    if not links:
         return ""
  
     output = "* **see:**"
-    if len(sees) > 1:
+    if len(links) > 1:
         output += "\n\n"
-        for see in sees:
-            output += "\t* [" + see + "](" + see + ")\n"
+        for link in links:
+            output += "\t* [" + link + "](" + link + ")\n"
         output += "\n"
     else:
-        link = sees[0]
-        if not 'http' in link:
-            link = '#' + link.lower()
-        output += " [" + sees[0] + "](" + link + ")\n"
+        output += " [" + links[0] + "](" + links[0] + ")\n"
  
     return output
  
-def parseAuthors(authors):
+def parsePapers(papers):
+    if not papers:
+        return ""
+
+    output = "* **read:**\n\n"
+    for i in range(len(papers)):
+        info = papers[i].split('\n')
+        authors = info[0].strip()
+        title = None
+        other = None
+        if len(info) >= 2:
+            title = info[1].strip()
+        if len(info) >= 3:
+            other = info[2].strip()
+
+        output += "\t" + str(i+1) + ". *" + authors + "*\n"
+        if title:
+            output += "\t **" + title + "**\n"
+        if other:
+            output += "\t " + other + "\n"
+        output += "\n"
+
+    return output
+
+def parseAuthors(authors, citations):
     if not authors:
-        return "* **authors:** None\n"
+        print 'All plugins need an author!'
+        sys.exit(1)
  
-    output = "* **author"
-    if len(authors) > 1:
-        output += "s:** " + ", ".join(authors) + "\n"
-    else:
-        output += ":** " + authors[0] + "\n"
+    if len(authors) != len(citations):
+        print 'Different number of authors and citations!'
+        print authors, citations
+        return "* **authors:** PARSING ERROR\n"
+
+    output = "* **author(s):** "
+    for i in range(len(authors)):
+        output += "[" + authors[i] + "][" + citations[i] + "], "
+    output = output[:-2] + "\n"
  
     return output
  
@@ -91,8 +148,8 @@ def parseProperties(properties):
         return "* **properties:** None\n\n"
  
     output = "* **properties:**\n\n"
-    output += "Property | Type | Description\n"
-    output += "--- | --- | ---\n"
+    output += "\tProperty | Type | Description\n"
+    output += "\t--- | --- | ---\n"
     for prop in properties:
         split = prop.split(' ')
         ty = split[0]
@@ -115,13 +172,46 @@ def parseProperties(properties):
             desc = before.strip() + table + after.strip()
             table_match = table_regex.search(desc)
  
-        output += name + " | " + ty + " | " + desc + "\n"
+        output += "\t" + name + " | " + ty + " | " + desc + "\n"
  
     return output
  
+def parseFormats(formats):
+    if not formats:
+        return ""
+
+    output = "* **format:** "
+    for f in formats:
+        in_raw = False
+        for line in f.split('\n'):
+            if not line.strip():
+                output += "<pre><code>" if not in_raw else "</code></pre>"
+                in_raw = not in_raw
+                continue
+
+            clean_line = line.strip()
+
+            # <> are often used describing formats. Unfortunately they are also html tags.
+            # So we need to replace them with safe alternatives
+            if '<' in clean_line:
+                clean_line = clean_line.replace('<', '&lt;')
+            if '>' in clean_line:
+                clean_line = clean_line.replace('>', '&gt;')
+
+            output += clean_line
+            if in_raw:
+                output += "\n"
+            else:
+                output += ' '
+
+        if in_raw:
+            output += "</code></pre>"
+
+    return output + "\n"
+
 def main():
     plugins_dir = '../../openbr/plugins/'
-    output_dir = '../docs/docs/plugins/'
+    output_dir = '../docs/api_docs/plugins/'
  
     for module in subdirs(plugins_dir):
         if module == "cmake":
@@ -143,14 +233,18 @@ def main():
                 if not attributes or (attributes and attributes["Parent"] == "Initializer"):
                     continue
  
+                print 'documenting ' + module + "/" + plugin + '...'
+
                 plugin_string = "# " + attributes["Name"] + "\n\n"
-                plugin_string += ' '.join([brief for brief in attributes["brief"]]) + "\n\n"
+                plugin_string += parseBrief(attributes.get("brief", None))
                 plugin_string += "* **file:** " + os.path.join(module, plugin) + "\n"
                 plugin_string += "* **inherits:** [" + attributes["Parent"] + "](" + parseInheritance(attributes["Parent"]) + ")\n"
  
-                plugin_string += parseSees(attributes.get("see", None))
-                plugin_string += parseAuthors(attributes.get("author", None))
-                plugin_string += parseProperties(attributes.get("property", None))
+                plugin_string += parseAuthors(attributes.get("author", None), attributes.get("cite", None))
+                plugin_string += parseLinks(attributes.get("br_link", None))
+                plugin_string += parsePapers(attributes.get("br_paper", None))
+                plugin_string += parseFormats(attributes.get("br_format", None))
+                plugin_string += parseProperties(attributes.get("br_property", None))
  
                 plugin_string += "\n---\n\n"
  
@@ -10,6 +10,9 @@ h3, h4, h5, h6 {
     font-weight: 300
 }
  
+p {
+    font-size: 90%;
+}
 /*
  * Sphinx doesn't have support for section dividers like we do in
  * MkDocs, this styles the section titles in the nav
@@ -23,427 +23,96 @@
 extern "C" {
 #endif
  
-/*!
- * \brief Wraps br::Context::about()
- * \see br_version
- */
+
 BR_EXPORT const char *br_about();
  
-/*!
- * \brief Wraps br::Cat()
- */
 BR_EXPORT void br_cat(int num_input_galleries, const char *input_galleries[], const char *output_gallery);
  
-/*!
- * \brief Removes duplicate templates in a gallery.
- * \param input_gallery Gallery to be deduplicated.
- * \param output_gallery Deduplicated gallery.
- * \param threshold Comparisons with a match score >= this value are designated to be duplicates.
- * \note If a gallery contains n duplicates, the first n-1 duplicates in the gallery will be removed and the nth will be kept.
- * \note Users are encouraged to use binary gallery formats as the entire gallery is read into memory in one call to Gallery::read.
- */
 BR_EXPORT void br_deduplicate(const char *input_gallery, const char *output_gallery, const char *threshold);
  
-/*!
- * \brief Clusters one or more similarity matrices into a list of subjects.
- *
- * A similarity matrix is a type of br::Output. The current clustering algorithm is a simplified implementation of \cite zhu11.
- * \param num_simmats Size of \c simmats.
- * \param simmats Array of \ref simmat composing one large self-similarity matrix arranged in row major order.
- * \param aggressiveness The higher the aggressiveness the larger the clusters. Suggested range is [0,10].
- * \param csv The cluster results file to generate. Results are stored one row per cluster and use gallery indices.
- */
 BR_EXPORT void br_cluster(int num_simmats, const char *simmats[], float aggressiveness, const char *csv);
  
-/*!
- * \brief Combines several equal-sized mask matrices.
- * \param num_input_masks Size of \c input_masks
- * \param input_masks Array of \ref mask to combine.
- *                    All matrices must have the same dimensions.
- * \param output_mask The file to contain the resulting \ref mask.
- * \param method Either:
- *  - \c And - Ignore comparison if \em any input masks ignore.
- *  - \c Or - Ignore comparison if \em all input masks ignore.
- * \note A comparison may not be simultaneously identified as both a genuine and an impostor by different input masks.
- * \see br_make_mask
- */
 BR_EXPORT void br_combine_masks(int num_input_masks, const char *input_masks[], const char *output_mask, const char *method);
  
-/*!
- * \brief Compares each template in the query gallery to each template in the target gallery.
- * \param target_gallery The br::Gallery file whose templates make up the columns of the output.
- * \param query_gallery The br::Gallery file whose templates make up the rows of the output.
- *                      A value of '.' reuses the target gallery as the query gallery.
- * \param output Optional br::Output file to contain the results of comparing the templates.
- *               The default behavior is to print scores to the terminal.
- * \see br_enroll
- */
 BR_EXPORT void br_compare(const char *target_gallery, const char *query_gallery, const char *output = "");
  
-/*!
- * \brief Convenience function for comparing to multiple targets.
- * \see br_compare
- */
 BR_EXPORT void br_compare_n(int num_targets, const char *target_galleries[], const char *query_gallery, const char *output);
  
-/*!
- * \brief DOCUMENT ME!
- */
 BR_EXPORT void br_pairwise_compare(const char *target_gallery, const char *query_gallery, const char *output = "");
  
-/*!
- * \brief Wraps br::Convert()
- */
 BR_EXPORT void br_convert(const char *file_type, const char *input_file, const char *output_file);
  
-/*!
- * \brief Constructs template(s) from an input.
- * \param input The br::Input set of images to enroll.
- * \param gallery The br::Gallery file to contain the enrolled templates.
- *                By default the gallery will be held in memory and \em input can used as a gallery in \ref br_compare.
- * \see br_enroll_n
- */
 BR_EXPORT void br_enroll(const char *input, const char *gallery = "");
  
-/*!
- * \brief Convenience function for enrolling multiple inputs.
- * \see br_enroll
- */
 BR_EXPORT void br_enroll_n(int num_inputs, const char *inputs[], const char *gallery = "");
  
-/*!
- * \brief A naive alternative to \ref br_enroll.
- */
 BR_EXPORT void br_project(const char *input, const char *output);
  
-/*!
- * \brief Creates a \c .csv file containing performance metrics from evaluating the similarity matrix using the mask matrix.
- * \param simmat The \ref simmat to use.
- * \param mask The \ref mask to use.
- * \param csv Optional \c .csv file to contain performance metrics.
- * \param matches Optional integer number of matches to output around the EER, defualts to 0.
- * \return True accept rate at a false accept rate of one in one thousand.
- * \see br_plot
- */
 BR_EXPORT float br_eval(const char *simmat, const char *mask, const char *csv = "", int matches = 0);
  
-/*!
- * \brief Evaluates the similarity matrix using the mask matrix.  Function aborts ff TAR @ FAR = 0.001 does not meet an expected performance value
- * \param simmat The \ref simmat to use.
- * \param mask The \ref mask to use.
- * \param accuracy Desired true accept rate at false accept rate of one in one thousand.
- */
- BR_EXPORT void br_assert_eval(const char *simmat, const char *mask, const float accuracy);
-
-/*!
- * \brief Creates a \c .csv file containing performance metrics from evaluating the similarity matrix using galleries containing ground truth labels
- * \param simmat The \ref simmat to use.
- * \param target the name of a gallery containing metadata for the target set.
- * \param query the name of a gallery containing metadata for the query set.
- * \param csv Optional \c .csv file to contain performance metrics.
- * \return True accept rate at a false accept rate of one in one thousand.
- * \see br_plot
- */
+BR_EXPORT void br_assert_eval(const char *simmat, const char *mask, const float accuracy);
+
 BR_EXPORT float br_inplace_eval(const char * simmat, const char *target, const char *query, const char *csv = "");
  
-/*!
- * \brief Evaluates and prints classification accuracy to terminal.
- * \param predicted_gallery The predicted br::Gallery.
- * \param truth_gallery The ground truth br::Gallery.
- * \param predicted_property (Optional) which metadata key to use from <i>predicted_gallery</i>.
- * \param truth_property (Optional) which metadata key to use from <i>truth_gallery</i>.
- */
 BR_EXPORT void br_eval_classification(const char *predicted_gallery, const char *truth_gallery, const char *predicted_property = "", const char *truth_property = "");
  
-/*!
- * \brief Evaluates and prints clustering accuracy to the terminal.
- * \param csv The cluster results file.
- * \param gallery The br::Gallery used to generate the \ref simmat that was clustered.
- * \param truth_property (Optional) which metadata key to use from <i>gallery</i/>, defaults to Label
- * \see br_cluster
- */
 BR_EXPORT void br_eval_clustering(const char *csv, const char *gallery, const char * truth_property);
  
-/*!
- * \brief Evaluates and prints detection accuracy to terminal.
- * \param predicted_gallery The predicted br::Gallery.
- * \param truth_gallery The ground truth br::Gallery.
- * \param csv Optional \c .csv file to contain performance metrics.
- * \param normalize Optional \c bool flag to normalize predicted bounding boxes for improved detection. 
- * \return Average detection bounding box overlap.
- */
 BR_EXPORT float br_eval_detection(const char *predicted_gallery, const char *truth_gallery, const char *csv = "", bool normalize = false, int minSize = 0, int maxSize = 0);
  
-/*!
- * \brief Evaluates and prints landmarking accuracy to terminal.
- * \param predicted_gallery The predicted br::Gallery.
- * \param truth_gallery The ground truth br::Gallery.
- * \param csv Optional \c .csv file to contain performance metrics.
- * \param normalization_index_a Optional first index in the list of points to use for normalization.
- * \param normalization_index_b Optional second index in the list of points to use for normalization.
- * \param sample_index Optional index for sample landmark image in ground truth gallery.
- * \param total_examples Optional number of accurate and inaccurate examples to display.
- */
 BR_EXPORT float br_eval_landmarking(const char *predicted_gallery, const char *truth_gallery, const char *csv = "", int normalization_index_a = 0, int normalization_index_b = 1, int sample_index = 0, int total_examples = 5);
  
-/*!
- * \brief Evaluates regression accuracy to disk.
- * \param predicted_gallery The predicted br::Gallery.
- * \param truth_gallery The ground truth br::Gallery.
- * \param predicted_property (Optional) which metadata key to use from <i>predicted_gallery</i>.
- * \param truth_property (Optional) which metadata key to use from <i>truth_gallery</i>.
- */
 BR_EXPORT void br_eval_regression(const char *predicted_gallery, const char *truth_gallery, const char *predicted_property = "", const char *truth_property = "");
  
-/*!
- * \brief Wraps br::Context::finalize()
- * \see br_initialize
- */
 BR_EXPORT void br_finalize();
  
-/*!
- * \brief Perform score level fusion on similarity matrices.
- * \param num_input_simmats Size of \em input_simmats.
- * \param input_simmats Array of \ref simmat. All simmats must have the same dimensions.
- * \param normalization Valid options are:
- *          - \c None - No score normalization.
- *          - \c MinMax - Scores normalized to [0,1].
- *          - \c ZScore - Scores normalized to a standard normal curve.
- * \param fusion Valid options are:
- *          - \c Min - Uses the minimum score.
- *          - \c Max - Uses the maximum score.
- *          - \c Sum - Sums the scores. Sums can also be weighted: <tt>SumW1:W2:...:Wn</tt>.
- *          - \c Replace - Replaces scores in the first matrix with scores in the second matrix when the mask is set.
- * \param output_simmat \ref simmat to contain the fused scores.
- */
 BR_EXPORT void br_fuse(int num_input_simmats, const char *input_simmats[],
                        const char *normalization, const char *fusion, const char *output_simmat);
  
-/*!
- * \brief Wraps br::Context::initialize()
- * \see br_finalize
- */
 BR_EXPORT void br_initialize(int &argc, char *argv[], const char *sdk_path = "", bool use_gui = false);
-/*!
- * \brief Wraps br::Context::initialize() with default arguments.
- * \see br_finalize
- */
+
 BR_EXPORT void br_initialize_default();
  
-/*!
- * \brief Wraps br::IsClassifier()
- */
 BR_EXPORT bool br_is_classifier(const char *algorithm);
  
-/*!
- * \brief Constructs a \ref mask from target and query inputs.
- * \param target_input The target br::Input.
- * \param query_input The query br::Input.
- * \param mask The file to contain the resulting \ref mask.
- * \see br_combine_masks
- */
 BR_EXPORT void br_make_mask(const char *target_input, const char *query_input, const char *mask);
  
-/*!
- * \brief Constructs a \ref mask from target and query inputs considering the target and input sets to be definint pairwise comparisons
- * \param target_input The target br::Input.
- * \param query_input The query br::Input.
- * \param mask The file to contain the resulting \ref mask.
- * \see br_combine_masks
- */
 BR_EXPORT void br_make_pairwise_mask(const char *target_input, const char *query_input, const char *mask);
  
-/*!
- * \brief Returns the most recent line sent to stderr.
- * \note \ref input_string_buffer
- * \see br_progress br_time_remaining
- */
 BR_EXPORT int br_most_recent_message(char * buffer, int buffer_length);
  
-/*!
- * \brief Returns names and parameters for the requested objects.
- *
- * Each object is \c \\n seperated. Arguments are seperated from the object name with a \c \\t.
- * \param abstractions Regular expression of the abstractions to search.
- * \param implementations Regular expression of the implementations to search.
- * \param parameters Include parameters after object name.
- * \note \ref input_string_buffer
- * \note This function uses Qt's <a href="http://doc.qt.digia.com/stable/qregexp.html">QRegExp</a> syntax.
- */
 BR_EXPORT int br_objects(char * buffer, int buffer_length, const char *abstractions = ".*", const char *implementations = ".*", bool parameters = true);
  
-/*!
- * \brief Renders recognition performance figures for a set of <tt>.csv</tt> files created by \ref br_eval.
- *
- * In order of their output, the figures are:
- * -# Metadata table
- * -# Receiver Operating Characteristic (ROC)
- * -# Detection Error Tradeoff (DET)
- * -# Score Distribution (SD) histogram
- * -# True Accept Rate Bar Chart (BC)
- * -# Cumulative Match Characteristic (CMC)
- * -# Error Rate (ERR) curve
- *
- * Two files will be created:
- * - <i>destination</i><tt>.R</tt> which is the auto-generated R script used to render the figures.
- * - <i>destination</i><tt>.pdf</tt> which has all of the figures in one file multi-page file.
- *
- * OpenBR uses file and folder names to automatically determine the plot legend.
- * For example, let's consider the case where three algorithms (<tt>A</tt>, <tt>B</tt>, & <tt>C</tt>) were each evaluated on two datasets (<tt>Y</tt> & <tt>Z</tt>).
- * The suggested way to plot these experiments on the same graph is to create a folder named <tt>Algorithm_Dataset</tt> that contains the six <tt>.csv</tt> files produced by br_eval <tt>A_Y.csv</tt>, <tt>A_Z.csv</tt>, <tt>B_Y.csv</tt>, <tt>B_Z.csv</tt>, <tt>C_Y.csv</tt>, & <tt>C_Z.csv</tt>.
- * The '<tt>_</tt>' character plays a special role in determining the legend title(s) and value(s).
- * In this case, <tt>A</tt>, <tt>B</tt>, & <tt>C</tt> will be identified as different values of type <tt>Algorithm</tt>, and each will be assigned its own color; <tt>Y</tt> & <tt>Z</tt> will be identified as different values of type Dataset, and each will be assigned its own line style.
- * Matches around the EER will be displayed if the matches parameter is set in \ref br_eval.
- *
- * \param num_files Number of <tt>.csv</tt> files.
- * \param files <tt>.csv</tt> files created using \ref br_eval.
- * \param destination Basename for the resulting figures.
- * \param show Open <i>destination</i>.pdf using the system's default PDF viewer.
- * \return Returns \c true on success. Returns false on a failure to compile the figures due to a missing, out of date, or incomplete \c R installation.
- * \note This function requires a current <a href="http://www.r-project.org/">R</a> installation with the following packages:
- * \code install.packages(c("ggplot2", "gplots", "reshape", "scales", "jpg", "png")) \endcode
- * \see br_eval
- */
 BR_EXPORT bool br_plot(int num_files, const char *files[], const char *destination, bool show = false);
  
-/*!
- * \brief Renders detection performance figures for a set of <tt>.csv</tt> files created by \ref br_eval_detection.
- *
- * In order of their output, the figures are:
- * -# Discrete Receiver Operating Characteristic (DiscreteROC)
- * -# Continuous Receiver Operating Characteristic (ContinuousROC)
- * -# Discrete Precision Recall (DiscretePR)
- * -# Continuous Precision Recall (ContinuousPR)
- * -# Bounding Box Overlap Histogram (Overlap)
- * -# Average Overlap Table (AverageOverlap)
- * -# Average Overlap Heatmap (AverageOverlap)
- *
- * Detection accuracy is measured with <i>overlap fraction = bounding box intersection / union</i>.
- * When computing <i>discrete</i> curves, an overlap >= 0.5 is considered a true positive, otherwise it is considered a false negative.
- * When computing <i>continuous</i> curves, true positives and false negatives are measured fractionally as <i>overlap</i> and <i>1-overlap</i> respectively.
- *
- * \see br_plot
- */
 BR_EXPORT bool br_plot_detection(int num_files, const char *files[], const char *destination, bool show = false);
  
-/*!
- * \brief Renders landmarking performance figures for a set of <tt>.csv</tt> files created by \ref br_eval_landmarking.
- *
- * In order of their output, the figures are:
- * -# Cumulative landmarks less than normalized error (CD)
- * -# Normalized error box and whisker plots (Box)
- * -# Normalized error violin plots (Violin)
- *
- * Landmarking error is normalized against the distance between two predifined points, usually inter-ocular distance (IOD).
- *
- * \see br_plot
- */
 BR_EXPORT bool br_plot_landmarking(int num_files, const char *files[], const char *destination, bool show = false);
  
-/*!
- * \brief Renders metadata figures for a set of <tt>.csv</tt> files with specified columns.
- *
- * Several files will be created:
- * - <tt>PlotMetadata.R</tt> which is the auto-generated R script used to render the figures.
- * - <tt>PlotMetadata.pdf</tt> which has all of the figures in one file (convenient for attaching in an email).
- * - <i>column</i><tt>.pdf</tt>, ..., <i>column</i><tt>.pdf</tt> which has each figure in a separate file (convenient for including in a presentation).
- *
- * \param num_files Number of <tt>.csv</tt> files.
- * \param files <tt>.csv</tt> files created by enrolling templates to <tt>.csv</tt> metadata files.
- * \param columns ';' seperated list of columns to plot.
- * \param show Open <tt>PlotMetadata.pdf</tt> using the system's default PDF viewer.
- * \return See \ref br_plot
- */
 BR_EXPORT bool br_plot_metadata(int num_files, const char *files[], const char *columns, bool show = false);
  
-/*!
- * \brief Wraps br::Context::progress()
- * \see br_most_recent_message br_time_remaining
- */
 BR_EXPORT float br_progress();
  
-/*!
- * \brief Read and parse arguments from a named pipe.
- *
- * Used by the \ref cli to implement \c -daemon, generally not useful otherwise.
- * Guaranteed to return at least one argument.
- * \param pipe Pipe name
- * \param[out] argc argument count
- * \param[out] argv argument list
- * \note \ref managed_return_value
- */
 BR_EXPORT void br_read_pipe(const char *pipe, int *argc, char ***argv);
  
-/*!
- * \brief Wraps br::Context::scratchPath()
- * \note \ref input_string_buffer
- * \see br_version
- */
 BR_EXPORT int br_scratch_path(char * buffer, int buffer_length);
  
-
-/*!
- * \brief Returns the full path to the root of the SDK.
- * \see br_initialize
- */
 BR_EXPORT const char *br_sdk_path();
  
-/*!
- * \brief Retrieve the target and query inputs in the BEE matrix header.
- * \param matrix The BEE matrix file to modify
- * \param[out] target_gallery The matrix target
- * \param[out] query_gallery The matrix query
- * \note \ref managed_return_value
- * \see br_set_header
- */
 BR_EXPORT void br_get_header(const char *matrix, const char **target_gallery, const char **query_gallery);
  
-/*!
- * \brief Update the target and query inputs in the BEE matrix header.
- * \param matrix The BEE matrix file to modify
- * \param target_gallery The matrix target
- * \param query_gallery The matrix query
- * \see br_get_header
- */
 BR_EXPORT void br_set_header(const char *matrix, const char *target_gallery, const char *query_gallery);
  
-/*!
- *\brief Wraps br::Context::setProperty()
- */
 BR_EXPORT void br_set_property(const char *key, const char *value);
  
-/*!
- * \brief Wraps br::Context::timeRemaining()
- * \see br_most_recent_message br_progress
- */
 BR_EXPORT int br_time_remaining();
  
-/*!
- * \brief Trains the br::Transform and br::Comparer on the input.
- * \param input The br::Input set of images to train on.
- * \param model Optional string specifying the binary file to serialize training results to.
- *              The trained algorithm can be recovered by using this file as the algorithm.
- *              By default the trained algorithm will not be serialized to disk.
- * \see br_train_n
- */
 BR_EXPORT void br_train(const char *input, const char *model = "");
  
-/*!
- * \brief Convenience function for training on multiple inputs.
- * \see br_train
- */
 BR_EXPORT void br_train_n(int num_inputs, const char *inputs[], const char *model = "");
  
-/*!
- * \brief Wraps br::Context::version()
- * \see br_about br_scratch_path
- */
 BR_EXPORT const char *br_version();
  
-
-/*!
-  * \brief For internal use via ProcessWrapperTransform
-  */
 BR_EXPORT void br_slave_process(const char * baseKey);
  
 // to avoid having to include unwanted headers
@@ -454,124 +123,56 @@ typedef void* br_template;
 typedef void* br_template_list;
 typedef void* br_gallery;
 typedef void* br_matrix_output;
-/*!
-  * \brief Load an image from a string buffer.
-  *   Easy way to pass an image in memory from another programming language to openbr.
-  * \param data The image buffer.
-  * \param len The length of the buffer.
-  * \see br_unload_img
-  */
+
 BR_EXPORT br_template br_load_img(const char *data, int len);
-/*!
-  * \brief Unload an image to a string buffer.
-  *   Easy way to pass an image from openbr to another programming language.
-  * \param tmpl Pointer to a br::Template.
-  */
+
 BR_EXPORT unsigned char* br_unload_img(br_template tmpl);
-/*!
-  * \brief Deserialize a br::TemplateList from a buffer.
-  *        Can be the buffer for a .gal file,
-  *        since they are just a TemplateList serialized to disk.
-  */
+
 BR_EXPORT br_template_list br_template_list_from_buffer(const char *buf, int len);
-/*!
-  * \brief Free a br::Template's memory.
-  */
+
 BR_EXPORT void br_free_template(br_template tmpl);
-/*!
-  * \brief Free a br::TemplateList's memory.
-  */
+
 BR_EXPORT void br_free_template_list(br_template_list tl);
-/*!
-  * \brief Free a br::Output's memory.
-  */
+
 BR_EXPORT void br_free_output(br_matrix_output output);
-/*!
-  * \brief Get the number of rows in an image.
-  * \param tmpl Pointer to a br::Template.
-  */
+
 BR_EXPORT int br_img_rows(br_template tmpl);
-/*!
-  * \brief Get the number of columns in an image.
-  * \param tmpl Pointer to a br::Template.
-  */
+
 BR_EXPORT int br_img_cols(br_template tmpl);
-/*!
-  * \brief Get the number of channels in an image.
-  * \param tmpl Pointer to a br::Template.
-  */
+
 BR_EXPORT int br_img_channels(br_template tmpl);
-/*!
-  * \brief Returns if the image is empty.
-  */
+
 BR_EXPORT bool br_img_is_empty(br_template tmpl);
-/*!
-  * \brief Get the filename for a br::Template
-  * \note \ref input_string_buffer
-  */
+
 BR_EXPORT int br_get_filename(char * buffer, int buffer_length, br_template tmpl);
-/*!
-  * \brief Set the filename for a br::Template.
-  */
+
 BR_EXPORT void br_set_filename(br_template tmpl, const char *filename);
-/*!
-  * \brief Get metadata as a string for the given key in the given template.
-  * \note \ref input_string_buffer
-  */
+
 BR_EXPORT int br_get_metadata_string(char * buffer, int buffer_length, br_template tmpl, const char *key);
-/*!
-  * \brief Enroll a br::Template from the C API! Returns a pointer to a br::TemplateList
-  * \param tmpl Pointer to a br::Template.
-  */
+
 BR_EXPORT br_template_list br_enroll_template(br_template tmpl);
-/*!
-  * \brief Enroll a br::TemplateList from the C API!
-  * \param tl Pointer to a br::TemplateList.
-  */
+
 BR_EXPORT void br_enroll_template_list(br_template_list tl);
-/*!
-  * \brief Compare br::TemplateLists from the C API!
-  * \return Pointer to a br::MatrixOutput.
-  */
+
 BR_EXPORT br_matrix_output br_compare_template_lists(br_template_list target, br_template_list query);
-/*!
-  * \brief Get a value in the br::MatrixOutput.
-  */
+
 BR_EXPORT float br_get_matrix_output_at(br_matrix_output output, int row, int col);
-/*!
-  * \brief Get a pointer to a br::Template at a specified index.
-  * \param tl Pointer to a br::TemplateList.
-  * \param index The index of the br::Template.
-  */
+
 BR_EXPORT br_template br_get_template(br_template_list tl, int index);
-/*!
-  * \brief Get the number of br::Templates in a br::TemplateList.
-  * \param tl Pointer to a br::TemplateList
-  */
+
 BR_EXPORT int br_num_templates(br_template_list tl);
-/*!
-  * \brief Initialize a br::Gallery.
-  * \param gallery String location of gallery on disk.
-  */
+
 BR_EXPORT br_gallery br_make_gallery(const char *gallery);
-/*!
-  * \brief Read br::TemplateList from br::Gallery.
-  */
+
 BR_EXPORT br_template_list br_load_from_gallery(br_gallery gallery);
-/*!
-  * \brief Write a br::Template to the br::Gallery on disk.
-  */
+
 BR_EXPORT void br_add_template_to_gallery(br_gallery gallery, br_template tmpl);
-/*!
-  * \brief Write a br::TemplateList to the br::Gallery on disk.
-  */
+
 BR_EXPORT void br_add_template_list_to_gallery(br_gallery gallery, br_template_list tl);
-/*!
-  * \brief Close the br::Gallery.
-  */
+
 BR_EXPORT void br_close_gallery(br_gallery gallery);
  
-/*! @}*/
+
  
 #ifdef __cplusplus
 }
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
- * Copyright 2012 The MITRE Corporation                                      *
- *                                                                           *
- * Licensed under the Apache License, Version 2.0 (the "License");           *
- * you may not use this file except in compliance with the License.          *
- * You may obtain a copy of the License at                                   *
- *                                                                           *
- *     http://www.apache.org/licenses/LICENSE-2.0                            *
- *                                                                           *
- * Unless required by applicable law or agreed to in writing, software       *
- * distributed under the License is distributed on an "AS IS" BASIS,         *
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  *
- * See the License for the specific language governing permissions and       *
- * limitations under the License.                                            *
- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-
-/*!
- * \mainpage
- * \section overview Overview
- * OpenBR \cite klontz2013open is a framework for investigating new modalities, improving existing algorithms, interfacing with commercial systems, measuring recognition performance, and deploying automated biometric systems.
- * The project is designed to facilitate rapid algorithm prototyping, and features a mature core framework, flexible plugin system, and support for open and closed source development.
- * Off-the-shelf algorithms are also available for specific modalities including \ref cpp_face_recognition, \ref cpp_age_estimation, and \ref cpp_gender_estimation.
- *
- * OpenBR originated within The MITRE Corporation from a need to streamline the process of prototyping new algorithms.
- * The project was later published as open source software under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2</a> license and is <i>free for academic and commercial use</i>.
- *
- * \image html "abstraction.svg" "The two principal software artifacts are the shared library 'openbr' and command line application 'br'."
- *
- * \section get_started Get Started
- * - \ref introduction - A high-level technical overview of OpenBR.
- * - \ref installation - A hacker's guide to building, editing, and running OpenBR.
- * - \ref examples - Source code illustrating common use cases.
- * - \ref help - Talk to the experts.
- *
- * \section learn_more Learn More
- * - \ref algorithm_grammar - How algorithms are constructed from string descriptions.
- * - \ref cli - Command line wrapper of the \ref c_sdk.
- * - \ref c_sdk - High-level API for running algorithms and evaluating results.
- * - \ref cpp_plugin_sdk - Plugin API for extending OpenBR functionality.
- * - \ref bee - A <a href="http://www.nist.gov/index.html">NIST</a> standard for evaluating biometric algorithms.
- * - \ref qmake_integration - Add OpenBR to your Qt <tt>.pro</tt> project.
- */
-
-/*!
- * \page introduction Introduction
- * \brief A high-level technical overview of OpenBR.
- *
- * We strongly encourage users new to OpenBR to read our <a href="http://www.openbiometrics.org/publications/klontz2013open.pdf"><b>publication</b></a> for an introduction to the core concepts.
- * Researchers incorporating OpenBR into their own work are kindly requested to cite this paper.
- */
-
-/*!
- * \page installation Installation
- * \brief A hacker's guide to building, editing, and running OpenBR.
- *
- * \section installation_from_source From Source
- * Installation from source is the recommended method for getting OpenBR on your machine.
- * <b>If you are interested in our off-the-shelf algorithms, please use the latest tagged release instead of the master branch.</b>
- * If you need a little help getting started, choose from the list of build instructions for free C++ compilers below:
- * - \subpage windows_msvc
- * - \subpage osx_clang
- * - \subpage linux_gcc
- * - \subpage raspbian_gcc
- *
- * \section installation_from_binary From Binary
- * Pre-compiled releases are not currently provided, but they can be built from source using the instructions above.
- * Generally you should follow your operating system's best practices for installing a binary package.
- * However, for temporary evaluation, one simple configuration approach is:
- *
- * \par Linux
-\verbatim
-$ cd bin
-$ export LD_LIBRARY_PATH=../lib:${LD_LIBRARY_PATH}
-$ sudo ldconfig
-\endverbatim
- * \par OS X
-\verbatim
-$ cd bin
-$ export DYLD_LIBRARY_PATH=../lib:${DYLD_LIBRARY_PATH}
-$ export DYLD_FRAMEWORK_PATH=../lib:${DYLD_FRAMEWORK_PATH}
-\endverbatim
- * \par Windows
- *  No configuration is necessary!
- *
- * \section installation_done Start Working
- * To test for successful installation:
-\verbatim
-$ cd bin
-$ br -help
-\endverbatim
- */
-
-/*!
- * \page windows_msvc Windows 7 - Visual Studio Express Edition 2012 - x64
- * -# <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.
- *  -# Consider the free open source program <a href="http://wincdemu.sysprogs.org">WinCDEmu</a> if you need a program to mount ISO images.
- *  -# You will have to register with Microsoft after installation, but it's free.
- *  -# Grab any available <a href="http://www.microsoft.com/visualstudio/eng/downloads#d-visual-studio-2012-update">Visual Studio Updates</a>.
- *  -# Download and install <a href="http://msdn.microsoft.com/en-us/windows/hardware/hh852363.aspx">Windows 8 SDK</a>.
- * -# <a href="http://www.cmake.org/files/v2.8/cmake-2.8.11.2-win32-x86.exe">Download and Install CMake 2.8.11.2</a>
- *  -# During installation setup select "add CMake to PATH".
- * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.6.1/opencv-2.4.6.1.tar.gz">Download OpenCV 2.4.6.1</a>
- *  -# Consider the free open source program <a href="http://www.7-zip.org/">7-Zip</a> if you need a program to unarchive tarballs.
- *  -# Move the "opencv-2.4.6.1" folder to "C:\".
- *  -# Open "VS2012 x64 Cross Tools Command Prompt" (from the Start Menu, select "All Programs" -> "Microsoft Visual Studio 2012" -> "Visual Studio Tools" -> "VS2012 x64 Cross Tools Command Prompt") and enter:
- \code
- $ cd C:\opencv-2.4.6.1
- $ mkdir build-msvc2012
- $ cd build-msvc2012
- $ cmake -G "NMake Makefiles" -DBUILD_PERF_TESTS=OFF -DBUILD_TESTS=OFF -DWITH_FFMPEG=OFF -DCMAKE_BUILD_TYPE=Debug ..
- $ nmake
- $ nmake install
- $ cmake -DCMAKE_BUILD_TYPE=Release ..
- $ nmake
- $ nmake install
- $ nmake clean
- \endcode
- * -# <a href="http://download.qt-project.org/official_releases/qt/5.1/5.1.1/qt-windows-opensource-5.1.1-msvc2012-x86_64-offline.exe">Download and Install Qt 5.1.1</a>
- * -# Create a <a href="github.com">GitHub</a> account and follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.
- *  -# Launch "Git Bash" from the Desktop and clone OpenBR:
- \code
- $ cd /c
- $ git clone https://github.com/biometrics/openbr.git
- $ cd openbr
- $ git checkout 0.5
- $ git submodule init
- $ git submodule update
- \endcode
- * -# Build OpenBR!
- *  -# From the VS2012 x64 Cross Tools Command Prompt:
- \code
- $ cd C:\openbr
- $ mkdir build-msvc2012
- $ cd build-msvc2012
- $ cmake -G "CodeBlocks - NMake Makefiles" -DCMAKE_PREFIX_PATH="C:/opencv-2.4.6.1/build-msvc2012/install;C:/Qt/Qt5.1.1/5.1.1/msvc2012_64" -DCMAKE_INSTALL_PREFIX="./install" -DBR_INSTALL_DEPENDENCIES=ON -DCMAKE_BUILD_TYPE=Release ..
- $ nmake
- $ nmake install
- \endcode
- *  -# Check out the "install" folder.
- * -# Hack OpenBR!
- *  -# From the VS2012 x64 Cross Tools Command Prompt:
- \code
- $ C:\Qt\Qt5.1.1\Tools\QtCreator\bin\qtcreator.exe
- \endcode
- *  -# From the Qt Creator "Tools" menu select "Options..."
- *  -# Under "Kits" select "Desktop (default)"
- *  -# For "Compiler:" select "Microsoft Visual C++ Compiler 11.0 (x86_amd64)" and click "OK"
- *  -# From the Qt Creator "File" menu select "Open File or Project...".
- *  -# Select "C:\openbr\CMakeLists.txt" then "Open".
- *  -# If prompted for the location of CMake, enter "C:\Program Files (x86)\CMake 2.8\bin\cmake.exe".
- *  -# Browse to your pre-existing build directory "C:\openbr\build-msvc2012" then select "Next".
- *  -# Select "Run CMake" then "Finish".
- *  -# You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.
- * -# (Optional) Package OpenBR!
- *  -# From the VS2012 x64 Cross Tools Command Prompt:
- \code
- $ cd C:\openbr\build-msvc2012
- $ cpack -G ZIP
- \endcode
- */
-
-/*!
- * \page osx_clang OS X Mountain Lion - Clang/LLVM 3.1 - x64
- * -# 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.
- * -# <a href="http://www.cmake.org/files/v2.8/cmake-2.8.11.2.tar.gz">Download CMake 2.8.11.2</a>
- \code
- $ cd ~/Downloads
- $ tar -xf cmake-2.8.11.2.tar.gz
- $ cd cmake-2.8.11.2
- $ ./configure
- $ make -j4
- $ sudo make install
- $ cd ..
- $ rm -rf cmake-2.8.11.2*
- \endcode
- * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.6.1/opencv-2.4.6.1.tar.gz">Download OpenCV 2.4.6.1</a>
- \code
- $ cd ~/Downloads
- $ tar -xf opencv-2.4.6.1.tar.gz
- $ cd opencv-2.4.6.1
- $ mkdir build
- $ cd build
- $ cmake -DCMAKE_BUILD_TYPE=Release ..
- $ make -j4
- $ sudo make install
- $ cd ../..
- $ rm -rf opencv-2.4.6.1*
- \endcode
- * -# <a href="http://download.qt-project.org/official_releases/qt/5.1/5.1.1/qt-mac-opensource-5.1.1-clang-offline.dmg">Download and install Qt 5.1.1</a>
- * -# Create a <a href="github.com">GitHub</a> account, follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.
- \code
- $ git clone https://github.com/biometrics/openbr.git
- $ cd openbr
- $ git checkout 0.5
- $ git submodule init
- $ git submodule update
- \endcode
- * -# Build OpenBR!
- \code
- $ mkdir build # from the OpenBR root directory
- $ cd build
- $ cmake -DCMAKE_PREFIX_PATH=~/Qt5.1.1/5.1.1/clang_64 -DCMAKE_BUILD_TYPE=Release ..
- $ make -j4
- $ sudo make install
- \endcode
- * -# Hack OpenBR!
- *  -# Open Qt Creator IDE
- \code
- $ open ~/Qt5.1.1/Qt\ Creator.app
- \endcode
- *  -# From the Qt Creator "File" menu select "Open File or Project...".
- *  -# Select "openbr/CMakeLists.txt" then "Open".
- *  -# Browse to your pre-existing build directory "openbr/build" then select "Continue".
- *  -# Select "Run CMake" then "Done".
- *  -# You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.
- * -# (Optional) Test OpenBR!
- \code
- $ cd openbr/scripts
- $ ./downloadDatasets.sh
- $ cd ../build
- $ make test
- \endcode
- * -# (Optional) Package OpenBR!
- \code
- $ cd openbr/build
- $ sudo cpack -G TGZ
- \endcode
- * -# (Optional) Build OpenBR documentation!
- *  -# <a href="ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.5.src.tar.gz">Download Doxygen 1.8.5</a>
- \code
- $ cd ~/Downloads
- $ tar -xf doxygen-1.8.5.src.tar.gz
- $ cd doxygen-1.8.5
- $ ./configure
- $ make -j4
- $ sudo make install
- $ cd ..
- $ rm -rf doxygen-1.8.5*
- \endcode
- *  -# Modify build settings and recompile.
- \code
- $ cd openbr/build
- $ cmake -DBR_BUILD_DOCUMENTATION=ON ..
- $ make -j4
- $ open html/index.html
- \endcode
- */
-
-/*!
- * \page linux_gcc Ubuntu 13.04 - GCC 4.7.3 - x64
- * -# Install GCC 4.7.3
- \code
- $ sudo apt-get update
- $ sudo apt-get install build-essential
- \endcode
- * -# Install CMake 2.8.10.1
- \code
- $ sudo apt-get install cmake cmake-curses-gui
- \endcode
- * -# <a href="http://downloads.sourceforge.net/project/opencvlibrary/opencv-unix/2.4.5/opencv-2.4.5.tar.gz">Download OpenCV 2.4.5</a>, note <a href="https://github.com/biometrics/openbr/wiki/Build-OpenCV-with-Video-Support-on-Ubuntu">this</a>
- \code
- $ cd ~/Downloads
- $ tar -xf opencv-2.4.5.tar.gz
- $ cd opencv-2.4.5
- $ mkdir build
- $ cd build
- $ cmake -DCMAKE_BUILD_TYPE=Release ..
- $ make -j4
- $ sudo make install
- $ cd ../..
- $ rm -rf opencv-2.4.5*
- \endcode
- * -# Install Qt 5.0.1
- \code
- $ sudo apt-get install qt5-default libqt5svg5-dev qtcreator
- \endcode
- * -# Create a <a href="github.com">GitHub</a> account, follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.
- \code
- $ git clone https://github.com/biometrics/openbr.git
- $ cd openbr
- $ git checkout 0.5
- $ git submodule init
- $ git submodule update
- \endcode
- * -# Build OpenBR!
- \code
- $ mkdir build # from the OpenBR root directory
- $ cd build
- $ cmake -DCMAKE_BUILD_TYPE=Release ..
- $ make -j4
- $ sudo make install
- \endcode
- * -# Hack OpenBR!
- *  -# Open Qt Creator IDE
- \code
- $ qtcreator &
- \endcode
- *  -# From the Qt Creator "File" menu select "Open File or Project...".
- *  -# Select "openbr/CMakeLists.txt" then "Open".
- *  -# Browse to your pre-existing build directory "openbr/build" then select "Next".
- *  -# Select "Run CMake" then "Finish".
- *  -# You're all set! You can find more information on Qt Creator <a href="http://qt-project.org/doc/qtcreator">here</a> if you need.
- * -# (Optional) Test OpenBR!
- \code
- $ cd openbr/scripts
- $ ./downloadDatasets.sh
- $ cd ../build
- $ make test
- \endcode
- * -# (Optional) Package OpenBR!
- \code
- $ cd openbr/build
- $ sudo cpack -G TGZ
- \endcode
- * -# (Optional) Build OpenBR documentation!
- \code
- $ sudo apt-get install doxygen
- $ cd openbr/build
- $ cmake -DBR_BUILD_DOCUMENTATION=ON ..
- $ make -j4
- $ sudo apt-get install libgnome2-bin
- $ gnome-open html/index.html
- \endcode
- */
-
-/*!
- * \page raspbian_gcc Raspbian 3.0.1 - GCC 4.6.3 - ARMv6
- * -# Install CMake 2.8.9
- \code
- $ sudo apt-get install cmake
- \endcode
- * -# Download OpenCV 2.4.9
- \code
- $ wget http://sourceforge.net/projects/opencvlibrary/files/opencv-unix/2.4.9/opencv-2.4.9.zip
- $ unzip opencv-2.4.9.zip
- $ cd opencv-2.4.9
- $ mkdir build
- $ cd build
- $ cmake -DCMAKE_BUILD_TYPE=Release ..
- $ make
- $ sudo make install
- $ cd ../..
- $ rm -rf opencv-2.4.9*
- \endcode
- * -# Install Qt5
- *  -# Modify source list
- \code
- $ nano /etc/apt/sources.list
- \endcode
- by changing:
- \code
- deb http://mirrordirector.raspbian.org/raspbian/ wheezy main contrib non-free rpi
- \endcode
- to:
- \code
- deb http://mirrordirector.raspbian.org/raspbian/ jessie main contrib non-free rpi
- \endcode
- *  -# Update apt-get
- \code
- $ sudo apt-get update
- \endcode
- *  -# Install packages
- \code
- $ sudo apt-get install qt5-default libqt5svg5-dev
- \endcode
- * -# Create a <a href="github.com">GitHub</a> account, follow their instructions for <a href="https://help.github.com/articles/set-up-git">setting up Git</a>.
- \code
- $ git clone https://github.com/biometrics/openbr.git
- $ cd openbr
- $ git checkout 0.5
- $ git submodule init
- $ git submodule update
- \endcode
- * -# Build OpenBR!
- \code
- $ mkdir build # from the OpenBR root directory
- $ cd build
- $ cmake -DCMAKE_BUILD_TYPE=Release ..
- $ make
- $ sudo make install
- \endcode
- * -# (Optional) Test OpenBR!
- \code
- $ cd openbr/scripts
- $ ./downloadDatasets.sh
- $ cd ../build
- $ make test
- \endcode
-*/
-
-/*!
- * \page help Help
- * - Developer mailing list: <a href="https://groups.google.com/forum/?fromgroups#!forum/openbr-dev">openbr-dev@googlegroups.com</a>
- * - IRC Channel: <a href="http://webchat.freenode.net/?channels=openbr">irc.freenode.net\#openbr</a>
- */
-
-/*!
- * \page qmake_integration QMake Integration
- * \brief Add OpenBR to your Qt <tt>.pro</tt> project.
- *
- * After completing the \ref installation instructions, try launching Qt Creator and opening <tt>\<path_to_openbr_installation\>/share/openbr/qmake_tutorial/hello.pro</tt>.
- *
- * Happy hacking!
- */
-
-/*!
- * \page algorithm_grammar Algorithm Grammar
- * \brief How algorithms are constructed from string descriptions.
- *
- * <b>So you've run <tt>scripts/helloWorld.sh</tt> and it generally makes sense, except you have no idea what <tt>'Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(128,128,0.33,0.45)+CvtFloat+PCA(0.95):Dist(L2)'</tt> means or how it is executed.</b>
- * Well if this is the case, you've found the right documentation.
- * Let's get started!
- *
- * In OpenBR an <i>algorithm</i> is a technique for enrolling templates associated with a technique for comparing them.
- * Recall that our ultimate goal is to be able to say how similar two face images are (or two fingerprints, irises, etc.).
- * Instead of storing the entire raw image for comparison, it is common practice to store an optimized representation, or <i>template</i>, of the image for the task at hand.
- * The process of generating this optimized representatation is called <i>template enrollment</i> or <i>template generation</i>.
- * Given two templates, <i>template comparison</i> computes the similarity between them, where the higher values indicate more probable matches and the threshold for determining what constitutes an adaquate match is determined operationally.
- * The goal of template generation is to design templates that are small, accurate, and fast to compare.
- * Ok, you probably knew all of this already, let's move on.
- *
- * The only way of creating an algorithm in OpenBR is from a text string that describes it.
- * We call this string the <i>algorithm description</i>.
- * The algorithm description is seperated into two parts by a ':', with the left hand side indicating how to generate templates and the right hand side indicating how to compare them.
- * Some algorithms, like \ref cpp_gender_estimation and \ref cpp_age_estimation are <i>classifiers</i> that don't create templates.
- * In these cases, the colon and the template comparison technique can be omitted from the algorithm description.
- *
- * There are several motivations for mandating that algorithms are defined from these strings, here are the most important:
- * -# It ensures good software development practices by forcibly decoupling the development of each step in an algorithm, facilitating the modification of algorithms and the re-use of individual steps.
- * -# It spares the creation and maintainance of a lot of very similar header files that would otherwise be needed for each step in an algorithm, observe the abscence of headers in <tt>openbr/plugins</tt>.
- * -# It allows for algorithm parameter tuning without recompiling.
- * -# It is completely unambiguous, both the OpenBR interpreter and anyone familiar with the project can understand exactly what your algorithm does just from this description.
- *
- * Let's look at some of the important parts of the code base that make this possible!
- *
- * In <tt>AlgorithmCore::init()</tt> in <tt>openbr/core/core.cpp</tt> you can see the code for splitting the algorithm description at the colon.
- * Shortly thereafter in this function we <i>make</i> the template generation and comparison methods.
- * These make calls are defined in the public \ref cpp_plugin_sdk and can also be called from end user code.
- *
- * Below we discuss some of the source code for \ref br::Transform::make in <tt>openbr/openbr_plugin.cpp</tt>.
- * Note, \ref br::Distance::make is similar in spirit and will not be covered.
- *
- * One of the first steps when converting the template enrollment description into a \ref br::Transform is to replace the operators, like '+', with their full form:
- * \snippet openbr/openbr_plugin.cpp Make a pipe
- * A pipe (see \ref br::PipeTransform in <tt>openbr/plugins/meta.cpp</tt>) 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.
- *
- * After operator expansion, the template enrollment description forms a tree, and the transform is constructed from this description starting recurively starting at the root of the tree:
- * \snippet openbr/openbr_plugin.cpp Construct the root transform
- *
- * At this point we reach arguably the most important code in the entire framework, the <i>object factory</i> in <tt>openbr/openbr_plugin.h</tt>.
- * The \ref br::Factory class is responsible for constructing an object from a string:
- * \snippet openbr/openbr_plugin.h Factory make
- *
- * Going back to our original example, a \ref br::PipeTransform will be created with \ref br::OpenTransform, \ref br::CvtTransform, \ref br::CascadeTransform, \ref br::ASEFEyesTransform, \ref br::AffineTransform, \ref br::CvtFloatTransform, and \ref br::PCATransform as its children.
- * If you want all the tedious details about what exactly this algoritm does, then you should read the \ref br::Transform::project function implemented by each of these plugins.
- * The brief explanation is that it <i>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</i>.
- * 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 <i>similarity</i> values when comparing templates, and not <i>distances</i>, \ref br::DistDistance will return <i>-log(distance+1)</i> so that larger values indicate more similarity.
- */
-
-/*!
- * \page bee Biometric Evaluation Environment
- * \brief The <i>Biometric Evaluation Environment</i> (BEE) is a <a href="http://www.nist.gov/index.html">NIST</a> standard for evaluating biometric algorithms.
- *
- * OpenBR implements the following portions of the BEE specification:
- *
- * \section sigset Signature Set
- * A signature set (or \em sigset) is a br::Gallery compliant \c XML file-list specified on page 9 of <a href="MBGC_file_overview.pdf#page=9">MBGC File Overview</a> and implemented in xmlGallery.
- * Sigsets are identified with a <tt>.xml</tt> extension.
- *
- * \section simmat Similarity Matrix
- * A similarity matrix (or \em simmat) is a br::Output compliant binary score matrix specified on page 12 of <a href="MBGC_file_overview.pdf#page=12">MBGC File Overview</a> and implemented in mtxOutput.
- * Simmats are identified with a <tt>.mtx</tt> extension.
- * \see br_eval
- *
- * \section mask Mask Matrix
- * A mask matrix (or \em mask) is a binary matrix specified on page 14 of <a href="MBGC_file_overview.pdf#page=14">MBGC File Overview</a> identifying the ground truth genuines and impostors of a corresponding \ref simmat.
- * Masks are identified with a <tt>.mask</tt> extension.
- * \see br_make_mask br_combine_masks
- */
@@ -43,183 +43,69 @@
 #include <openbr/openbr.h>
 #include <assert.h>
  
-/*!
- * \defgroup cpp_plugin_sdk C++ Plugin SDK
- * \brief Plugin API for extending OpenBR functionality.
- *
- * \code
- * #include <openbr/openbr_plugin.h>
- * \endcode
- *
- * \par Development
- * Plugins should be developed in <tt>openbr/plugins/</tt>.
- * See this folder for numerous examples of existing plugins to follow when writing your own.
- * Plugins may optionally include a <tt>.cmake</tt> file to control build configuration.
- *
- * \par Documentation
- * Plugin documentation should include at least three lines providing the plugin abstraction, a brief explanation, and author.
- * If multiple authors are specified, the last author is assumed to be the current maintainer of the plugin.
- * Plugin authors are encouraged to <tt>\\cite</tt> relevant papers by adding them to <tt>share/openbr/openbr.bib</tt>.
- *
- * \section examples Examples
- * - \ref cpp_face_recognition
- * - \ref cpp_face_recognition_search
- * - \ref cpp_age_estimation
- * - \ref cpp_gender_estimation
- *
- * \subsection cpp_face_recognition Face Recognition
- * \ref cli_face_recognition "Command Line Interface Equivalent"
- * \snippet app/examples/face_recognition.cpp face_recognition
- *
- * \subsection cpp_face_recognition_search Face Recognition Search
- * \ref cli_face_recognition_search "Command Line Interface Equivalent"
- * \snippet app/examples/face_recognition_search.cpp face_recognition_search
- *
- * \subsection cpp_face_recognition_train Face Recognition Train
- * \ref cli_face_recognition_train "Command Line Interface Equivalent"
- * \snippet app/examples/face_recognition_train.cpp face_recognition_train
- *
- * \subsection cpp_age_estimation Age Estimation
- * \ref cli_age_estimation "Command Line Interface Equivalent"
- * \snippet app/examples/age_estimation.cpp age_estimation
- *
- * \subsection cpp_gender_estimation Gender Estimation
- * \ref cli_gender_estimation "Command Line Interface Equivalent"
- * \snippet app/examples/gender_estimation.cpp gender_estimation
- */
-
 namespace br
 {
  
-/*!
- * \addtogroup cpp_plugin_sdk
- *  @{
- */
-
-/*!
- * Helper macro for use with <a href="http://doc.qt.digia.com/qt/properties.html">Q_PROPERTY</a>.
- *
- * \b Example:<br>
- * Note the symmetry between \c BR_PROPERTY and \c Q_PROPERTY.
- * \snippet openbr/plugins/misc.cpp example_transform
- */
 #define BR_PROPERTY(TYPE,NAME,DEFAULT)                  \
 TYPE NAME;                                              \
 TYPE get_##NAME() const { return NAME; }                \
 void set_##NAME(TYPE the_##NAME) { NAME = the_##NAME; } \
 void reset_##NAME() { NAME = DEFAULT; }
  
-/*!
- * \brief 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 properities 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 sperated 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:
- * -# 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.
- * -# 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.
- * -# 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.
- * -# If the value is convertable to a floating point number then it is represented with \c float.
- * -# 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
- */
 struct BR_EXPORT File
 {
-    QString name; /*!< \brief Path to a file on disk. */
+    QString name;
  
     File() { fte = false; }
-    File(const QString &file) { init(file); } /*!< \brief Construct a file from a string. */
-    File(const QString &file, const QVariant &label) { init(file); set("Label", label); } /*!< \brief Construct a file from a string and assign a label. */
-    File(const char *file) { init(file); } /*!< \brief Construct a file from a c-style string. */
-    File(const QVariantMap &metadata) : fte(false), m_metadata(metadata) {} /*!< \brief Construct a file from metadata. */
-    inline operator QString() const { return name; } /*!< \brief Returns #name. */
-    QString flat() const; /*!< \brief A stringified version of the file with metadata. */
-    QString hash() const; /*!< \brief A hash of the file. */
-
-    inline QStringList localKeys() const { return m_metadata.keys(); } /*!< \brief Returns the private metadata keys. */
-    inline QVariantMap localMetadata() const { return m_metadata; } /*!< \brief Returns the private metadata. */
-
-    void append(const QVariantMap &localMetadata); /*!< \brief Add new metadata fields. */
-    void append(const File &other); /*!< \brief Append another file using \c separator. */
-    inline File &operator+=(const QMap<QString,QVariant> &other) { append(other); return *this; } /*!< \brief Add new metadata fields. */
-    inline File &operator+=(const File &other) { append(other); return *this; } /*!< \brief Append another file using \c separator. */
-
-    QList<File> split() const; /*!< \brief Split the file using \c separator. */
-    QList<File> split(const QString &separator) const; /*!< \brief Split the file. */
-
-    inline void setParameter(int index, const QVariant &value) { set("_Arg" + QString::number(index), value); } /*!< \brief Insert a keyless value. */
-    inline bool containsParameter(int index) const { return contains("_Arg" + QString::number(index)); } /*!< \brief Check for the existence of a keyless value. */
-    inline QVariant getParameter(int index) const { return get<QVariant>("_Arg" + QString::number(index)); } /*!< \brief Retrieve a keyless value. */
-
-    inline bool operator==(const char* other) const { return name == other; } /*!< \brief Compare name to c-style string. */
-    inline bool operator==(const File &other) const { return (name == other.name) && (m_metadata == other.m_metadata); } /*!< \brief Compare name and metadata for equality. */
-    inline bool operator!=(const File &other) const { return !(*this == other); } /*!< \brief Compare name and metadata for inequality. */
-    inline bool operator<(const File &other) const { return name < other.name; } /*!< \brief Compare name. */
-    inline bool operator<=(const File &other) const { return name <= other.name; } /*!< \brief Compare name. */
-    inline bool operator>(const File &other) const { return name > other.name; } /*!< \brief Compare name. */
-    inline bool operator>=(const File &other) const { return name >= other.name; } /*!< \brief Compare name. */
-
-    inline bool isNull() const { return name.isEmpty() && m_metadata.isEmpty(); } /*!< \brief Returns \c true if name and metadata are empty, \c false otherwise. */
-    inline bool isTerminal() const { return name == "terminal"; } /*!< \brief Returns \c true if #name is "terminal", \c false otherwise. */
-    inline bool exists() const { return QFileInfo(name).exists(); } /*!< \brief Returns \c true if the file exists on disk, \c false otherwise. */
-    inline QString fileName() const { return QFileInfo(name).fileName(); } /*!< \brief Returns the file's base name and extension. */
+    File(const QString &file) { init(file); }
+    File(const QString &file, const QVariant &label) { init(file); set("Label", label); }
+    File(const char *file) { init(file); }
+    File(const QVariantMap &metadata) : fte(false), m_metadata(metadata) {}
+    inline operator QString() const { return name; }
+    QString flat() const;
+    QString hash() const;
+
+    inline QStringList localKeys() const { return m_metadata.keys(); }
+    inline QVariantMap localMetadata() const { return m_metadata; }
+
+    void append(const QVariantMap &localMetadata);
+    void append(const File &other);
+    inline File &operator+=(const QMap<QString,QVariant> &other) { append(other); return *this; }
+    inline File &operator+=(const File &other) { append(other); return *this; }
+
+    QList<File> split() const;
+    QList<File> split(const QString &separator) const;
+
+    inline void setParameter(int index, const QVariant &value) { set("_Arg" + QString::number(index), value); }
+    inline bool containsParameter(int index) const { return contains("_Arg" + QString::number(index)); }
+    inline QVariant getParameter(int index) const { return get<QVariant>("_Arg" + QString::number(index)); }
+
+    inline bool operator==(const char* other) const { return name == other; }
+    inline bool operator==(const File &other) const { return (name == other.name) && (m_metadata == other.m_metadata); }
+    inline bool operator!=(const File &other) const { return !(*this == other); }
+    inline bool operator<(const File &other) const { return name < other.name; }
+    inline bool operator<=(const File &other) const { return name <= other.name; }
+    inline bool operator>(const File &other) const { return name > other.name; }
+    inline bool operator>=(const File &other) const { return name >= other.name; }
+
+    inline bool isNull() const { return name.isEmpty() && m_metadata.isEmpty(); }
+    inline bool isTerminal() const { return name == "terminal"; }
+    inline bool exists() const { return QFileInfo(name).exists(); } 
+    inline QString fileName() const { return QFileInfo(name).fileName(); }
     inline QString baseName() const { const QString baseName = QFileInfo(name).baseName();
-                                      return baseName.isEmpty() ? QDir(name).dirName() : baseName; } /*!< \brief Returns the file's base name. */
-    inline QString suffix() const { return QFileInfo(name).suffix(); } /*!< \brief Returns the file's extension. */
-    inline QString path() const { return QFileInfo(name).path(); } /*! \brief Returns the file's path excluding its name. */
-    QString resolved() const; /*!< \brief Returns name prepended with Globals->path if name does not exist. */
-
-    bool contains(const QString &key) const; /*!< \brief Returns \c true if the key has an associated value, \c false otherwise. */
-    bool contains(const QStringList &keys) const; /*!< \brief Returns \c true if all keys have associated values, \c false otherwise. */
-    QVariant value(const QString &key) const; /*!< \brief Returns the value for the specified key. */
-    static QVariant parse(const QString &value); /*!< \brief Try to convert the QString to a QPointF or QRectF if possible. */
-    inline void set(const QString &key, const QVariant &value) { m_metadata.insert(key, value); } /*!< \brief Insert or overwrite the metadata key with the specified value. */
-    void set(const QString &key, const QString &value); /*!< \brief Insert or overwrite the metadata key with the specified value. */
-
-    /*!< \brief Specialization for list type. Insert or overwrite the metadata key with the specified value. */
+                                      return baseName.isEmpty() ? QDir(name).dirName() : baseName; }
+    inline QString suffix() const { return QFileInfo(name).suffix(); }
+    inline QString path() const { return QFileInfo(name).path(); }
+    QString resolved() const;
+
+    bool contains(const QString &key) const;
+    bool contains(const QStringList &keys) const;
+    QVariant value(const QString &key) const;
+    static QVariant parse(const QString &value);
+    inline void set(const QString &key, const QVariant &value) { m_metadata.insert(key, value); }
+    void set(const QString &key, const QString &value);
+
+
     template <typename T>
     void setList(const QString &key, const QList<T> &value)
     {
@@ -230,9 +116,9 @@ struct BR_EXPORT File
         set(key, variantList);
     }
  
-    inline void remove(const QString &key) { m_metadata.remove(key); } /*!< \brief Remove the metadata key. */
+    inline void remove(const QString &key) { m_metadata.remove(key); }
+
  
-    /*!< \brief Returns a value for the key, throwing an error if the key does not exist. */
     template <typename T>
     T get(const QString &key) const
     {
@@ -242,7 +128,7 @@ struct BR_EXPORT File
         return variant.value<T>();
     }
  
-    /*!< \brief Returns a value for the key, returning \em defaultValue if the key does not exist or can't be converted. */
+
     template <typename T>
     T get(const QString &key, const T &defaultValue) const
     {
@@ -252,10 +138,10 @@ struct BR_EXPORT File
         return variant.value<T>();
     }
  
-    /*!< \brief Specialization for boolean type. */
+
     bool getBool(const QString &key, bool defaultValue = false) const;
  
-    /*!< \brief Specialization for list type. Returns a list of type T for the key, throwing an error if the key does not exist or if the value cannot be converted to the specified type. */
+
     template <typename T>
     QList<T> getList(const QString &key) const
     {
@@ -268,7 +154,7 @@ struct BR_EXPORT File
         return list;
     }
  
-    /*!< \brief Specialization for list type. Returns a list of type T for the key, returning \em defaultValue if the key does not exist or can't be converted. */
+
     template <typename T>
     QList<T> getList(const QString &key, const QList<T> defaultValue) const
     {
@@ -281,7 +167,7 @@ struct BR_EXPORT File
         return list;
     }
  
-    /*!< \brief Returns the value for the specified key for every file in the list. */
+
     template<class U>
     static QList<QVariant> values(const QList<U> &fileList, const QString &key)
     {
@@ -290,7 +176,7 @@ struct BR_EXPORT File
         return values;
     }
  
-    /*!< \brief Returns a value for the key for every file in the list, throwing an error if the key does not exist. */
+
     template<class T, class U>
     static QList<T> get(const QList<U> &fileList, const QString &key)
     {
@@ -299,7 +185,7 @@ struct BR_EXPORT File
         return result;
     }
  
-    /*!< \brief Returns a value for the key for every file in the list, returning \em defaultValue if the key does not exist or can't be converted. */
+
     template<class T, class U>
     static QList<T> get(const QList<U> &fileList, const QString &key, const T &defaultValue)
     {
@@ -308,22 +194,22 @@ struct BR_EXPORT File
         return result;
     }
  
-    QList<QPointF> namedPoints() const; /*!< \brief Returns points convertible from metadata keys. */
-    QList<QPointF> points() const; /*!< \brief Returns the file's points list. */
-    void appendPoint(const QPointF &point); /*!< \brief Adds a point to the file's point list. */
-    void appendPoints(const QList<QPointF> &points); /*!< \brief Adds landmarks to the file's landmark list. */
-    inline void clearPoints() { m_metadata["Points"] = QList<QVariant>(); } /*!< \brief Clears the file's landmark list. */
-    inline void setPoints(const QList<QPointF> &points) { clearPoints(); appendPoints(points); } /*!< \brief Overwrites the file's landmark list. */
-
-    QList<QRectF> namedRects() const; /*!< \brief Returns rects convertible from metadata values. */
-    QList<QRectF> rects() const; /*!< \brief Returns the file's rects list. */
-    void appendRect(const QRectF &rect); /*!< \brief Adds a rect to the file's rect list. */
-    void appendRect(const cv::Rect &rect); /*!< \brief Adds a rect to the file's rect list. */
-    void appendRects(const QList<QRectF> &rects); /*!< \brief Adds rects to the file's rect list. */
-    void appendRects(const QList<cv::Rect> &rects); /*!< \brief Adds rects to the file's rect list. */
-    inline void clearRects() { m_metadata["Rects"] = QList<QVariant>(); } /*!< \brief Clears the file's rect list. */
-    inline void setRects(const QList<QRectF> &rects) { clearRects(); appendRects(rects); } /*!< \brief Overwrites the file's rect list. */
-    inline void setRects(const QList<cv::Rect> &rects) { clearRects(); appendRects(rects); } /*!< \brief Overwrites the file's rect list. */
+    QList<QPointF> namedPoints() const;
+    QList<QPointF> points() const;
+    void appendPoint(const QPointF &point);
+    void appendPoints(const QList<QPointF> &points);
+    inline void clearPoints() { m_metadata["Points"] = QList<QVariant>(); }
+    inline void setPoints(const QList<QPointF> &points) { clearPoints(); appendPoints(points); }
+
+    QList<QRectF> namedRects() const;
+    QList<QRectF> rects() const;
+    void appendRect(const QRectF &rect);
+    void appendRect(const cv::Rect &rect);
+    void appendRects(const QList<QRectF> &rects);
+    void appendRects(const QList<cv::Rect> &rects);
+    inline void clearRects() { m_metadata["Rects"] = QList<QVariant>(); }
+    inline void setRects(const QList<QRectF> &rects) { clearRects(); appendRects(rects); }
+    inline void setRects(const QList<cv::Rect> &rects) { clearRects(); appendRects(rects); }
  
     bool fte;
 private:
@@ -334,83 +220,64 @@ private:
     void init(const QString &file);
 };
  
-/*!< \brief Specialization for boolean type. */
+
 template <>
 inline bool File::get<bool>(const QString &key, const bool &defaultValue) const
 {
     return getBool(key, defaultValue);
 }
  
-/*!< \brief Specialization for boolean type. */
+
 template <>
 inline bool File::get<bool>(const QString &key) const
 {
     return getBool(key);
 }
  
-BR_EXPORT QDebug operator<<(QDebug dbg, const File &file); /*!< \brief Prints br::File::flat() to \c stderr. */
-BR_EXPORT QDataStream &operator<<(QDataStream &stream, const File &file); /*!< \brief Serializes the file to a stream. */
-BR_EXPORT QDataStream &operator>>(QDataStream &stream, File &file); /*!< \brief Deserializes the file from a stream. */
+BR_EXPORT QDebug operator<<(QDebug dbg, const File &file);
+BR_EXPORT QDataStream &operator<<(QDataStream &stream, const File &file);
+BR_EXPORT QDataStream &operator>>(QDataStream &stream, File &file);
+
  
-/*!
- * \brief A list of files.
- *
- * Convenience class for working with a list of files.
- */
 struct BR_EXPORT FileList : public QList<File>
 {
     FileList() {}
-    FileList(int n); /*!< \brief Initialize the list with \em n empty files. */
-    FileList(const QStringList &files); /*!< \brief Initialize the file list from a string list. */
-    FileList(const QList<File> &files) { append(files); } /*!< \brief Initialize the file list from another file list. */
+    FileList(int n);
+    FileList(const QStringList &files);
+    FileList(const QList<File> &files) { append(files); }
  
-    QStringList flat() const; /*!< \brief Returns br::File::flat() for each file in the list. */
-    QStringList names() const; /*!<  \brief Returns #br::File::name for each file in the list. */
-    void sort(const QString& key); /*!<  \brief Sort the list based on metadata. */
+    QStringList flat() const;
+    QStringList names() const;
+    void sort(const QString& key);
  
-    QList<int> crossValidationPartitions() const; /*!< \brief Returns the cross-validation partition (default=0) for each file in the list. */
-    int failures() const; /*!< \brief Returns the number of files with br::File::failed(). */
+    QList<int> crossValidationPartitions() const;
+    int failures() const;
  
-    static FileList fromGallery(const File &gallery, bool cache = false); /*!< \brief Create a file list from a br::Gallery. */
+    static FileList fromGallery(const File &gallery, bool cache = false);
 };
  
-/*!
- * \brief A list of matrices associated with a file.
- *
- * The Template is one of two important data structures in OpenBR (the File is the other).
- * A template represents a biometric at various stages of enrollment and can be modified by br::Transform and compared to other templates with br::Distance.
- *
- * While there exist many cases (ex. video enrollment, multiple face detects, per-patch subspace learning, ...) where the template will contain more than one matrix,
- * in most cases templates have exactly one matrix in their list representing a single image at various stages of enrollment.
- * In the cases where exactly one image is expected, the template provides the function m() as an idiom for treating it as a single matrix.
- * Casting operators are also provided to pass the template into image processing functions expecting matrices.
- *
- * Metadata related to the template that is computed during enrollment (ex. bounding boxes, eye locations, quality metrics, ...) should be assigned to the template's #file member.
- */
+
 struct Template : public QList<cv::Mat>
 {
-    File file; /*!< \brief The file from which the template is constructed. */
+    File file;
     Template() {}
-    Template(const File &_file) : file(_file) {} /*!< \brief Initialize #file. */
-    Template(const File &_file, const cv::Mat &mat) : file(_file) { append(mat); } /*!< \brief Initialize #file and append a matrix. */
-    Template(const File &_file, const QList<cv::Mat> &mats) : file(_file) { append(mats); } /*!< \brief Initialize #file and append matricies. */
-    Template(const cv::Mat &mat) { append(mat); } /*!< \brief Append a matrix. */
+    Template(const File &_file) : file(_file) {}
+    Template(const File &_file, const cv::Mat &mat) : file(_file) { append(mat); }
+    Template(const File &_file, const QList<cv::Mat> &mats) : file(_file) { append(mats); }
+    Template(const cv::Mat &mat) { append(mat); }
  
     inline const cv::Mat &m() const { static const cv::Mat NullMatrix;
-                                      return isEmpty() ? qFatal("Empty template."), NullMatrix : last(); } /*!< \brief Idiom to treat the template as a matrix. */
-    inline cv::Mat &m() { return isEmpty() ? append(cv::Mat()), last() : last(); } /*!< \brief Idiom to treat the template as a matrix. */
+                                      return isEmpty() ? qFatal("Empty template."), NullMatrix : last(); }
+    inline cv::Mat &m() { return isEmpty() ? append(cv::Mat()), last() : last(); }
     inline operator const File &() const { return file; }
-    inline cv::Mat &operator=(const cv::Mat &other) { return m() = other; } /*!< \brief Idiom to treat the template as a matrix. */
-    inline operator const cv::Mat&() const { return m(); } /*!< \brief Idiom to treat the template as a matrix. */
-    inline operator cv::Mat&() { return m(); } /*!< \brief Idiom to treat the template as a matrix. */
-    inline operator cv::_InputArray() const { return m(); } /*!< \brief Idiom to treat the template as a matrix. */
-    inline operator cv::_OutputArray() { return m(); } /*!< \brief Idiom to treat the template as a matrix. */
-    inline bool isNull() const { return isEmpty() || !m().data; } /*!< \brief Returns \c true if the template is empty or has no matrix data, \c false otherwise. */
-    inline void merge(const Template &other) { append(other); file.append(other.file); } /*!< \brief Append the contents of another template. */
-
-    /*!
-     * \brief Returns the total number of bytes in all the matrices.
-     */
+    inline cv::Mat &operator=(const cv::Mat &other) { return m() = other; }
+    inline operator const cv::Mat&() const { return m(); }
+    inline operator cv::Mat&() { return m(); }
+    inline operator cv::_InputArray() const { return m(); }
+    inline operator cv::_OutputArray() { return m(); }
+    inline bool isNull() const { return isEmpty() || !m().data; }
+    inline void merge(const Template &other) { append(other); file.append(other.file); }
+
     size_t bytes() const
     {
         size_t bytes = 0;
@@ -419,9 +286,6 @@ struct Template : public QList&lt;cv::Mat&gt;
         return bytes;
     }
  
-    /*!
-     * \brief Copies all the matrices and returns a new template.
-     */
     Template clone() const
     {
         Template other(file);
@@ -430,41 +294,27 @@ struct Template : public QList&lt;cv::Mat&gt;
     }
 };
  
-/*!
- * \brief Serialize a template.
- */
 BR_EXPORT QDataStream &operator<<(QDataStream &stream, const Template &t);
  
-/*!
- * \brief Deserialize a template.
- */
 BR_EXPORT QDataStream &operator>>(QDataStream &stream, Template &t);
  
-/*!
- * \brief A list of templates.
- *
- * Convenience class for working with a list of templates.
- */
 struct TemplateList : public QList<Template>
 {
     TemplateList() {}
-    TemplateList(const QList<Template> &templates) { append(templates); } /*!< \brief Initialize the template list from another template list. */
-    TemplateList(const QList<File> &files) { foreach (const File &file, files) append(file); } /*!< \brief Initialize the template list from a file list. */
-    BR_EXPORT static TemplateList fromGallery(const File &gallery); /*!< \brief Create a template list from a br::Gallery. */
+    TemplateList(const QList<Template> &templates) { append(templates); }
+    TemplateList(const QList<File> &files) { foreach (const File &file, files) append(file); }
+    BR_EXPORT static TemplateList fromGallery(const File &gallery);
+
  
-    /*!< \brief Create a template list from a memory buffer of individual templates. Compatible with '.gal' galleries. */
     BR_EXPORT static TemplateList fromBuffer(const QByteArray &buffer);
  
-    /*!< \brief Ensure labels are in the range [0,numClasses-1]. */
+
     BR_EXPORT static TemplateList relabel(const TemplateList &tl, const QString &propName, bool preserveIntegers);
  
     BR_EXPORT QList<int> indexProperty(const QString &propName, QHash<QString, int> * valueMap=NULL,QHash<int, QVariant> * reverseLookup = NULL) const;
     BR_EXPORT QList<int> indexProperty(const QString &propName, QHash<QString, int> &valueMap, QHash<int, QVariant> &reverseLookup) const;
     BR_EXPORT QList<int> applyIndex(const QString &propName, const QHash<QString, int> &valueMap) const;
  
-    /*!
-     * \brief Returns the total number of bytes in all the templates.
-     */
     template <typename T>
     T bytes() const
     {
@@ -473,9 +323,6 @@ struct TemplateList : public QList&lt;Template&gt;
         return bytes;
     }
  
-    /*!
-     * \brief Returns a list of matrices with one matrix from each template at the specified \em index.
-     */
     QList<cv::Mat> data(int index = 0) const
     {
         QList<cv::Mat> data; data.reserve(size());
@@ -483,9 +330,6 @@ struct TemplateList : public QList&lt;Template&gt;
         return data;
     }
  
-    /*!
-     * \brief Returns a list of #br::TemplateList with each #br::Template in a given #br::TemplateList containing the number of matrices specified by \em partitionSizes.
-     */
     QList<TemplateList> partition(const QList<int> &partitionSizes) const
     {
         int sum = 0;
@@ -517,9 +361,6 @@ struct TemplateList : public QList&lt;Template&gt;
         return partitions;
     }
  
-    /*!
-     * \brief Returns #br::Template::file for each template in the list.
-     */
     FileList files() const
     {
         FileList files; files.reserve(size());
@@ -527,14 +368,8 @@ struct TemplateList : public QList&lt;Template&gt;
         return files;
     }
  
-    /*!
-     * \brief Returns #br::Template::file for each template in the list.
-     */
     FileList operator()() const { return files(); }
  
-    /*!
-     * \brief Returns the number of occurences for each label in the list.
-     */
     template<typename T>
     QMap<T,int> countValues(const QString &propName, bool excludeFailures = false) const
     {
@@ -545,9 +380,6 @@ struct TemplateList : public QList&lt;Template&gt;
         return labelCounts;
     }
  
-    /*!
-     * \brief Merge all the templates together.
-     */
     TemplateList reduced() const
     {
         Template reduced;
@@ -556,9 +388,6 @@ struct TemplateList : public QList&lt;Template&gt;
         return TemplateList() << reduced;
     }
  
-    /*!
-     * \brief Find the indices of templates with specified key, value pairs.
-     */
     template<typename T>
     QList<int> find(const QString& key, const T& value)
     {
@@ -571,41 +400,36 @@ struct TemplateList : public QList&lt;Template&gt;
     }
 };
  
-/*!
- * \brief The base class of all plugins and objects requiring introspection.
- *
- * Plugins are constructed from files.
- * The file's name specifies which plugin to construct and the metadata provides initialization values for the plugin's properties.
- */
+
 class BR_EXPORT Object : public QObject
 {
     Q_OBJECT
-    int firstAvailablePropertyIdx; /*!< \brief Index of the first property that can be set via command line arguments. */
+    int firstAvailablePropertyIdx;
  
 public:
-    File file; /*!< \brief The file used to construct the plugin. */
+    File file;
+
+    virtual void init() {}
+    virtual void store(QDataStream &stream) const;
+    virtual void load(QDataStream &stream);
  
-    virtual void init() {} /*!< \brief Overload this function instead of the default constructor to initialize the derived class. It should be safe to call this function multiple times. */
-    virtual void store(QDataStream &stream) const; /*!< \brief Serialize the object. */
-    virtual void load(QDataStream &stream); /*!< \brief Deserialize the object. Default implementation calls init() after deserialization. */
  
-    /*!< \brief Serialize an object created via the plugin system, including the string used to build the base object, allowing re-creation of the object without knowledge of its base string*/
     virtual void serialize(QDataStream &stream) const
     {
         stream << description();
         store(stream);
     }
  
-    QStringList parameters() const; /*!< \brief A string describing the parameters the object takes. */
-    QStringList prunedArguments(bool expanded = false) const; /*!< \brief A string describing the values the object has, default valued parameters will not be listed. If expanded is true, all abbreviations and model file names should be replaced with a description of the object generated from those names. */
-    QString argument(int index, bool expanded) const; /*!< \brief A string value for the argument at the specified index. */
-    virtual QString description(bool expanded = false) const; /*!< \brief Returns a string description of the object. */
-    
-    void setProperty(const QString &name, QVariant value); /*!< \brief Overload of QObject::setProperty to handle OpenBR data types. */
-    virtual bool setPropertyRecursive(const QString &name, QVariant value); /*!< \brief Recursive version of setProperty, try to set the property on this object, or its children, returns true if successful. */
-    bool setExistingProperty(const QString &name, QVariant value); /*! <\brief attempt to set property 'name' on this object. If name is not a pre-declared property, return false */
+    QStringList parameters() const;
+    QStringList prunedArguments(bool expanded = false) const;
+    QString argument(int index, bool expanded) const;
+    virtual QString description(bool expanded = false) const;
  
-    virtual QList<Object *> getChildren() const; /*!< \brief retrieve children of this object, default version scans properties, subclasses which do not sotre their children as properties must overload. */
+    void setProperty(const QString &name, QVariant value);
+    virtual bool setPropertyRecursive(const QString &name, QVariant value);
+    bool setExistingProperty(const QString &name, QVariant value);
+
+    virtual QList<Object *> getChildren() const;
  
     template<typename T>
     QList<T *> getChildren() const
@@ -620,287 +444,109 @@ public:
         return output;
     }
  
-    static QStringList parse(const QString &string, char split = ','); /*!< \brief Splits the string while respecting lexical scoping of <tt>()</tt>, <tt>[]</tt>, <tt>\<\></tt>, and <tt>{}</tt>. */
+    static QStringList parse(const QString &string, char split = ',');
  
 private:
     template <typename T> friend struct Factory;
     friend class Context;
-    void init(const File &file); /*!< \brief Initializes the plugin's properties from the file's metadata. */
+    void init(const File &file);
 };
  
-/*!
- * \brief The singleton class of global settings.
- *
- * Allocated by br::Context::initialize(), and deallocated by br::Context::finalize().
- *
- * \code
- * // Access the global context using the br::Globals pointer:
- * QString theSDKPath = br::Globals->sdkPath;
- * \endcode
- */
+
 class BR_EXPORT Context : public Object
 {
     Q_OBJECT
     QFile logFile;
  
 public:
-    /*!
-     * \brief Path to <tt>share/openbr/openbr.bib</tt>
-     */
+
     Q_PROPERTY(QString sdkPath READ get_sdkPath WRITE set_sdkPath RESET reset_sdkPath)
     BR_PROPERTY(QString, sdkPath, "")
  
-    /*!
-     * \brief The default algorithm to use when enrolling and comparing templates.
-     */
     Q_PROPERTY(QString algorithm READ get_algorithm WRITE set_algorithm RESET reset_algorithm)
     BR_PROPERTY(QString, algorithm, "")
  
-    /*!
-     * \brief Optional log file to copy <tt>stderr</tt> to.
-     */
     Q_PROPERTY(QString log READ get_log WRITE set_log RESET reset_log)
     BR_PROPERTY(QString, log, "")
  
-    /*!
-     * \brief Path to use when resolving images specified with relative paths.
-     * Multiple paths can be specified using a semicolon separator.
-     */
     Q_PROPERTY(QString path READ get_path WRITE set_path RESET reset_path)
     BR_PROPERTY(QString, path, "")
  
-    /*!
-     * \brief The number of threads to use.
-     */
     Q_PROPERTY(int parallelism READ get_parallelism WRITE set_parallelism RESET reset_parallelism)
     BR_PROPERTY(int, parallelism, std::max(1, QThread::idealThreadCount()+1))
  
-    /*!
-     * \brief Whether or not to use GUI functions
-     */
     Q_PROPERTY(bool useGui READ get_useGui WRITE set_useGui RESET reset_useGui)
     BR_PROPERTY(bool, useGui, true)
  
-    /*!
-     * \brief The maximum number of templates to process in parallel.
-     */
     Q_PROPERTY(int blockSize READ get_blockSize WRITE set_blockSize RESET reset_blockSize)
     BR_PROPERTY(int, blockSize, parallelism * ((sizeof(void*) == 4) ? 128 : 1024))
  
-    /*!
-     * \brief If \c true no messages will be sent to the terminal, \c false by default.
-     */
     Q_PROPERTY(bool quiet READ get_quiet WRITE set_quiet RESET reset_quiet)
     BR_PROPERTY(bool, quiet, false)
  
-    /*!
-     * \brief If \c true extra messages will be sent to the terminal, \c false by default.
-     */
     Q_PROPERTY(bool verbose READ get_verbose WRITE set_verbose RESET reset_verbose)
     BR_PROPERTY(bool, verbose, false)
  
-    /*!
-     * \brief The most resent message sent to the terminal.
-     */
     Q_PROPERTY(QString mostRecentMessage READ get_mostRecentMessage WRITE set_mostRecentMessage RESET reset_mostRecentMessage)
     BR_PROPERTY(QString, mostRecentMessage, "")
  
-    /*!
-     * \brief Used internally to compute progress() and timeRemaining().
-     */
-
     Q_PROPERTY(double currentStep READ get_currentStep WRITE set_currentStep RESET reset_currentStep)
     BR_PROPERTY(double, currentStep, 0)
  
     Q_PROPERTY(double currentProgress READ get_currentProgress WRITE set_currentProgress RESET reset_currentProgress)
     BR_PROPERTY(double, currentProgress, 0)
  
-
-    /*!
-     * \brief Used internally to compute progress() and timeRemaining().
-     */
     Q_PROPERTY(double totalSteps READ get_totalSteps WRITE set_totalSteps RESET reset_totalSteps)
     BR_PROPERTY(double, totalSteps, 0)
  
-    /*!
-     * \brief If \c true enroll 0 or more templates per image, otherwise (default) enroll exactly one.
-     */
     Q_PROPERTY(bool enrollAll READ get_enrollAll WRITE set_enrollAll RESET reset_enrollAll)
     BR_PROPERTY(bool, enrollAll, false)
  
     typedef QHash<QString,QStringList> Filters;
-    /*!
-     * \brief Filters that automatically determine impostor matches based on target (gallery) template metadata.
-     * \see br::FilterDistance
-     */
     Q_PROPERTY(Filters filters READ get_filters WRITE set_filters RESET reset_filters)
     BR_PROPERTY(Filters, filters, Filters())
  
-    /*!
-     * \brief File output is redirected here if the file's basename is 'buffer', clearing previous contents.
-     */
     Q_PROPERTY(QByteArray buffer READ get_buffer WRITE set_buffer RESET reset_buffer)
     BR_PROPERTY(QByteArray, buffer, QByteArray())
  
-    /*!
-     * \brief Enable/disable score normalization.
-     */
     Q_PROPERTY(bool scoreNormalization READ get_scoreNormalization WRITE set_scoreNormalization RESET reset_scoreNormalization)
     BR_PROPERTY(bool, scoreNormalization, true)
  
-    /*!
-     * \brief Perform k-fold cross validation.
-     */
     Q_PROPERTY(int crossValidate READ get_crossValidate WRITE set_crossValidate RESET reset_crossValidate)
     BR_PROPERTY(int, crossValidate, 0)
  
-    /*!
-     * \brief List of paths sub-models will be searched for on
-     */
     Q_PROPERTY(QList<QString> modelSearch READ get_modelSearch WRITE set_modelSearch RESET reset_modelSearch)
     BR_PROPERTY(QList<QString>, modelSearch, QList<QString>() )
  
-    QHash<QString,QString> abbreviations; /*!< \brief Used by br::Transform::make() to expand abbreviated algorithms into their complete definitions. */
-    QTime startTime; /*!< \brief Used to estimate timeRemaining(). */
+    QHash<QString,QString> abbreviations;
+    QTime startTime;
  
-    /*!
-     * \brief Returns true if \em name is queryable using <a href="http://doc.qt.digia.com/qt/qobject.html#property">QObject::property</a>
-     * \param name The property key to check for existance.
-     * \return \c true if \em name is a property, \c false otherwise.
-     * \see set
-     */
     bool contains(const QString &name);
-
-    /*!
-     * \brief Prints current progress statistics to \em stdout.
-     * \see progress
-     */
     void printStatus();
-
-    /*!
-     * \brief Returns the completion percentage of a call to br::Train(), br::Enroll() or br::Compare().
-     * \return float Fraction completed.
-     *  - \c -1 if no task is underway.
-     * \see timeRemaining
-     */
     float progress() const;
-
-    /*!
-     * \brief Set a global property.
-     * \param key Global property key.
-     * \param value Global property value.
-     * \see contains
-     */
     void setProperty(const QString &key, const QString &value);
-
-    /*!
-     * \brief Returns the time remaining in seconds of a call to \ref br_train, \ref br_enroll or \ref br_compare.
-     * \return int Time remaining in seconds.
-     *  - \c -1 if no task is underway.
-     * \see progress
-     */
     int timeRemaining() const;
  
-    /*!
-     * \brief Returns \c true if \em sdkPath is valid, \c false otherwise.
-     * \param sdkPath The path to <tt>share/openbr/openbr.bib</tt>
-     */
     static bool checkSDKPath(const QString &sdkPath);
-
-    /*!
-     * \brief Call \em once at the start of the application to allocate global variables.
-     * \code
-     * int main(int argc, char *argv[])
-     * {
-     *     br::Context::initialize(argc, argv);
-     *
-     *     // ...
-     *
-     *     br::Context::finalize();
-     *     return 0;
-     * }
-     * \endcode
-     * \param argc As provided by <tt>main()</tt>.
-     * \param argv As provided by <tt>main()</tt>.
-     * \param sdkPath The path to the folder containing <tt>share/openbr/openbr.bib</tt>
-     *                 By default <tt>share/openbr/openbr.bib</tt> will be searched for relative to:
-     *                   -# The working directory
-     *                   -# The executable's location
-     * \param useGui Create a QApplication instead of a QCoreApplication.
-     * \note Tiggers \em abort() on failure to locate <tt>share/openbr/openbr.bib</tt>.
-     * \note <a href="http://qt-project.org/">Qt</a> users should instead call this <i>after</i> initializing QApplication.
-     * \see finalize
-     */
     static void initialize(int &argc, char *argv[], QString sdkPath = "", bool useGui = true);
-
-    /*!
-     * \brief Call \em once at the end of the application to deallocate global variables.
-     * \see initialize
-     */
     static void finalize();
-
-    /*!
-     * \brief Returns a string with the name, version, and copyright of the project.
-     * \return A string suitable for printing to the terminal or displaying in a dialog box.
-     * \see version
-     */
     static QString about();
-
-    /*!
-     * \brief Returns the version of the SDK.
-     * \return A string with the format: <i>\<MajorVersion\></i><tt>.</tt><i>\<MinorVersion\></i><tt>.</tt><i>\<PatchVersion\></i>
-     * \see about scratchPath
-     */
     static QString version();
-
-    /*!
-     * \brief Returns the scratch directory.
-     * \return A string with the format: <i>\</path/to/user/home/\></i><tt>OpenBR-</tt><i>\<MajorVersion\></i><tt>.</tt><i>\<MinorVersion\></i>
-     * \note This should be used as the root directory for managing temporary files and providing process persistence.
-     * \see version
-     */
     static QString scratchPath();
-
-    /*!
-     * \brief Returns names and parameters for the requested objects.
-     *
-     * Each object is \c \\n seperated. Arguments are seperated from the object name with a \c \\t.
-     * \param abstractions Regular expression of the abstractions to search.
-     * \param implementations Regular expression of the implementations to search.
-     * \param parameters Include parameters after object name.
-     * \note \ref managed_return_value
-     * \note This function uses Qt's <a href="http://doc.qt.digia.com/stable/qregexp.html">QRegExp</a> syntax.
-     */
     static QStringList objects(const char *abstractions = ".*", const char *implementations = ".*", bool parameters = true);
  
 private:
     static void messageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg);
 };
  
-/*!
- * \brief The globally available settings.
- *
- * Initialized by Context::initialize() and destroyed with Context::finalize().
- */
 BR_EXPORT extern Context *Globals;
  
-/*!
- * \brief For run time construction of objects from strings.
- *
- * All plugins must derive from br::Object.
- * The factory is a templated struct to allow for different types of plugins.
- *
- * Uses the Industrial Strength Pluggable Factory model described <a href="http://adtmag.com/articles/2000/09/25/industrial-strength-pluggable-factories.aspx">here</a>.
- */
+
 template <class T>
 struct Factory
 {
     virtual ~Factory() {}
  
-    /*!
-     * \brief Constructs a plugin from a file.
-     */
-    //! [Factory make]
     static T *make(const File &file)
     {
         QString name = file.get<QString>("plugin", "");
@@ -914,11 +560,7 @@ struct Factory
         static_cast<Object*>(object)->init(file);
         return object;
     }
-    //! [Factory make]
  
-    /*!
-     * \brief Constructs all the available plugins.
-     */
     static QList< QSharedPointer<T> > makeAll()
     {
         QList< QSharedPointer<T> > objects;
@@ -929,14 +571,8 @@ struct Factory
         return objects;
     }
  
-    /*!
-     * \brief Returns the names of the available plugins.
-     */
     static QStringList names() { return registry ? registry->keys() : QStringList(); }
  
-    /*!
-     * \brief Returns the parameters for a plugin.
-     */
     static QString parameters(const QString &name)
     {
         if (!registry) return QString();
@@ -946,9 +582,6 @@ struct Factory
     }
  
 protected:
-    /*!
-     * \brief For internal use. Nifty trick to register objects using a constructor.
-     */
     Factory(QString name)
     {
         if (!registry) registry = new QMap<QString,Factory<T>*>();
@@ -979,49 +612,22 @@ class FactoryInstance : public Factory&lt;_Abstraction&gt;
 template <class _Abstraction, class _Implementation>
 const FactoryInstance<_Abstraction,_Implementation> FactoryInstance<_Abstraction,_Implementation>::registerThis;
  
-/*!
- * Macro to register a br::Factory plugin.
- *
- * \b Example:<br>
- * Note the use of \c Q_OBJECT at the beginning of the class declaration and \c BR_REGISTER after the class declaration.
- * \snippet openbr/plugins/misc.cpp example_transform
- */
 #define BR_REGISTER(ABSTRACTION,IMPLEMENTATION)       \
 template class                                        \
 br::FactoryInstance<br::ABSTRACTION, IMPLEMENTATION>;
  
-/*!
- * \defgroup initializers Initializers
- * \brief Plugins that initialize resources.
- */
  
-/*!
- * \ingroup initializers
- * \brief Plugin base class for initializing resources.
- */
 class BR_EXPORT Initializer : public Object
 {
     Q_OBJECT
  
 public:
     virtual ~Initializer() {}
-    virtual void initialize() const = 0;  /*!< \brief Called once at the end of br::Context::initialize(). */
-    virtual void finalize() const {}  /*!< \brief Called once at the beginning of br::Context::finalize(). */
+    virtual void initialize() const = 0;
+    virtual void finalize() const {}
 };
  
-/*!
- * \defgroup outputs Outputs
- * \brief Plugins that store template comparison results.
- */
-
-/*!
- * \ingroup outputs
- * \brief Plugin base class for storing template comparison results.
- *
- * An \em output is a br::File representing the result comparing templates.
- * br::File::suffix() is used to determine which plugin should handle the output.
- * \note Handle serialization to disk in the derived class destructor.
- */
+
 class BR_EXPORT Output : public Object
 {
     Q_OBJECT
@@ -1032,16 +638,16 @@ public:
     BR_PROPERTY(int, blockRows, -1)
     BR_PROPERTY(int, blockCols, -1)
  
-    FileList targetFiles; /*!< \brief List of files representing the gallery templates. */
-    FileList queryFiles; /*!< \brief List of files representing the probe templates. */
-    bool selfSimilar; /*!< \brief \c true if the \em targetFiles == \em queryFiles, \c false otherwise. */
+    FileList targetFiles;
+    FileList queryFiles;
+    bool selfSimilar;
  
     virtual ~Output() {}
-    virtual void initialize(const FileList &targetFiles, const FileList &queryFiles); /*!< \brief Initializes class data members. */
-    virtual void setBlock(int rowBlock, int columnBlock); /*!< \brief Set the current block. */
-    virtual void setRelative(float value, int i, int j); /*!< \brief Set a score relative to the current block. */
+    virtual void initialize(const FileList &targetFiles, const FileList &queryFiles);
+    virtual void setBlock(int rowBlock, int columnBlock);
+    virtual void setRelative(float value, int i, int j);
  
-    static Output *make(const File &file, const FileList &targetFiles, const FileList &queryFiles); /*!< \brief Make an output from a file and gallery/probe file lists. */
+    static Output *make(const File &file, const FileList &targetFiles, const FileList &queryFiles);
  
 private:
     QSharedPointer<Output> next;
@@ -1049,81 +655,50 @@ private:
     virtual void set(float value, int i, int j) = 0;
 };
  
-/*!
- * \ingroup outputs
- * \brief Plugin derived base class for storing outputs as matrices.
- */
+
 class BR_EXPORT MatrixOutput : public Output
 {
     Q_OBJECT
  
 public:
-    cv::Mat data; /*!< \brief The similarity matrix. */
+    cv::Mat data;
  
-    /*!
-     * \brief Make a MatrixOutput from gallery and probe file lists.
-     */
     static MatrixOutput *make(const FileList &targetFiles, const FileList &queryFiles);
  
 protected:
-    QString toString(int row, int column) const; /*!< \brief Converts the value requested similarity score to a string. */
+    QString toString(int row, int column) const;
  
 private:
     void initialize(const FileList &targetFiles, const FileList &queryFiles);
     void set(float value, int i, int j);
 };
  
-/*!
- * \defgroup formats Formats
- * \brief Plugins that read a matrix.
- */
-
-/*!
- * \ingroup formats
- * \brief Plugin base class for reading a template from disk.
- *
- * A \em format is a br::File representing a template (ex. jpg image) on disk.
- * br::File::suffix() is used to determine which plugin should handle the format.
- */
 class BR_EXPORT Format : public Object
 {
     Q_OBJECT
  
 public:
     virtual ~Format() {}
-    virtual Template read() const = 0; /*!< \brief Returns a br::Template created by reading #br::Object::file. */
-    virtual void write(const Template &t) const = 0; /*!< \brief Writes the br::Template to #br::Object::file. */
+    virtual Template read() const = 0;
+    virtual void write(const Template &t) const = 0;
     static Template read(const QString &file);
     static void write(const QString &file, const Template &t);
 };
  
-/*!
- * \defgroup galleries Galleries
- * \brief Plugins that store templates.
- */
-
-/*!
- * \ingroup galleries
- * \brief Plugin base class for storing a list of enrolled templates.
- *
- * A \em gallery is a file representing a br::TemplateList serialized to disk.
- * br::File::suffix() is used to determine which plugin should handle the gallery.
- * \note Handle serialization to disk in the derived class destructor.
- */
 class BR_EXPORT Gallery : public Object
 {
-    Q_OBJECT    
+    Q_OBJECT
 public:
     Q_PROPERTY(int readBlockSize READ get_readBlockSize WRITE set_readBlockSize RESET reset_readBlockSize STORED false)
     BR_PROPERTY(int, readBlockSize, Globals->blockSize)
  
     virtual ~Gallery() {}
-    TemplateList read(); /*!< \brief Retrieve all the stored templates. */
-    FileList files(); /*!< \brief Retrieve all the stored template files. */
-    virtual TemplateList readBlock(bool *done) = 0; /*!< \brief Retrieve a portion of the stored templates. */
-    void writeBlock(const TemplateList &templates); /*!< \brief Serialize a template list. */
-    virtual void write(const Template &t) = 0; /*!< \brief Serialize a template. */
-    static Gallery *make(const File &file); /*!< \brief Make a gallery to/from a file on disk. */
+    TemplateList read();
+    FileList files();
+    virtual TemplateList readBlock(bool *done) = 0;
+    void writeBlock(const TemplateList &templates);
+    virtual void write(const Template &t) = 0;
+    static Gallery *make(const File &file);
     void init();
  
     virtual qint64 totalSize() { return std::numeric_limits<qint64>::max(); }
@@ -1133,20 +708,7 @@ private:
     QSharedPointer<Gallery> next;
 };
  
-/*!
- * \defgroup transforms Transforms
- * \brief Plugins that process a template.
- */
  
-/*!
- * \addtogroup transforms
- *  @{
- */
-
-/*!
- * \brief For asynchronous events during template projection.
- * \see Transform::getEvent
- */
 class TemplateEvent : public QObject
 {
     Q_OBJECT
@@ -1161,14 +723,7 @@ signals:
     void theSignal(const Template &output) const;
 };
  
-/*!
- * \brief Plugin base class for processing a template.
- *
- * Transforms support the idea of \em training and \em projecting,
- * whereby they are (optionally) given example images and are expected learn how to transform new instances into an alternative,
- * hopefully more useful, basis for the recognition task at hand.
- * Transforms can be chained together to support the declaration and use of arbitrary algorithms at run time.
- */
+
 class BR_EXPORT Transform : public Object
 {
     Q_OBJECT
@@ -1177,53 +732,31 @@ public:
     bool independent, trainable;
  
     virtual ~Transform() {}
-    static Transform *make(QString str, QObject *parent); /*!< \brief Make a transform from a string. */
-    static QSharedPointer<Transform> fromAlgorithm(const QString &algorithm, bool preprocess=false); /*!< \brief Retrieve an algorithm's transform. If preprocess is true, attaches a stream transform as the root of the algorithm*/
+    static Transform *make(QString str, QObject *parent);
+    static QSharedPointer<Transform> fromAlgorithm(const QString &algorithm, bool preprocess=false);
     static QSharedPointer<Transform> fromComparison(const QString &algorithm);
  
-    virtual Transform *clone() const; /*!< \brief Copy the transform. */
+    virtual Transform *clone() const;
  
-    /*!< \brief Train the transform. */
-    virtual void train(const TemplateList &data);
  
-    /*!< \brief Train the transform, separate list items represent the way calls to project would be broken up
-     * Transforms that have to call train on another transform should implement train(QList), the strucutre of the
-     * list should mirror the calls that would be made to project by the parent transform. For example, DistributeTemplates
-     * would make a separate project call for each template it receives, and therefore sets the QList to contain single item
-     * template lists before passing it on.
-     * This version of train(QList) is appropriate for transforms that perform training on themselves, and don't call train
-     * on other transforms. It combines everything in data into a single TemplateList, then calls train(TemplateList)
-     */
+    virtual void train(const TemplateList &data);
     virtual void train(const QList<TemplateList> &data);
  
-    /*!< \brief Apply the transform to a single template. Typically used by independent transforms */
-    virtual void project(const Template &src, Template &dst) const = 0;
  
-    /*!< \brief Apply the transform, taking the full template list as input.
-     * A TemplateList is what is typically passed from transform to transform. Transforms that just
-     * need to operatoe on a single template at a time (and want to output exactly 1 template) can implement
-     * project(template), but transforms that want to change the structure of the TemplateList (such as flatten), or
-     * or output more or less than one template (e.g. detection methods) should implement project(TemplateList) directly
-     */
+    virtual void project(const Template &src, Template &dst) const = 0;
     virtual void project(const TemplateList &src, TemplateList &dst) const;
  
-    /*!< \brief Apply the transform to a single template, may update the transform's internal state
-     * By default, just call project, we can always call a const function from a non-const function.
-     * If a transform implements projectUpdate, it should report true to timeVarying so that it can be
-     * handled correctly by e.g. Stream.
-     */
     virtual void projectUpdate(const Template &src, Template &dst)
     {
         project(src, dst);
     }
  
-    /*!< \brief Apply the transform, may update the transform's internal state. */
     virtual void projectUpdate(const TemplateList &src, TemplateList &dst)
     {
         project(src,dst);
     }
  
-    /*!< \brief inplace projectUpdate. */
+
     void projectUpdate(Template &srcdst)
     {
         Template dst;
@@ -1231,7 +764,6 @@ public:
         srcdst = dst;
     }
  
-    /*!< \brief inplace projectUpdate. */
     void projectUpdate(TemplateList &srcdst)
     {
         TemplateList dst;
@@ -1239,24 +771,9 @@ public:
         srcdst = dst;
     }
  
-    /*!
-     * Time-varying transforms may move away from a single input->single output model, and only emit
-     * templates under some conditions (e.g. a tracking thing may emit a template for each detected
-     * unique object), in this case finalize indicates that no further calls to project will be made
-     * and the transform can emit a final set if templates if it wants. Time-invariant transforms
-     * don't have to do anything.
-     */
     virtual void finalize(TemplateList &output) { output = TemplateList(); }
-
-    /*!
-     * \brief Does the transform require the non-const version of project? Can vary for aggregation type transforms
-     * (if their children are time varying, they are also time varying, otherwise probably not)
-     */
     virtual bool timeVarying() const { return false; }
  
-    /*!
-     * \brief Convenience function equivalent to project().
-     */
     inline Template operator()(const Template &src) const
     {
         Template dst;
@@ -1265,9 +782,6 @@ public:
         return dst;
     }
  
-    /*!
-     * \brief Convenience function equivalent to project().
-     */
     inline TemplateList operator()(const TemplateList &src) const
     {
         TemplateList dst;
@@ -1275,21 +789,9 @@ public:
         return dst;
     }
  
-    /*!
-     * \brief Perform the minimum amount of work necessary to make a
-     * transform that can be used safely from a different thread than this
-     * transform. For transforms that aren't time-varying, nothing needs to be
-     * done, returning this is sufficient. Time varying transforms should implement this method
-     * and copy enough of their state that projectUpdate can safely be called on the original
-     * instance, and the copy concurrently.
-     */
     virtual Transform *smartCopy(bool &newTransform) { newTransform=false; return this;}
-
     virtual Transform *smartCopy() {bool junk; return smartCopy(junk);}
  
-    /*!
-     * \brief Recursively retrieve a named event, returns NULL if an event is not found.
-     */
     virtual TemplateEvent *getEvent(const QString &name);
  
     static Transform *deserialize(QDataStream &stream)
@@ -1301,88 +803,63 @@ public:
         return res;
     }
  
-     /*!
-     * \brief Return a pointer to a simplified version of this transform (if possible). Transforms which are only active during training should remove
-     * themselves by either returning their child transforms (where relevant) or returning NULL. Set newTransform to true if the transform returned is newly allocated.
-     */
     virtual Transform * simplify(bool &newTransform) { newTransform = false; return this; }
  
 protected:
-    Transform(bool independent = true, bool trainable = true); /*!< \brief Construct a transform. */
-    inline Transform *make(const QString &description) { return make(description, this); } /*!< \brief Make a subtransform. */
+    Transform(bool independent = true, bool trainable = true);
+    inline Transform *make(const QString &description) { return make(description, this); }
 };
  
-/*!
- * \brief Convenience function equivalent to project().
- */
 inline Template &operator>>(Template &srcdst, const Transform &f)
 {
     srcdst = f(srcdst);
     return srcdst;
 }
  
-/*!
- * \brief Convenience function equivalent to project().
- */
 inline TemplateList &operator>>(TemplateList &srcdst, const Transform &f)
 {
     srcdst = f(srcdst);
     return srcdst;
 }
  
-/*!
- * \brief Convenience function equivalent to store().
- */
 inline QDataStream &operator<<(QDataStream &stream, const Transform &f)
 {
     f.store(stream);
     return stream;
 }
  
-/*!
- * \brief Convenience function equivalent to load().
- */
 inline QDataStream &operator>>(QDataStream &stream, Transform &f)
 {
     f.load(stream);
     return stream;
 }
-/*! @}*/
  
-/*!
- * \defgroup distances Distances
- * \brief Plugins that compare templates.
- */
  
-/*!
- * \ingroup distances
- * \brief Plugin base class for comparing templates.
- */
 class BR_EXPORT Distance : public Object
 {
     Q_OBJECT
  
 public:
     virtual ~Distance() {}
-    static Distance *make(QString str, QObject *parent); /*!< \brief Make a distance from a string. */
+    static Distance *make(QString str, QObject *parent);
  
-    static QSharedPointer<Distance> fromAlgorithm(const QString &algorithm); /*!< \brief Retrieve an algorithm's distance. */
-    virtual bool trainable() { return true; } /*!< \brief \c true if The distance implements train(), false otherwise. */
-    virtual void train(const TemplateList &src) = 0; /*!< \brief Train the distance. */
-    virtual void compare(const TemplateList &target, const TemplateList &query, Output *output) const; /*!< \brief Compare two template lists. */
-    virtual QList<float> compare(const TemplateList &targets, const Template &query) const; /*!< \brief Compute the normalized distance between a template and a template list. */
-    virtual float compare(const Template &a, const Template &b) const; /*!< \brief Compute the distance between two templates. */
-    virtual float compare(const cv::Mat &a, const cv::Mat &b) const; /*!< \brief Compute the distance between two biometric signatures. */
-    virtual float compare(const uchar *a, const uchar *b, size_t size) const; /*!< \brief Compute the distance between two buffers. */
+    static QSharedPointer<Distance> fromAlgorithm(const QString &algorithm);
+    virtual bool trainable() { return true; }
+    virtual void train(const TemplateList &src) = 0;
+    virtual void compare(const TemplateList &target, const TemplateList &query, Output *output) const;
+    virtual QList<float> compare(const TemplateList &targets, const Template &query) const;
+    virtual float compare(const Template &a, const Template &b) const;
+    virtual float compare(const cv::Mat &a, const cv::Mat &b) const;
+    virtual float compare(const uchar *a, const uchar *b, size_t size) const;
  
 protected:
-    inline Distance *make(const QString &description) { return make(description, this); } /*!< \brief Make a subdistance. */
+    inline Distance *make(const QString &description) { return make(description, this); }
  
 private:
     virtual void compareBlock(const TemplateList &target, const TemplateList &query, Output *output, int targetOffset, int queryOffset) const;
  
     friend struct AlgorithmCore;
-    virtual bool compare(const File &targetGallery, const File &queryGallery, const File &output) const /*!< \brief Escape hatch for algorithms that need customized file I/O during comparison. */
+    virtual bool compare(const File &targetGallery, const File &queryGallery, const File &output) const
         { (void) targetGallery; (void) queryGallery; (void) output; return false; }
 };
  
@@ -1393,7 +870,7 @@ class BR_EXPORT Representation : public Object
 public:
     virtual ~Representation() {}
  
-    static Representation *make(QString str, QObject *parent); /*!< \brief Make a representation from a string. */
+    static Representation *make(QString str, QObject *parent);
     virtual cv::Mat preprocess(const cv::Mat &image) const { return image; }
     virtual void train(const QList<cv::Mat> &images, const QList<float> &labels) { (void) images; (void)labels; }
     // By convention, an empty indices list will result in all feature responses being calculated
@@ -1409,90 +886,41 @@ class BR_EXPORT Classifier : public Object
 public:
     virtual ~Classifier() {}
  
-    static Classifier *make(QString str, QObject *parent); /*!< \brief Make a classifier from a string. */
+    static Classifier *make(QString str, QObject *parent);
     virtual void train(const QList<cv::Mat> &images, const QList<float> &labels) = 0;
     // By convention, classify should return a value normalized such that the threshold is 0. Negative values
     // can be interpreted as a negative classification and positive values as a positive classification.
     virtual float classify(const cv::Mat &image) const = 0;
 };
  
-/*!
-* \brief Returns \c true if the algorithm is a classifier, \c false otherwise.
-*
-* Classifers have no br::Distance associated with their br::Transform.
-* Instead they populate br::Template::file \c Label metadata field with the predicted class.
-*/
+
 BR_EXPORT bool IsClassifier(const QString &algorithm);
  
-/*!
- * \brief High-level function for creating models.
- * \see br_train
- */
 BR_EXPORT void Train(const File &input, const File &model);
  
-/*!
- * \brief High-level function for creating galleries.
- * \see br_enroll
- */
 BR_EXPORT void Enroll(const File &input, const File &gallery = File());
  
-/*!
- * \brief High-level function for enrolling templates.
- * \see br_enroll
- */
 BR_EXPORT void Enroll(TemplateList &tmpl);
  
-/*!
- * \brief A naive alternative to \ref br::Enroll
- */
 BR_EXPORT void Project(const File &input, const File &output);
  
-/*!
- * \brief High-level function for comparing galleries.
- * \see br_compare
- */
 BR_EXPORT void Compare(const File &targetGallery, const File &queryGallery, const File &output);
-/*!
- * \brief High-level function for comparing templates.
- */
-BR_EXPORT void CompareTemplateLists(const TemplateList &target, const TemplateList &query, Output *output);
  
+BR_EXPORT void CompareTemplateLists(const TemplateList &target, const TemplateList &query, Output *output);
  
-/*!
- * \brief High-level function for doing a series of pairwise comparisons.
- * \see br_pairwise_compare
- */
 BR_EXPORT void PairwiseCompare(const File &targetGallery, const File &queryGallery, const File &output);
  
-/*!
- * \brief Change file formats.
- * \param fileType One of \c Format, \c Gallery, or \c Output.
- * \param inputFile The source file to convert from.
- * \param outputFile The destination file to convert to.
- */
 BR_EXPORT void Convert(const File &fileType, const File &inputFile, const File &outputFile);
  
-/*!
- * \brief Concatenate several galleries into one.
- * \param inputGalleries List of galleries to concatenate.
- * \param outputGallery Gallery to store the concatenated result.
- * \note outputGallery must not be in inputGalleries.
- */
 BR_EXPORT void Cat(const QStringList &inputGalleries, const QString &outputGallery);
  
-/*!
- * \brief Deduplicate a gallery.
- * \param inputGallery Gallery to deduplicate.
- * \param outputGallery Gallery to store the deduplicated result.
- * \param threshold Match score threshold to determine duplicates.
- */
 BR_EXPORT void Deduplicate(const File &inputGallery, const File &outputGallery, const QString &threshold);
  
 BR_EXPORT Transform *wrapTransform(Transform *base, const QString &target);
  
 BR_EXPORT Transform *pipeTransforms(QList<Transform *> &transforms);
  
-/*! @}*/
+
  
 } // namespace br
  
@@ -26,17 +26,17 @@ namespace br
  * \ingroup transforms
  * \brief Wraps OpenCV's Ada Boost framework
  * \author Scott Klum \cite sklum
- * \see http://docs.opencv.org/modules/ml/doc/boosting.html
- * \property enum type Type of Adaboost to perform. Options are: [Discrete, Real, Logit, Gentle] Default is Real.
- * \property enum splitCriteria Splitting criteria used to choose optimal splits during a weak tree construction. Options are: [Default, Gini, Misclass, Sqerr] Default is Default.
- * \property int weakCount Maximum number of weak classifiers per stage. Default is 100.
- * \property float trimRate A threshold between 0 and 1 used to save computational time. Samples with summary weight \leq 1 - weight\_trim\_rate do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality. Default is 0.95.
- * \property int folds OpenCV parameter variable. Default value is 0.
- * \property int maxDepth Maximum height of each weak classifier tree. Default is 1 (stumps).
- * \property bool returnConfidence Return the confidence value of the classification or the class value of the classification. Default is true (return confidence value).
- * \property bool overwriteMat If true, the output template will be a 1x1 matrix with value equal to the confidence or classification (depending on returnConfidence). If false the output template will be the same as the input template. Default is true.
- * \property QString inputVariable Metadata variable storing the label for each template. Default is "Label".
- * \property QString outputVariable Metadata variable to store the confidence or classification of each template (depending on returnConfidence). If overwriteMat is true nothing will be written here. Default is "".
+ * \br_link http://docs.opencv.org/modules/ml/doc/boosting.html
+ * \br_property type enum Type of Adaboost to perform. Options are: [Discrete, Real, Logit, Gentle] Default is Real.
+ * \br_property splitCriteria enum Splitting criteria used to choose optimal splits during a weak tree construction. Options are: [Default, Gini, Misclass, Sqerr] Default is Default.
+ * \br_property weakCount int Maximum number of weak classifiers per stage. Default is 100.
+ * \br_property trimRate float A threshold between 0 and 1 used to save computational time. Samples with summary weight \leq 1 - weight\_trim\_rate do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality. Default is 0.95.
+ * \br_property folds int OpenCV parameter variable. Default value is 0.
+ * \br_property maxDepth int Maximum height of each weak classifier tree. Default is 1 (stumps).
+ * \br_property returnConfidence bool Return the confidence value of the classification or the class value of the classification. Default is true (return confidence value).
+ * \br_property overwriteMat bool If true, the output template will be a 1x1 matrix with value equal to the confidence or classification (depending on returnConfidence). If false the output template will be the same as the input template. Default is true.
+ * \br_property inputVariable QString Metadata variable storing the label for each template. Default is "Label".
+ * \br_property outputVariable QString Metadata variable to store the confidence or classification of each template (depending on returnConfidence). If overwriteMat is true nothing will be written here. Default is "".
  */
 class AdaBoostTransform : public Transform
 {
@@ -28,10 +28,12 @@ namespace br
 /*!
  * \ingroup transforms
  * \brief Face Recognition Using Early Biologically Inspired Features
- * \see Min Li (IBM China Research Lab, China), Nalini Ratha (IBM Watson Research Center, USA), Weihong Qian (IBM China Research Lab, China), Shenghua Bao (IBM China Research Lab, China), Zhong Su (IBM China Research Lab, China)
+ * \br_paper Li, Min, et al.
+ *           "Face recognition using early biologically inspired features."
+ *           Biometrics: Theory, Applications and Systems (BTAS), 2013 IEEE Sixth International Conference on. IEEE, 2013.
  * \author Josh Klontz \cite jklontz
- * \property int N The number of scales. Default is 6.
- * \property int M The number of orientations between 0 and pi. Default is 9.
+ * \br_property int N The number of scales. Default is 6.
+ * \br_property int M The number of orientations between 0 and pi. Default is 9.
  */
 class EBIFTransform : public UntrainableTransform
 {
@@ -26,18 +26,18 @@ namespace br
  * \ingroup transforms
  * \brief Wraps OpenCV's random trees framework
  * \author Scott Klum \cite sklum
- * \see http://docs.opencv.org/modules/ml/doc/random_trees.html
- * \property bool classification If true the labels are expected to be categorical. Otherwise they are expected to be numerical. Default is true.
- * \property float splitPercentage Used to calculate the minimum number of samples per split in a random tree. The minimum number of samples is calculated as the number of samples x splitPercentage. Default is 0.01.
- * \property int maxDepth The maximum depth of each decision tree. Default is std::numeric_limits<int>::max() and typically should be set by the user.
- * \property int maxTrees The maximum number of trees in the forest. Default is 10.
- * \property float forestAccuracy A sufficient accuracy for the forest for training to terminate. Used if termCrit is EPS or Both. Default is 0.1.
- * \property bool returnConfidence If both classification and returnConfidence are use a fuzzy class label as the output of the forest. Default is true.
- * \property bool overwriteMat If true set dst to be a 1x1 Mat with the forest response as its value. Otherwise append the forest response to metadata using outputVariable as a key. Default is true.
- * \property QString inputVariable The metadata key for each templates label. Default is "Label".
- * \property QString outputVariable The metadata key for the forest response if overwriteMat is false. Default is "".
- * \property bool weight If true and classification is true the random forest will use prior accuracies. Default is false.
- * \property enum termCrit Termination criteria for training the random forest. Options are Iter, EPS and Both. Iter terminates when the maximum number of trees is reached. EPS terminates when forestAccuracy is met. Both terminates when either is true. Default is Iter.
+ * \br_link http://docs.opencv.org/modules/ml/doc/random_trees.html
+ * \br_property bool classification If true the labels are expected to be categorical. Otherwise they are expected to be numerical. Default is true.
+ * \br_property float splitPercentage Used to calculate the minimum number of samples per split in a random tree. The minimum number of samples is calculated as the number of samples x splitPercentage. Default is 0.01.
+ * \br_property int maxDepth The maximum depth of each decision tree. Default is std::numeric_limits<int>::max() and typically should be set by the user.
+ * \br_property int maxTrees The maximum number of trees in the forest. Default is 10.
+ * \br_property float forestAccuracy A sufficient accuracy for the forest for training to terminate. Used if termCrit is EPS or Both. Default is 0.1.
+ * \br_property bool returnConfidence If both classification and returnConfidence are use a fuzzy class label as the output of the forest. Default is true.
+ * \br_property bool overwriteMat If true set dst to be a 1x1 Mat with the forest response as its value. Otherwise append the forest response to metadata using outputVariable as a key. Default is true.
+ * \br_property QString inputVariable The metadata key for each templates label. Default is "Label".
+ * \br_property QString outputVariable The metadata key for the forest response if overwriteMat is false. Default is "".
+ * \br_property bool weight If true and classification is true the random forest will use prior accuracies. Default is false.
+ * \br_property enum termCrit Termination criteria for training the random forest. Options are Iter, EPS and Both. Iter terminates when the maximum number of trees is reached. EPS terminates when forestAccuracy is met. Both terminates when either is true. Default is Iter.
  */
 class ForestTransform : public Transform
 {
@@ -187,8 +187,8 @@ BR_REGISTER(Transform, ForestTransform)
  * \ingroup transforms
  * \brief Wraps OpenCV's random trees framework to induce features
  * \author Scott Klum \cite sklum
- * \see https://lirias.kuleuven.be/bitstream/123456789/316661/1/icdm11-camready.pdf
- * \property bool useRegressionValue SCOTT FILL ME IN.
+ * \br_link https://lirias.kuleuven.be/bitstream/123456789/316661/1/icdm11-camready.pdf
+ * \br_property bool useRegressionValue SCOTT FILL ME IN.
  */
 class ForestInductionTransform : public ForestTransform
 {
@@ -28,7 +28,7 @@ namespace br
 /*!
  * \ingroup initializers
  * \brief Initialize Eigen
- * http://eigen.tuxfamily.org/dox/TopicMultiThreading.html
+ * \br_link http://eigen.tuxfamily.org/dox/TopicMultiThreading.html
  * \author Scott Klum \cite sklum
  */
 class EigenInitializer : public Initializer
@@ -49,9 +49,9 @@ BR_REGISTER(Initializer, EigenInitializer)
  * \author Brendan Klare \cite bklare
  * \author Josh Klontz \cite jklontz
  *
- * \property float keep Options are: [keep < 0 - All eigenvalues are retained, keep == 0 - No PCA is performed and the eigenvectors form an identity matrix, 0 < keep < 1 - Keep is the fraction of the variance to retain, keep >= 1 - keep is the number of leading eigenvectors to retain] Default is 0.95.
- * \property int drop BRENDAN OR JOSH FILL ME IN. Default is 0.
- * \property bool whiten BRENDAN OR JOSH FILL ME IN. Default is false.
+ * \br_property float keep Options are: [keep < 0 - All eigenvalues are retained, keep == 0 - No PCA is performed and the eigenvectors form an identity matrix, 0 < keep < 1 - Keep is the fraction of the variance to retain, keep >= 1 - keep is the number of leading eigenvectors to retain] Default is 0.95.
+ * \br_property int drop BRENDAN OR JOSH FILL ME IN. Default is 0.
+ * \br_property bool whiten BRENDAN OR JOSH FILL ME IN. Default is false.
  */
 class PCATransform : public Transform
 {
@@ -266,9 +266,12 @@ BR_REGISTER(Transform, RowWisePCATransform)
  
 /*!
  * \ingroup transforms
- * \brief Computes Distance From Feature Space (DFFS) \cite moghaddam97.
+ * \brief Computes Distance From Feature Space (DFFS)
+ * \br_paper Moghaddam, Baback, and Alex Pentland.
+ *           "Probabilistic visual learning for object representation."
+ *           Pattern Analysis and Machine Intelligence, IEEE Transactions on 19.7 (1997): 696-710.
  * \author Josh Klontz \cite jklontz
- * \property float keep Sets PCA keep property. Default is 0.95.
+ * \br_property float keep Sets PCA keep property. Default is 0.95.
  */
 class DFFSTransform : public Transform
 {
@@ -314,13 +317,13 @@ BR_REGISTER(Transform, DFFSTransform)
  * \brief Projects input into learned Linear Discriminant Analysis subspace.
  * \author Brendan Klare \cite bklare
  * \author Josh Klontz \cite jklontz
- * \property float pcaKeep BRENDAN OR JOSH FILL ME IN. Default is 0.98.
- * \property bool pcaWhiten BRENDAN OR JOSH FILL ME IN. Default is false.
- * \property int directLDA BRENDAN OR JOSH FILL ME IN. Default is 0.
- * \property float directDrop BRENDAN OR JOSH FILL ME IN. Default is 0.1.
- * \property QString inputVariable BRENDAN OR JOSH FILL ME IN. Default is "Label".
- * \property bool isBinary BRENDAN OR JOSH FILL ME IN. Default is false.
- * \property bool normalize BRENDAN OR JOSH FILL ME IN. Default is true.
+ * \br_property float pcaKeep BRENDAN OR JOSH FILL ME IN. Default is 0.98.
+ * \br_property bool pcaWhiten BRENDAN OR JOSH FILL ME IN. Default is false.
+ * \br_property int directLDA BRENDAN OR JOSH FILL ME IN. Default is 0.
+ * \br_property float directDrop BRENDAN OR JOSH FILL ME IN. Default is 0.1.
+ * \br_property QString inputVariable BRENDAN OR JOSH FILL ME IN. Default is "Label".
+ * \br_property bool isBinary BRENDAN OR JOSH FILL ME IN. Default is false.
+ * \br_property bool normalize BRENDAN OR JOSH FILL ME IN. Default is true.
  */
 class LDATransform : public Transform
 {
@@ -564,9 +567,9 @@ BR_REGISTER(Transform, LDATransform)
  * \ingroup transforms
  * \brief Projects input into learned Linear Discriminant Analysis subspace learned on a sparse subset of features with the highest weight in the original LDA algorithm.
  * \author Brendan Klare \cite bklare
- * \property float varThreshold BRENDAN FILL ME IN. Default is 1.5.
- * \property float pcaKeep BRENDAN FILL ME IN. Default is 0.98.
- * \property bool normalize BRENDAN FILL ME IN. Default is true.
+ * \br_property float varThreshold BRENDAN FILL ME IN. Default is 1.5.
+ * \br_property float pcaKeep BRENDAN FILL ME IN. Default is 0.98.
+ * \br_property bool normalize BRENDAN FILL ME IN. Default is true.
  */
 class SparseLDATransform : public Transform
 {
@@ -45,6 +45,10 @@ static void loadModel(model &amp;m, QDataStream &amp;stream)
     m = *load_model(qPrintable(tempFile.fileName()));
 }
  
+/*!
+ * \brief DOCUMENT ME SCOTT
+ * \author Scott Klum \cite sklum
+ */
 class Linear : public Transform
 {
     Q_OBJECT
@@ -28,13 +28,13 @@ namespace br
  * \ingroup transforms
  * \brief Wraps OpenCV's multi-layer perceptron framework
  * \author Scott Klum \cite sklum
- * \see http://docs.opencv.org/modules/ml/doc/neural_networks.html
- * \property enum kernel Type of MLP kernel to use. Options are Identity, Sigmoid, Gaussian. Default is Sigmoid.
- * \property float alpha Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.
- * \property float beta Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.
- * \property QStringList inputVariables Metadata keys for the labels associated with each template. There should be the same number of keys in the list as there are neurons in the final layer. Default is QStringList().
- * \property QStringList outputVariables Metadata keys to store the output of the neural network. There should be the same number of keys in the list as there are neurons in the final layer. Default is QStringList().
- * \property QList<int> neuronsPerLayer The number of neurons in each layer of the net. Default is QList<int>() << 1 << 1.
+ * \br_link http://docs.opencv.org/modules/ml/doc/neural_networks.html
+ * \br_property enum kernel Type of MLP kernel to use. Options are Identity, Sigmoid, Gaussian. Default is Sigmoid.
+ * \br_property float alpha Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.
+ * \br_property float beta Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.
+ * \br_property QStringList inputVariables Metadata keys for the labels associated with each template. There should be the same number of keys in the list as there are neurons in the final layer. Default is QStringList().
+ * \br_property QStringList outputVariables Metadata keys to store the output of the neural network. There should be the same number of keys in the list as there are neurons in the final layer. Default is QStringList().
+ * \br_property QList<int> neuronsPerLayer The number of neurons in each layer of the net. Default is QList<int>() << 1 << 1.
  */
 class MLPTransform : public MetaTransform
 {
@@ -75,9 +75,9 @@ BR_REGISTER(Initializer, NT4Initializer)
  */
 struct NT4Context
 {
-    HNLExtractor extractor; /*!< Face extractor. */
-    HNEExtractor irisExtractor; /*!< Iris extractor. */
-    HNMatcher matcher; /*!< Template matcher. */
+    HNLExtractor extractor; // Face extractor.
+    HNEExtractor irisExtractor; // Iris extractor.
+    HNMatcher matcher; // Template matcher.
  
     NT4Context()
     {
@@ -148,9 +148,7 @@ struct NT4Context
         NObjectFree(matcher);
     }
  
-    /*!
-     * \brief to NT image
-     */
+    // to NT image
     static void toImage(const Mat &src, HNGrayscaleImage *grayscaleImage)
     {
         Mat gray;
@@ -167,9 +165,7 @@ struct NT4Context
         NObjectFree(image);
     }
  
-    /*!
-     * \brief to OpenCV matrix
-     */
+    // to OpenCV matrix
     static Mat toMat(const HNLTemplate &templ)
     {
         NSizeType bufferSize;
@@ -181,9 +177,7 @@ struct NT4Context
         return buffer;
     }
  
-    /*!
-     * \brief extract metadata
-     */
+    // extract metadata
     static File toMetadata(const NleDetectionDetails &detectionDetails)
     {
         File metadata;
@@ -221,9 +215,7 @@ struct NT4Context
         return metadata;
     }
  
-    /*!
-     * \brief Initialize from metadata
-     */
+    // Initialize from metadata
     static NleDetectionDetails fromMetadata(const File &metadata)
     {
         NleDetectionDetails detectionDetails;
@@ -200,7 +200,7 @@ struct PP4Context
  * \brief Enroll faces in PittPatt 4
  * \author Josh Klontz \cite jklontz
  * \warning Needs a maintainer.
- * \property bool detectOnly If true, return all detected faces. Otherwise, return only faces that are suitable for recognition. Default is false.
+ * \br_property bool detectOnly If true, return all detected faces. Otherwise, return only faces that are suitable for recognition. Default is false.
  */
 class PP4EnrollTransform : public UntrainableMetaTransform
 {
@@ -252,12 +252,12 @@ struct PP5Context
  * \brief Enroll faces in PP5
  * \author Josh Klontz \cite jklontz
  * \author E. Taborsky \cite mmtaborsky
- * \property bool detectOnly If true, enroll all detected faces. Otherwise, only enroll faces suitable for recognition. Default is false.
- * \property bool requireLandmarks If true, require the right eye, left eye, and nose base to be detectable by PP5. If this does not happen FTE is set to true for that template. Default is false.
- * \property float adaptiveMinSize The minimum face size as a percentage of total image width. 0.1 corresponds to a minimum face size of 10% the total image width. Default is 0.01.
- * \property int minSize The absolute minimum face size to search for. This is not a pixel value. Please see PittPatt documentation for the relationship between minSize and pixel IPD. Default is 4.
- * \property enum landmarkRange Range of landmarks to search for. Options are Frontal, Extended, Full, and Comprehensive. Default is Comprehensive.
- * \property int searchPruningAggressiveness The amount of aggressiveness involved in search for faces in images. 0 means all scales and locations are searched. 1 means fewer detectors are used in the early stages but all scales are still searched. 2-4 means that the largest faces are found first and then fewer scales are searched. Default is 0.
+ * \br_property bool detectOnly If true, enroll all detected faces. Otherwise, only enroll faces suitable for recognition. Default is false.
+ * \br_property bool requireLandmarks If true, require the right eye, left eye, and nose base to be detectable by PP5. If this does not happen FTE is set to true for that template. Default is false.
+ * \br_property float adaptiveMinSize The minimum face size as a percentage of total image width. 0.1 corresponds to a minimum face size of 10% the total image width. Default is 0.01.
+ * \br_property int minSize The absolute minimum face size to search for. This is not a pixel value. Please see PittPatt documentation for the relationship between minSize and pixel IPD. Default is 4.
+ * \br_property enum landmarkRange Range of landmarks to search for. Options are Frontal, Extended, Full, and Comprehensive. Default is Comprehensive.
+ * \br_property int searchPruningAggressiveness The amount of aggressiveness involved in search for faces in images. 0 means all scales and locations are searched. 1 means fewer detectors are used in the early stages but all scales are still searched. 2-4 means that the largest faces are found first and then fewer scales are searched. Default is 0.
  */
 class PP5EnrollTransform : public UntrainableMetaTransform
 {
@@ -406,10 +406,9 @@ BR_REGISTER(Transform, PP5EnrollTransform)
  
 /*!
  * \ingroup distances
- * \brief Compare templates with PP5
+ * \brief Compare templates with PP5. PP5 distance is known to be asymmetric
  * \author Josh Klontz \cite jklontz
  * \author E. Taborsky \cite mmtaborsky
- * \note PP5 distance is known to be asymmetric
  */
 class PP5CompareDistance : public UntrainableDistance
                          , public PP5Context
@@ -511,6 +510,10 @@ class PP5CompareDistance : public UntrainableDistance
  
 BR_REGISTER(Distance, PP5CompareDistance)
  
+/*!
+ * \brief DOCUMENT ME
+ * \author Unknown \cite unknown
+ */
 class PP5GalleryTransform: public UntrainableMetaTransform
                          , public PP5Context
 {
@@ -29,19 +29,22 @@ namespace br
 /*!
  * \ingroup transforms
  * \brief Wraps OpenCV's SVM framework.
- * \see http://docs.opencv.org/modules/ml/doc/support_vector_machines.html
- * \see C. Burges. "A tutorial on support vector machines for pattern recognition", Knowledge Discovery and Data Mining 2(2), 1998.
+ * \br_link http://docs.opencv.org/modules/ml/doc/support_vector_machines.html
+ * \br_paper C. Burges.
+ *           "A tutorial on support vector machines for pattern recognition"
+ *           Knowledge Discovery and Data Mining 2(2), 1998.
  * \author Josh Klontz \cite jklontz
- * \property enum Kernel The type of SVM kernel to use. Options are Linear, Poly, RBF, Sigmoid. Default is Linear.
- * \property enum Type The type of SVM to do. Options are C_SVC, NU_SVC, ONE_CLASS, EPS_SVR, NU_SVR. Default is C_SVC.
- * \property float C Parameter C of an SVM optimization problem. Needed when Type is C_SVC, EPS_SVR or NU_SVR. Default is -1.
- * \property float gamma Parameter gamma of a kernel function. Needed when Kernel is Poly, RBF, or Sigmoid. Default is -1.
- * \property QString inputVariable Metadata variable storing the label for each template. Default is "Label".
- * \property QString outputVariable Metadata variable to store the prediction value of the trained SVM. If type is EPS_SVR or NU_SVR the stored value is the output of the SVM. Otherwise the value is the output of the SVM mapped through the reverse lookup table. Default is "".
- * \property bool returnDFVal If true, dst is set to a 1x1 Mat with value equal to the predicted output of the SVM. Default is false.
- * \property int termCriteria The maximum number of training iterations. Default is 1000.
- * \property int folds Cross validation parameter used for autoselecting other parameters. Default is 5.
- * \property bool balanceFolds If true and the problem is 2-class classification then more balanced cross validation subsets are created. Default is false.
+ *
+ * \br_property enum Kernel The type of SVM kernel to use. Options are Linear, Poly, RBF, Sigmoid. Default is Linear.
+ * \br_property enum Type The type of SVM to do. Options are C_SVC, NU_SVC, ONE_CLASS, EPS_SVR, NU_SVR. Default is C_SVC.
+ * \br_property float C Parameter C of an SVM optimization problem. Needed when Type is C_SVC, EPS_SVR or NU_SVR. Default is -1.
+ * \br_property float gamma Parameter gamma of a kernel function. Needed when Kernel is Poly, RBF, or Sigmoid. Default is -1.
+ * \br_property QString inputVariable Metadata variable storing the label for each template. Default is "Label".
+ * \br_property QString outputVariable Metadata variable to store the prediction value of the trained SVM. If type is EPS_SVR or NU_SVR the stored value is the output of the SVM. Otherwise the value is the output of the SVM mapped through the reverse lookup table. Default is "".
+ * \br_property bool returnDFVal If true, dst is set to a 1x1 Mat with value equal to the predicted output of the SVM. Default is false.
+ * \br_property int termCriteria The maximum number of training iterations. Default is 1000.
+ * \br_property int folds Cross validation parameter used for autoselecting other parameters. Default is 5.
+ * \br_property bool balanceFolds If true and the problem is 2-class classification then more balanced cross validation subsets are created. Default is false.
  */
 class SVMTransform : public Transform
 {
@@ -23,9 +23,9 @@ namespace br
  * \ingroup transforms
  * \brief Convenience class for training turk attribute regressors
  * \author Josh Klontz \cite jklontz
- * \property QString key Metadata key to pass input values to SVM. Actual lookup key is "key_value" where value is each value in the parameter values. Default is "".
- * \property QStringList values Metadata keys to pass input values to SVM. Actual lookup key is "key_value" where key is the parameter key and value is each value in this list. Each passed value trains a new SVM with the input values found in metadata["key_value"]. Default is "".
- * \property bool isMeta If true, "Average+SaveMat(predicted_key_value)" is appended to each classifier. If false, nothing is appended. Default is false.
+ * \br_property QString key Metadata key to pass input values to SVM. Actual lookup key is "key_value" where value is each value in the parameter values. Default is "".
+ * \br_property QStringList values Metadata keys to pass input values to SVM. Actual lookup key is "key_value" where key is the parameter key and value is each value in this list. Each passed value trains a new SVM with the input values found in metadata["key_value"]. Default is "".
+ * \br_property bool isMeta If true, "Average+SaveMat(predicted_key_value)" is appended to each classifier. If false, nothing is appended. Default is false.
  */
 class TurkClassifierTransform : public Transform
 {
@@ -23,7 +23,7 @@ namespace br
  * \ingroup transforms
  * \brief Collect nearest neighbors and append them to metadata.
  * \author Charles Otto \cite caotto
- * \property int keep The maximum number of nearest neighbors to keep. Default is 20.
+ * \br_property int keep The maximum number of nearest neighbors to keep. Default is 20.
  */
 class CollectNNTransform : public UntrainableMetaTransform
 {
@@ -28,9 +28,9 @@ namespace br
  * \ingroup transforms
  * \brief Wraps OpenCV kmeans and flann.
  * \author Josh Klontz \cite jklontz
- * \property int kTrain The number of random centroids to make at train time. Default is 256.
- * \property int kSearch The number of nearest neighbors to search for at runtime. Default is 1.
- * \see http://docs.opencv.org/modules/flann/doc/flann_fast_approximate_nearest_neighbor_search.html
+ * \br_property int kTrain The number of random centroids to make at train time. Default is 256.
+ * \br_property int kSearch The number of nearest neighbors to search for at runtime. Default is 1.
+ * \br_link http://docs.opencv.org/modules/flann/doc/flann_fast_approximate_nearest_neighbor_search.html
  */
 class KMeansTransform : public Transform
 {
@@ -25,7 +25,7 @@ namespace br
  * \ingroup transforms
  * \brief Log nearest neighbors to specified file.
  * \author Charles Otto \cite caotto
- * \property QString fileName The name of the log file. An empty fileName won't be written to. Default is "".
+ * \br_property QString fileName The name of the log file. An empty fileName won't be written to. Default is "".
  */
 class LogNNTransform : public TimeVaryingTransform
 {
@@ -29,9 +29,9 @@ namespace br
  * \ingroup transforms
  * \brief Chooses k random points to be centroids.
  * \author Austin Blanton \cite imaus10
- * \property int kTrain The number of random centroids to make at train time. Default is 256.
- * \property int kSearch The number of nearest neighbors to search for at runtime. Default is 1.
- * \see http://docs.opencv.org/modules/flann/doc/flann_fast_approximate_nearest_neighbor_search.html
+ * \br_property int kTrain The number of random centroids to make at train time. Default is 256.
+ * \br_property int kSearch The number of nearest neighbors to search for at runtime. Default is 1.
+ * \br_link http://docs.opencv.org/modules/flann/doc/flann_fast_approximate_nearest_neighbor_search.html
  */
 class RandomCentroidsTransform : public Transform
 {
@@ -36,9 +36,10 @@ namespace br
  * \brief Improved procrustes alignment of points, to include a post processing scaling of points
  * to faciliate subsequent texture mapping.
  * \author Brendan Klare \cite bklare
- * \param width Width of output coordinate space (before padding)
- * \param padding Amount of padding around the coordinate space
- * \param useFirst whether or not to use the first instance as the reference object
+ *
+ * \br_property float width Width of output coordinate space (before padding)
+ * \br_property float padding Amount of padding around the coordinate space
+ * \br_property bool useFirst Whether or not to use the first instance as the reference object
  */
 class ProcrustesAlignTransform : public Transform
 {
@@ -21,7 +21,7 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Caches br::Transform::project() results.
+ * \brief Caches Transform::project() results.
  * \author Josh Klontz \cite jklontz
  */
 class CacheTransform : public MetaTransform
@@ -22,9 +22,10 @@ namespace br
 /*!
  * \ingroup transforms
  * \brief It's like the opposite of ExpandTransform, but not really
- * \author Charles Otto \cite caotto
  *
- * Given a set of templatelists as input, concatenate them onto a single Template
+ * Given a TemplateList as input, concatenate them into a single Template
+ *
+ * \author Charles Otto \cite caotto
  */
 class ContractTransform : public UntrainableMetaTransform
 {
@@ -29,11 +29,13 @@ static void _train(Transform *transform, TemplateList data) // think data has to
  
 /*!
  * \ingroup transforms
- * \brief Cross validate a trainable transform.
+ * \brief Cross validate a trainable Transform.
+ *
+ * To use an extended Gallery, add an allPartitions="true" flag to the gallery sigset for those images that should be compared
+ * against for all testing partitions.
+ *
  * \author Josh Klontz \cite jklontz
  * \author Scott Klum \cite sklum
- * \note To use an extended gallery, add an allPartitions="true" flag to the gallery sigset for those images that should be compared
- *       against for all testing partitions.
  */
 class CrossValidateTransform : public MetaTransform
 {
@@ -21,8 +21,8 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Removes all template's matrices.
- * \see IdentityTransform FirstTransform RestTransform RemoveTransform
+ * \brief Removes all matrices from a Template.
+ * \br_related_plugin IdentityTransform FirstTransform RestTransform RemoveTransform
  * \author Josh Klontz \cite jklontz
  */
 class DiscardTransform : public UntrainableMetaTransform
@@ -19,6 +19,10 @@
 namespace br
 {
  
+/*!
+ * \brief DOCUMENT ME
+ * \author Unknown \cite unknown
+ */
 class DiscardTemplatesTransform : public UntrainableMetaTransform
 {
     Q_OBJECT
@@ -26,6 +26,10 @@ static void _projectList(const Transform *transform, const TemplateList *src, Te
     transform->project(*src, *dst);
 }
  
+/*!
+ * \brief DOCUMENT ME
+ * \author Unknown \cite unknown
+ */
 class DistributeTemplateTransform : public MetaTransform
 {
     Q_OBJECT
@@ -19,6 +19,10 @@
 namespace br
 {
  
+/*!
+ * \brief DOCUMENT ME
+ * \author Unknown \cite unknown
+ */
 class EventTransform : public UntrainableMetaTransform
 {
     Q_OBJECT
@@ -48,12 +48,9 @@ static TemplateList Expanded(const TemplateList &amp;templates)
  
 /*!
  * \ingroup transforms
- * \brief Performs an expansion step on input templatelists
+ * \brief Performs an expansion step on an input TemplateList. Each matrix in each input Template is expanded into its own Template.
  * \author Josh Klontz \cite jklontz
- *
- * Each matrix in an input Template is expanded into its own template.
- *
- * \see PipeTransform
+ * \br_related_plugin PipeTransform
  */
 class ExpandTransform : public UntrainableMetaTransform
 {
@@ -21,8 +21,8 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Removes all but the first matrix from the template.
- * \see IdentityTransform DiscardTransform RestTransform RemoveTransform
+ * \brief Removes all but the first matrix from the Template.
+ * \br_related_plugin IdentityTransform DiscardTransform RestTransform RemoveTransform
  * \author Josh Klontz \cite jklontz
  */
 class FirstTransform : public UntrainableMetaTransform
@@ -29,11 +29,11 @@ static void _train(Transform *transform, const QList&lt;TemplateList&gt; *data)
 /*!
  * \ingroup transforms
  * \brief Transforms in parallel.
- * \author Josh Klontz \cite jklontz
  *
- * The source br::Template is seperately given to each transform and the results are appended together.
+ * The source Template is seperately given to each transform and the results are appended together.
  *
- * \see PipeTransform
+ * \author Josh Klontz \cite jklontz
+ * \br_related_plugin PipeTransform
  */
 class ForkTransform : public CompositeTransform
 {
@@ -22,7 +22,7 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Flags images that failed to enroll based on the specified transform.
+ * \brief Flags images that failed to enroll based on the specified Transform.
  * \author Josh Klontz \cite jklontz
  */
 class FTETransform : public Transform
@@ -22,7 +22,7 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Compare each template to a fixed gallery (with name = galleryName), using the specified distance.
+ * \brief Compare each Template to a fixed Gallery (with name = galleryName), using the specified distance.
  * dst will contain a 1 by n vector of scores.
  * \author Charles Otto \cite caotto
  */
@@ -21,8 +21,8 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief A no-op transform.
- * \see DiscardTransform FirstTransform RestTransform RemoveTransform
+ * \brief A no-op Transform.
+ * \br_related_plugin DiscardTransform FirstTransform RestTransform RemoveTransform
  * \author Josh Klontz \cite jklontz
  */
 class IdentityTransform : public UntrainableMetaTransform
@@ -25,9 +25,11 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Clones the transform so that it can be applied independently.
+ * \brief Clones the Transform so that it can be applied independently.
+ *
+ * Independent Transforms expect single-matrix Templates.
+ *
  * \author Josh Klontz \cite jklontz
- * \em Independent transforms expect single-matrix templates.
  */
 class IndependentTransform : public MetaTransform
 {
@@ -56,7 +56,6 @@ BR_REGISTER(Initializer, JNIInitializer)
  * \brief Execute Java code from OpenBR using the JNI
  * \author Jordan Cheney \cite jcheney
  */
-
 class JNITransform : public UntrainableTransform
 {
     Q_OBJECT
@@ -7,7 +7,7 @@ namespace br
  * \ingroup transforms
  * \brief Generic interface to Likely JIT compiler
  *
- * www.liblikely.org
+ * \br_link www.liblikely.org
  * \author Josh Klontz \cite jklontz
  */
 class LikelyTransform : public UntrainableTransform
@@ -22,7 +22,7 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Caches transform training.
+ * \brief Caches Transform training.
  * \author Josh Klontz \cite jklontz
  */
 class LoadStoreTransform : public MetaTransform
@@ -24,12 +24,11 @@ namespace br
 /*!
  * \ingroup Transforms
  * \brief Transforms in series.
- * \author Josh Klontz \cite jklontz
  *
- * The source br::Template is given to the first transform and the resulting br::Template is passed to the next transform, etc.
+ * The source Template is given to the first transform and the resulting Template is passed to the next transform, etc.
  *
- * \see ExpandTransform
- * \see ForkTransform
+ * \author Josh Klontz \cite jklontz
+ * \br_related_plugin ExpandTransform ForkTransform
  */
 class PipeTransform : public CompositeTransform
 {
@@ -22,6 +22,11 @@
 namespace br
 {
  
+/*!
+ * \ingroup transforms
+ * \brief DOCUMENT ME
+ * \author Unknown \cite unknown
+ */
 class ProgressCounterTransform : public TimeVaryingTransform
 {
     Q_OBJECT
@@ -21,11 +21,10 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Removes the matrix from the template at the specified index.
+ * \brief Removes the matrix from the Template at the specified index.
  * \author Josh Klontz \cite jklontz
- * \see IdentityTransform DiscardTransform FirstTransform RestTransform
+ * \br_related_plugin IdentityTransform DiscardTransform FirstTransform RestTransform
  */
-//! [example_transform]
 class RemoveTransform : public UntrainableMetaTransform
 {
     Q_OBJECT
@@ -40,7 +39,6 @@ class RemoveTransform : public UntrainableMetaTransform
 };
  
 BR_REGISTER(Transform, RemoveTransform)
-//! [example_transform]
  
 } // namespace br
  
@@ -21,8 +21,8 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Removes the first matrix from the template.
- * \see IdentityTransform DiscardTransform FirstTransform RemoveTransform
+ * \brief Removes the first matrix from the Template.
+ * \br_related_plugin IdentityTransform DiscardTransform FirstTransform RemoveTransform
  * \author Josh Klontz \cite jklontz
  */
 class RestTransform : public UntrainableMetaTransform
@@ -21,8 +21,8 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief Generates two templates, one of which is passed through a transform and the other
- *        is not. No cats were harmed in the making of this transform.
+ * \brief Generates two Templates, one of which is passed through a Transform and the other
+ *        is not. No cats were harmed in the making of this Transform.
  * \author Scott Klum \cite sklum
  */
 class SchrodingerTransform : public MetaTransform
@@ -21,7 +21,7 @@ namespace br
  
 /*!
  * \ingroup transforms
- * \brief A globally shared transform.
+ * \brief A globally shared Transform.
  * \author Josh Klontz \cite jklontz
  */
 class SingletonTransform : public MetaTransform
@@ -26,7 +26,7 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Bayesian quantization distance
+ * \brief Bayesian quantization Distance
  * \author Josh Klontz \cite jklontz
  */
 class BayesianQuantizationDistance : public Distance
@@ -21,7 +21,7 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Cross validate a distance metric.
+ * \brief Cross validate a Distance metric.
  * \author Josh Klontz \cite jklontz
  */
 class CrossValidateDistance : public UntrainableDistance
@@ -24,7 +24,7 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Standard distance metrics
+ * \brief Standard Distance metrics
  * \author Josh Klontz \cite jklontz
  */
 class DistDistance : public UntrainableDistance
@@ -23,9 +23,9 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Fuses similarity scores across multiple matrices of compared templates
+ * \brief Fuses similarity scores across multiple matrices of compared Templates
  * \author Scott Klum \cite sklum
- * \note Operation: Mean, sum, min, max are supported.
+ * \br_property enum Operation Possible values are: [Mean, sum, min, max].
  */
 class FuseDistance : public Distance
 {
@@ -23,7 +23,7 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Returns \c true if the templates are identical, \c false otherwise.
+ * \brief Returns true if the Templates are identical, false otherwise.
  * \author Josh Klontz \cite jklontz
  */
 class IdenticalDistance : public UntrainableDistance
@@ -26,6 +26,7 @@ namespace br
 /*!
  * \ingroup transforms
  * \brief Wraps OpenCV Key Point Matcher
+ * \br_link http://docs.opencv.org/modules/features2d/doc/common_interfaces_of_feature_detectors.html
  * \author Josh Klontz \cite jklontz
  */
 class KeyPointMatcherDistance : public UntrainableDistance
@@ -110,7 +110,7 @@ QDataStream &amp;operator&gt;&gt;(QDataStream &amp;stream, MP &amp;nmp)
  
 /*!
  * \ingroup distances
- * \brief Match Probability \cite klare12
+ * \brief Match Probability
  * \author Josh Klontz \cite jklontz
  */
 class MatchProbabilityDistance : public Distance
@@ -21,7 +21,7 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Online distance metric to attenuate match scores across multiple frames
+ * \brief Online Distance metric to attenuate match scores across multiple frames
  * \author Brendan klare \cite bklare
  */
 class OnlineDistance : public UntrainableDistance
@@ -24,11 +24,13 @@ namespace br
 /*!
  * \ingroup distances
  * \brief Distances in series.
- * \author Josh Klontz \cite jklontz
  *
- * The templates are compared using each br::Distance in order.
+ * The Templates are compared using each Distance in order.
  * If the result of the comparison with any given distance is -FLOAT_MAX then this result is returned early.
- * Otherwise the returned result is the value of comparing the templates using the last br::Distance.
+ * Otherwise the returned result is the value of comparing the Templates using the last Distance.
+ *
+ * \author Josh Klontz \cite jklontz
+ *
  */
 class PipeDistance : public Distance
 {
@@ -21,7 +21,7 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Sets distance to -FLOAT_MAX if a target template has/doesn't have a key.
+ * \brief Sets Distance to -FLOAT_MAX if a target Template has/doesn't have a key.
  * \author Scott Klum \cite sklum
  */
 class RejectDistance : public UntrainableDistance
@@ -23,7 +23,7 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Sum match scores across multiple distances
+ * \brief Sum match scores across multiple Distances
  * \author Scott Klum \cite sklum
  */
 class SumDistance : public UntrainableDistance
@@ -11,8 +11,8 @@ namespace br
  
 /*!
  * \ingroup Distances
- * \brief SVM Regression on template absolute differences.
- * \author Josh Klontz
+ * \brief SVM Regression on Template absolute differences.
+ * \author Josh Klontz \cite jklontz
  */
 class SVMDistance : public Distance
 {
@@ -21,7 +21,7 @@ namespace br
  
 /*!
  * \ingroup distances
- * \brief Linear normalizes of a distance so the mean impostor score is 0 and the mean genuine score is 1.
+ * \brief Linear normalizes of a Distance so the mean impostor score is 0 and the mean genuine score is 1.
  * \author Josh Klontz \cite jklontz
  */
 class UnitDistance : public Distance
@@ -20,6 +20,10 @@
 namespace br
 {
  
+/*!
+ * \brief DOCUMENT ME
+ * \author Unknown \cite unknown
+ */
 class ZScoreDistance : public Distance
 {
     Q_OBJECT
@@ -26,7 +26,7 @@ namespace br
  * \ingroup formats
  * \brief A simple binary matrix format.
  * \author Josh Klontz \cite jklontz
- * First 4 bytes indicate the number of rows.
+ * \br_format First 4 bytes indicate the number of rows.
  * Second 4 bytes indicate the number of columns.
  * The rest of the bytes are 32-bit floating data elements in row-major order.
  */