Empty file cleanup

Jordan Cheney
1 parent e41e8d5d
Showing 70 changed files with 9 additions and 4564 deletions
docs/docs/api_docs/cpp_api/classifier/classifier.md
docs/docs/api_docs/cpp_api/classifier/members.md
docs/docs/api_docs/cpp_api/compositetransform/compositetransform.md
docs/docs/api_docs/cpp_api/compositetransform/statics.md
docs/docs/api_docs/cpp_api/context/constructors.md
docs/docs/api_docs/cpp_api/context/context.md
docs/docs/api_docs/cpp_api/distance/distance.md
docs/docs/api_docs/cpp_api/distance/members.md
docs/docs/api_docs/cpp_api/factory/factory.md
docs/docs/api_docs/cpp_api/factory/functions.md
docs/docs/api_docs/cpp_api/filegallery/filegallery.md
docs/docs/api_docs/cpp_api/filegallery/statics.md
docs/docs/api_docs/cpp_api/filelist/filelist.md
docs/docs/api_docs/cpp_api/filelist/members.md
docs/docs/api_docs/cpp_api/format/format.md
docs/docs/api_docs/cpp_api/format/members.md
docs/docs/api_docs/cpp_api/gallery/gallery.md
docs/docs/api_docs/cpp_api/gallery/members.md
docs/docs/api_docs/cpp_api/initializer/initializer.md
docs/docs/api_docs/cpp_api/initializer/members.md
@@ -4,7 +4,6 @@ Inherits [Object](../object/object.md)
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
-NONE
 \ No newline at end of file
@@ -9,7 +9,6 @@ See:
 * [Properties](properties.md)
 * [Members](members.md)
 * [Constructors](constructors.md)
-* [Static Functions](statics.md)
 * [Functions](functions.md)
  
-CompositeTransforms are the base class for [Transforms](../transform/transform.md) that have a list of child transforms. It is used internally for plugins like pipes and forks. It inherits from [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md) so that it can properly handle having children (one or many) that are time varying. 
 \ No newline at end of file
+CompositeTransforms are the base class for [Transforms](../transform/transform.md) that have a list of child transforms. It is used internally for plugins like pipes and forks. It inherits from [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md) so that it can properly handle having children (one or many) that are time varying.
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
 <!-- CONTEXT -->
  
-The singleton class of global settings. 
+The singleton class of global settings.
  
 See:
  
 * [Members](members.md)
-* [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
  
-Before including and using OpenBR in a project the user must call [initialize](statics.md#initialize). Before the program terminates the user must call [finalize](statics.md#finalize). The settings are accessible as Context \*Globals.
 \ No newline at end of file
+Before including and using OpenBR in a project the user must call [initialize](statics.md#initialize). Before the program terminates the user must call [finalize](statics.md#finalize). The settings are accessible as Context \*Globals.
@@ -6,7 +6,6 @@ Plugin base class for comparing two [Templates](../template/template.md)
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
-NONE
 \ No newline at end of file
@@ -8,8 +8,7 @@ See:
 * [Constructors](constructors.md)
 * [Macros](macros.md)
 * [Static Functions](statics.md)
-* [Functions](functions.md)
  
 Uses the Industrial Strength Pluggable Factory model described [here](http://adtmag.com/articles/2000/09/25/industrial-strength-pluggable-factories.aspx).
  
-OpenBR's plugin architecture is premised on the idea that algorithms can be described as strings and can be built at runtime. Constructing plugins from strings is the job of the [Factory](factory.md). For a plugin to be built by the [Factory](factory.md) it must inherit from [Object](../object/object.md). It also must be registered with the factory at compile time using [BR_REGISTER](macros.md#br_register). At runtime, the [Factory](factory.md) will look up provided strings in its [registry](members.md#registry) and, if they exist, return the described plugins.
 \ No newline at end of file
+OpenBR's plugin architecture is premised on the idea that algorithms can be described as strings and can be built at runtime. Constructing plugins from strings is the job of the [Factory](factory.md). For a plugin to be built by the [Factory](factory.md) it must inherit from [Object](../object/object.md). It also must be registered with the factory at compile time using [BR_REGISTER](macros.md#br_register). At runtime, the [Factory](factory.md) will look up provided strings in its [registry](members.md#registry) and, if they exist, return the described plugins.
-None
 \ No newline at end of file
@@ -8,7 +8,6 @@ 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
+[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.
-NONE
 \ No newline at end of file
@@ -4,7 +4,6 @@ Inherits [QList][QList]&amp;lt;[File](../file/file.md)&amp;gt;.
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
-NONE
 \ No newline at end of file
@@ -6,7 +6,6 @@ Plugin base class for reading a template from disk.
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
-NONE
 \ No newline at end of file
@@ -7,7 +7,6 @@ Plugin base class for storing a list of enrolled templates.
 See:
  
 * [Properties](properties.md)
-* [Members](members.md)
 * [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
-NONE
 \ No newline at end of file
@@ -4,9 +4,7 @@ Inherits [Object](../object/object.md)
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
-* [Static Functions](statics.md)
 * [Functions](functions.md)
  
 Plugin base class for initializing resources. On startup (the call to [Context](../context/context.md)::[initialize](../context/statics.md#initialize)), OpenBR will call [initialize](functions.md#initialize) on every Initializer that has been registered with the [Factory](../factory/factory.md). On shutdown (the call to [Context](../context/context.md)::[finalize](../context/statics.md#finalize), OpenBR will call [finalize](functions.md#finalize) on every registered initializer.
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
@@ -5,7 +5,6 @@ Inherits from [Output](../output/output.md)
 See:
  
 * [Members](members.md)
-* [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
  
-NONE
 \ No newline at end of file
@@ -6,9 +6,7 @@ A [Transform](../transform/transform.md) that requires only [Template](../templa
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
-* [Static Functions](statics.md)
 * [Functions](functions.md)
  
 [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).
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
@@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that expect multiple matrices per [Temp
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
-* [Static Functions](statics.md)
-* [Functions](functions.md)
  
-[MetaTransforms](metatransform.md) are [Transforms](../transform/transform.md) that are not [independent](../transform/members.md#independent). This means they expect more then one matrix in each input [Template](../template/template.md) and a new instance of the transform should not be created for each matrix. 
+[MetaTransforms](metatransform.md) are [Transforms](../transform/transform.md) that are not [independent](../transform/members.md#independent). This means they expect more then one matrix in each input [Template](../template/template.md) and a new instance of the transform should not be created for each matrix.
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
@@ -5,9 +5,8 @@ Inherits from [QObject][QObject]
 See:
  
 * [Members](members.md)
-* [Constructors](constructors.md)
 * [Macros](macros.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
  
-This is the base class of all OpenBR plugins. [Objects](object.md) are constructed from [Files](../file/file.md). The [File's](../file/file.md) [name](../file/members.md#name) specifies which plugin to construct and the [File's](../file/file.md) [metadata](../file/members.md#m_metadata) provides initialization values for the plugin's properties.
 \ No newline at end of file
+This is the base class of all OpenBR plugins. [Objects](object.md) are constructed from [Files](../file/file.md). The [File's](../file/file.md) [name](../file/members.md#name) specifies which plugin to construct and the [File's](../file/file.md) [metadata](../file/members.md#m_metadata) provides initialization values for the plugin's properties.
-NONE
 \ No newline at end of file
@@ -6,7 +6,6 @@ Plugin base class for converting images into feature vectors
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
-NONE
 \ No newline at end of file
@@ -6,8 +6,6 @@ Convenience class for working with a list of templates.
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
 * [Static Functions](statics.md)
 * [Functions](functions.md)
-
-NONE
 \ No newline at end of file
@@ -8,7 +8,6 @@ See:
  
 * [Members](members.md)
 * [Constructors](constructors.md)
-* [Static Functions](statics.md)
 * [Functions](functions.md)
  
 TimeVaryingTransforms are [Transforms](../transform/transform.md) that need to change their state at project time. This is opposed to [Transforms](../transform/transform.md) which can only change state at train time. Common examples include video processing across multiple frames, aggregate projection statistics etc.
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
@@ -6,9 +6,4 @@ A [Distance](../distance/distance.md) that does not require training.
  
 See:
  
-* [Members](members.md)
-* [Constructors](constructors.md)
-* [Static Functions](statics.md)
-* [Functions](functions.md)
-
 This is a base class for [Distances](../distance/distance.md) that are not trainable. It overloads [trainable](../distance/functions.md#trainable) to return false and [train](../distance/functions.md#train) so that it cannot be used in derived classes.
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
@@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that requires only [Template](../templa
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
-* [Static Functions](statics.md)
-* [Functions](functions.md)
  
 [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).
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
@@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that expect multiple matrices per [Temp
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
-* [Static Functions](statics.md)
-* [Functions](functions.md)
  
-[UntrainableMetaTransforms](untrainablemetatransform.md) are [UntrainableTransforms](../untrainabletransform/untrainabletransform.md) that are not [independent](../transform/members.md#independent). This means they expect more then one matrix in each input [Template](../template/template.md) and a new instance of the transform should not be created for each matrix. 
+[UntrainableMetaTransforms](untrainablemetatransform.md) are [UntrainableTransforms](../untrainabletransform/untrainabletransform.md) that are not [independent](../transform/members.md#independent). This means they expect more then one matrix in each input [Template](../template/template.md) and a new instance of the transform should not be created for each matrix.
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
@@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that does not require training.
  
 See:
  
-* [Members](members.md)
 * [Constructors](constructors.md)
-* [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](../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.
-NONE
 \ No newline at end of file
-NONE
 \ No newline at end of file
@@ -7,9 +7,7 @@ Base class for [Transforms](../transform/transform.md) that have a single child 
 See:
  
 * [Properties](properties.md)
-* [Members](members.md)
 * [Constructors](constructors.md)
-* [Static Functions](statics.md)
 * [Functions](functions.md)
  
-WrapperTransforms are the base class for plugins that have a child transform. It inherits from [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md) so that it can properly handle a child transform that is also time varying, WrapperTransform itself has no requirement to be time varying. The main purpose of WrapperTransform is to intelligently implement [simplify](functions.md#simplify) and [smartCopy](functions.md#smartcopy), all other calls are just passed to the child. 
 \ No newline at end of file
+WrapperTransforms are the base class for plugins that have a child transform. It inherits from [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md) so that it can properly handle a child transform that is also time varying, WrapperTransform itself has no requirement to be time varying. The main purpose of WrapperTransform is to intelligently implement [simplify](functions.md#simplify) and [smartCopy](functions.md#smartcopy), all other calls are just passed to the child.
-# 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)
-* **properties:**
-
-	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](../cpp_api/distance/distance.md) From Feature Space (DFFS)
- 
-
-* **file:** classification/lda.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **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.
-
----
-
-# EBIFTransform
-
-Face Recognition Using Early Biologically Inspired Features
- 
-
-* **file:** classification/ebif.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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.
-
----
-
-# 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)
-* **properties:**
-
-	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)
-* **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.
-
----
-
-# IPC2013FaceRecognitionTransform
-
-Intel Perceptual Computing SDK 2013 Face Recognition
- 
-
-* **file:** classification/ipc2013.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# LDATransform
-
-Projects input into learned Linear Discriminant Analysis subspace.
- 
-
-* **file:** classification/lda.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **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.
-
----
-
-# 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)
-* **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.
-
----
-
-# NT4Compare
-
-Compare templates with Neurotech SDK 4
- 
-
-* **file:** classification/nt4.cpp
-* **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]
-* **properties:** None
-
-
----
-
-# NT4DetectFace
-
-Neurotech face detection
- 
-
-* **file:** classification/nt4.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]
-* **properties:** None
-
-
----
-
-# NT4EnrollFace
-
-Enroll face in Neurotech SDK 4
- 
-
-* **file:** classification/nt4.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# NT4EnrollIris
-
-Enroll iris in Neurotech SDK 4
- 
-
-* **file:** classification/nt4.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [E. Taborsky][mmtaborsky]
-* **properties:** None
-
-
----
-
-# PCATransform
-
-Projects input into learned Principal Component Analysis subspace.
- 
-
-* **file:** classification/lda.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **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.
-
----
-
-# PP4Compare
-
-Compare faces using PittPatt 4.
- 
-
-* **file:** classification/pp4.cpp
-* **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# PP4EnrollTransform
-
-Enroll faces in PittPatt 4
- 
-
-* **file:** classification/pp4.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **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.
-
----
-
-# PP5CompareDistance
-
-Compare templates with PP5. PP5 distance is known to be asymmetric
- 
-
-* **file:** classification/pp5.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]
-* **properties:** None
-
-
----
-
-# PP5EnrollTransform
-
-Enroll faces in PP5
- 
-
-* **file:** classification/pp5.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **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.
-
----
-
-# 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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# SVMTransform
-
-Wraps OpenCV's SVM framework.
- 
-
-* **file:** classification/svm.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **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:**
-
-	1. *C. Burges.*
-	 **"A tutorial on support vector machines for pattern recognition"**
-	 Knowledge Discovery and Data Mining 2(2), 1998.
-
-* **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.
-
----
-
-# 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(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.
-
----
-
-# TurkClassifierTransform
-
-Convenience class for training turk attribute regressors
- 
-
-* **file:** classification/turk.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **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.
-
----
-
-# CollectNNTransform
-
-Collect nearest neighbors and append them to metadata.
- 
-
-* **file:** cluster/collectnn.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Charles Otto][caotto]
-* **properties:**
-
-	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)
-* **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.
-
----
-
-# KNNTransform
-
-K nearest neighbors classifier.
- 
-
-* **file:** cluster/knn.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# LogNNTransform
-
-Log nearest neighbors to specified file.
- 
-
-* **file:** cluster/lognn.cpp
-* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **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 "".
-
----
-
-# 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)
-* **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.
-
----
-
-# CacheTransform
-
-Caches [Transform](../cpp_api/transform/transform.md)::project() results.
- 
-
-* **file:** core/cache.cpp
-* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CollectOutputTransform
-
-DOCUMENT ME CHARLES
- 
-
-* **file:** core/stream.cpp
-* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# ContractTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# CrossValidateTransform
-
-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)
-* **author(s):** [Josh Klontz][jklontz], [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# DirectStreamTransform
-
-DOCUMENT ME CHARLES
- 
-
-* **file:** core/stream.cpp
-* **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
-
-
----
-
-# DiscardTransform
-
-Removes all matrices from a [Template](../cpp_api/template/template.md).
- 
-
-* **file:** core/discard.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **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
-
-
----
-
-# DownsampleTrainingTransform
-
-DOCUMENT ME JOSH
- 
-
-* **file:** core/downsampletraining.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **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
-
-
----
-
-# ExpandTransform
-
-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)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# FTETransform
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# FirstTransform
-
-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)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ForkTransform
-
-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](../cpp_api/compositetransform/compositetransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# GalleryCompareTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# IdentityTransform
-
-A no-op [Transform](../cpp_api/transform/transform.md).
- 
-
-* **file:** core/identity.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# IndependentTransform
-
-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(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
-
-
----
-
-# LikelyTransform
-
-Generic interface to Likely JIT compiler
- 
-
-* **file:** core/likely.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **see:** [www.liblikely.org](www.liblikely.org)
-* **properties:** None
-
-
----
-
-# LoadStoreTransform
-
-Caches [Transform](../cpp_api/transform/transform.md) training.
- 
-
-* **file:** core/loadstore.cpp
-* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# PipeTransform
-
-Transforms in series.
-
-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.
- 
-
-* **file:** core/pipe.cpp
-* **inherits:** [CompositeTransform](../cpp_api/compositetransform/compositetransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ProcessWrapperTransform
-
-Interface to a separate process
- 
-
-* **file:** core/processwrapper.cpp
-* **inherits:** [WrapperTransform](../cpp_api/wrappertransform/wrappertransform.md)
-* **author(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# 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(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
-
-
----
-
-# RestTransform
-
-Removes the first matrix from the [Template](../cpp_api/template/template.md).
- 
-
-* **file:** core/rest.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# SchrodingerTransform
-
-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(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# SingletonTransform
-
-A globally shared [Transform](../cpp_api/transform/transform.md).
- 
-
-* **file:** core/singleton.cpp
-* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# StreamTransform
-
-DOCUMENT ME CHARLES
- 
-
-* **file:** core/stream.cpp
-* **inherits:** [WrapperTransform](../cpp_api/wrappertransform/wrappertransform.md)
-* **author(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# SynthesizePointsTransform
-
-Synthesize additional points via triangulation.
- 
-
-* **file:** core/align.cpp
-* **inherits:** [MetadataTransform](../cpp_api/metadatatransform/metadatatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# TextureMapTransform
-
-Maps texture from one set of points to another. Assumes that points are rigidly transformed
- 
-
-* **file:** core/align.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# BayesianQuantizationDistance
-
-Bayesian quantization [Distance](../cpp_api/distance/distance.md)
- 
-
-* **file:** distance/bayesianquantization.cpp
-* **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ByteL1Distance
-
-Fast 8-bit L1 distance
- 
-
-* **file:** distance/byteL1.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CrossValidateDistance
-
-Cross validate a [Distance](../cpp_api/distance/distance.md) metric.
- 
-
-* **file:** distance/crossvalidate.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DefaultDistance
-
-DistDistance wrapper.
- 
-
-* **file:** distance/default.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DistDistance
-
-Standard [Distance](../cpp_api/distance/distance.md) metrics
- 
-
-* **file:** distance/dist.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# FilterDistance
-
-Checks target metadata against filters.
- 
-
-* **file:** distance/filter.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# FuseDistance
-
-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(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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# HeatMapDistance
-
-1v1 heat map comparison
- 
-
-* **file:** distance/heatmap.cpp
-* **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# IdenticalDistance
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# KeyPointMatcherDistance
-
-Wraps OpenCV Key Point Matcher
- 
-
-* **file:** distance/keypointmatcher.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **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
-
-
----
-
-# L1Distance
-
-L1 distance computed using eigen.
- 
-
-* **file:** distance/L1.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# L2Distance
-
-L2 distance computed using eigen.
- 
-
-* **file:** distance/L2.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# MatchProbabilityDistance
-
-Match Probability
- 
-
-* **file:** distance/matchprobability.cpp
-* **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# MetadataDistance
-
-Checks target metadata against query metadata.
- 
-
-* **file:** distance/metadata.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# NegativeLogPlusOneDistance
-
-Returns -log(distance(a,b)+1)
- 
-
-* **file:** distance/neglogplusone.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# OnlineDistance
-
-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(s):** [Brendan klare][bklare]
-* **properties:** None
-
-
----
-
-# PipeDistance
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RejectDistance
-
-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(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# SVMDistance
-
-SVM Regression on [Template](../cpp_api/template/template.md) absolute differences.
- 
-
-* **file:** distance/svm.cpp
-* **inherits:** [Distance](../cpp_api/distance/distance.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# SumDistance
-
-Sum match scores across multiple [Distance](../cpp_api/distance/distance.md)
- 
-
-* **file:** distance/sum.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# TurkDistance
-
-Unmaps Turk HITs to be compared against query mats
- 
-
-* **file:** distance/turk.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# UnitDistance
-
-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(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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# binaryFormat
-
-A simple binary matrix format.
- 
-
-* **file:** format/binary.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **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
-
-
----
-
-# csvFormat
-
-Reads a comma separated value file.
- 
-
-* **file:** format/csv.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ebtsFormat
-
-Reads FBI EBTS transactions.
- 
-
-* **file:** format/ebts.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Scott Klum][sklum]
-* **see:** [https://www.fbibiospecs.org/ebts.html](https://www.fbibiospecs.org/ebts.html)
-* **properties:** None
-
-
----
-
-# lffsFormat
-
-Reads a NIST LFFS file.
- 
-
-* **file:** format/lffs.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# lmatFormat
-
-Likely matrix format
- 
-
-* **file:** format/lmat.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **see:** [www.liblikely.org](www.liblikely.org)
-* **properties:** None
-
-
----
-
-# maskFormat
-
-Reads a NIST BEE mask matrix.
- 
-
-* **file:** format/mtx.cpp
-* **inherits:** [mtxFormat](#mtxformat)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# matFormat
-
-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(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
-
-
----
-
-# mtxFormat
-
-Reads a NIST BEE similarity matrix.
- 
-
-* **file:** format/mtx.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# nullFormat
-
-Returns an empty matrix.
- 
-
-* **file:** format/null.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# postFormat
-
-Handle POST requests
- 
-
-* **file:** format/post.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# rawFormat
-
-RAW format
- 
-
-* **file:** format/raw.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **see:** [http://www.nist.gov/srd/nistsd27.cfm](http://www.nist.gov/srd/nistsd27.cfm)
-* **properties:** None
-
-
----
-
-# scoresFormat
-
-Reads in scores or ground truth from a text table.
- 
-
-* **file:** format/scores.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **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
-
-
----
-
-# urlFormat
-
-Reads image files from the web.
- 
-
-* **file:** format/url.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# videoFormat
-
-Read all frames of a video using OpenCV
- 
-
-* **file:** format/video.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# webcamFormat
-
-Retrieves an image from a webcam.
- 
-
-* **file:** format/video.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# xmlFormat
-
-Decodes images from Base64 xml
- 
-
-* **file:** format/xml.cpp
-* **inherits:** [Format](../cpp_api/format/format.md)
-* **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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DefaultGallery
-
-Treats the gallery as a [Format](../cpp_api/format/format.md).
- 
-
-* **file:** gallery/default.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# EmptyGallery
-
-Reads/writes templates to/from folders.
- 
-
-* **file:** gallery/empty.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **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(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
-
-
----
-
-# arffGallery
-
-Weka ARFF file format.
- 
-
-* **file:** gallery/arff.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **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
-
-
----
-
-# crawlGallery
-
-Crawl a root location for image files.
- 
-
-* **file:** gallery/crawl.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# csvGallery
-
-Treats each line as a file.
- 
-
-* **file:** gallery/csv.cpp
-* **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)
-* **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
-
-
----
-
-# dbGallery
-
-Database input.
- 
-
-* **file:** gallery/db.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# flatGallery
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# galGallery
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# googleGallery
-
-Input from a google image search.
- 
-
-* **file:** gallery/google.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# jsonGallery
-
-Newline-separated JSON objects.
- 
-
-* **file:** gallery/binary.cpp
-* **inherits:** [BinaryGallery](#binarygallery)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# keyframesGallery
-
-Read key frames of a video with LibAV
- 
-
-* **file:** gallery/keyframes.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Ben Klein][bhklein]
-* **properties:** None
-
-
----
-
-# landmarksGallery
-
-Text format for associating anonymous landmarks with images.
- 
-
-* **file:** gallery/landmarks.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **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
-
-
----
-
-# lmatGallery
-
-Likely matrix format
- 
-
-* **file:** gallery/lmat.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **see:** [www.liblikely.org](www.liblikely.org)
-* **properties:** None
-
-
----
-
-# matrixGallery
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# memGallery
-
-A gallery held in memory.
- 
-
-* **file:** gallery/mem.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# mp4Gallery
-
-Read key frames of a .mp4 video file with LibAV
- 
-
-* **file:** gallery/keyframes.cpp
-* **inherits:** [keyframesGallery](#keyframesgallery)
-* **author(s):** [Ben Klein][bhklein]
-* **properties:** None
-
-
----
-
-# postGallery
-
-Handle POST requests
- 
-
-* **file:** gallery/post.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **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
-
-
----
-
-# statGallery
-
-Print [Template](../cpp_api/template/template.md) statistics.
- 
-
-* **file:** gallery/stat.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# templateGallery
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# turkGallery
-
-For Amazon Mechanical Turk datasets
- 
-
-* **file:** gallery/turk.cpp
-* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# txtGallery
-
-Treats each line as a file.
- 
-
-* **file:** gallery/txt.cpp
-* **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)
-* **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
-
-
----
-
-# urlGallery
-
-Newline-separated URLs.
- 
-
-* **file:** gallery/binary.cpp
-* **inherits:** [BinaryGallery](#binarygallery)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# utGallery
-
-A contiguous array of br_universal_template.
- 
-
-* **file:** gallery/binary.cpp
-* **inherits:** [BinaryGallery](#binarygallery)
-* **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
-
-
----
-
-# xmlGallery
-
-A sigset input.
- 
-
-* **file:** gallery/xml.cpp
-* **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)
-* **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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# DrawDelaunayTransform
-
-Creates a Delaunay triangulation based on a set of points
- 
-
-* **file:** gui/drawdelaunay.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# DrawGridLinesTransform
-
-Draws a grid on the image
- 
-
-* **file:** gui/drawgridlines.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DrawOpticalFlow
-
-Draw a line representing the direction and magnitude of optical flow at the specified points.
- 
-
-* **file:** gui/drawopticalflow.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# DrawPropertiesPointTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# DrawPropertyPointTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# DrawSegmentation
-
-Fill in the segmentations or draw a line between intersecting segments.
- 
-
-* **file:** gui/drawsegmentation.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# DrawTransform
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ElicitTransform
-
-Elicits metadata for templates in a pretty GUI
- 
-
-* **file:** gui/show.cpp
-* **inherits:** [ShowTransform](#showtransform)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# 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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# 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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# FilterTransform
-
-DOCUMENT ME
- 
-
-* **file:** gui/show.cpp
-* **inherits:** [ShowTransform](#showtransform)
-* **author(s):** [Unknown][unknown]
-* **properties:** None
-
-
----
-
-# 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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# ManualTransform
-
-Manual selection of landmark locations
- 
-
-* **file:** gui/show.cpp
-* **inherits:** [ShowTransform](#showtransform)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# ShowTrainingTransform
-
-Show the training data
- 
-
-* **file:** gui/show.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ShowTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# SurveyTransform
-
-Display an image, and asks a yes/no question about it
- 
-
-* **file:** gui/show.cpp
-* **inherits:** [ShowTransform](#showtransform)
-* **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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# AbsTransform
-
-Computes the absolute value of each element.
- 
-
-* **file:** imgproc/abs.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# AdaptiveThresholdTransform
-
-Wraps OpenCV's adaptive thresholding.
- 
-
-* **file:** imgproc/adaptivethreshold.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# AffineTransform
-
-Performs a two or three point registration.
- 
-
-* **file:** imgproc/affine.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# AndTransform
-
-Logical AND of two matrices.
- 
-
-* **file:** imgproc/and.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ApplyMaskTransform
-
-Applies a mask from the metadata.
- 
-
-* **file:** imgproc/applymask.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# BayesianQuantizationTransform
-
-Quantize into a space where L1 distance approximates log-likelihood.
- 
-
-* **file:** imgproc/bayesianquantization.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# BinarizeTransform
-
-Approximate floats as signed bit.
- 
-
-* **file:** imgproc/binarize.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# BlendTransform
-
-Alpha-blend two matrices
- 
-
-* **file:** imgproc/blend.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# BlurTransform
-
-Gaussian blur
- 
-
-* **file:** imgproc/blur.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# BuildScalesTransform
-
-DOCUMENT ME
- 
-
-* **file:** imgproc/multiscale.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# ByRowTransform
-
-Turns each row into its own matrix.
- 
-
-* **file:** imgproc/byrow.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CannyTransform
-
-Wrapper to OpenCV Canny edge detector
- 
-
-* **file:** imgproc/canny.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# 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(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# 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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CatTransform
-
-Concatenates all input matrices into a single matrix.
- 
-
-* **file:** imgproc/cat.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CenterTransform
-
-Normalize each dimension based on training data.
- 
-
-* **file:** imgproc/center.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ContrastEqTransform
-
-Perform contrast equalization
- 
-
-* **file:** imgproc/contrasteq.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# CropBlackTransform
-
-Crop out black borders
- 
-
-* **file:** imgproc/cropblack.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CropFromMaskTransform
-
-Crops image based on mask metadata
- 
-
-* **file:** imgproc/cropfrommask.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# 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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CropTransform
-
-Crops about the specified region of interest.
- 
-
-* **file:** imgproc/crop.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CryptographicHashTransform
-
-Wraps QCryptographicHash
- 
-
-* **file:** imgproc/cryptographichash.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **see:** [http://doc.qt.io/qt-5/qcryptographichash.html](http://doc.qt.io/qt-5/qcryptographichash.html)
-* **properties:** None
-
-
----
-
-# CvtFloatTransform
-
-Convert to floating point format.
- 
-
-* **file:** imgproc/cvtfloat.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CvtTransform
-
-Colorspace conversion.
- 
-
-* **file:** imgproc/cvt.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# CvtUCharTransform
-
-Convert to uchar format
- 
-
-* **file:** imgproc/cvtuchar.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DiscardAlphaTransform
-
-Drop the alpha channel (if exists).
- 
-
-* **file:** imgproc/discardalpha.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# DivTransform
-
-Enforce a multiple of n columns.
- 
-
-* **file:** imgproc/div.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DoGTransform
-
-Difference of gaussians
- 
-
-* **file:** imgproc/dog.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DownsampleTransform
-
-Downsample the rows and columns of a matrix.
- 
-
-* **file:** imgproc/downsample.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Lacey Best-Rowden][lbestrowden]
-* **properties:** None
-
-
----
-
-# DupTransform
-
-Duplicates the [Template](../cpp_api/template/template.md) data.
- 
-
-* **file:** imgproc/dup.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# EnsureChannelsTransform
-
-Enforce the matrix has a certain number of channels by adding or removing channels.
- 
-
-* **file:** imgproc/ensurechannels.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# EqualizeHistTransform
-
-Histogram equalization
- 
-
-* **file:** imgproc/equalizehist.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# FlipTransform
-
-Flips the image about an axis.
- 
-
-* **file:** imgproc/flip.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# FloodTransform
-
-Fill black pixels with the specified color.
- 
-
-* **file:** imgproc/flood.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# GaborJetTransform
-
-A vector of gabor wavelets applied at a point.
- 
-
-* **file:** imgproc/gabor.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# GaborTransform
-
-Implements a Gabor Filter
- 
-
-* **file:** imgproc/gabor.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **see:** [http://en.wikipedia.org/wiki/Gabor_filter](http://en.wikipedia.org/wiki/Gabor_filter)
-* **properties:** None
-
-
----
-
-# GammaTransform
-
-Gamma correction
- 
-
-* **file:** imgproc/gamma.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# GradientMaskTransform
-
-Masks image according to pixel change.
- 
-
-* **file:** imgproc/gradientmask.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# GradientTransform
-
-Computes magnitude and/or angle of image.
- 
-
-* **file:** imgproc/gradient.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# GroupTransform
-
-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(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
-
-
----
-
-# HistBinTransform
-
-Quantizes the values into bins.
- 
-
-* **file:** imgproc/histbin.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# HistEqQuantizationTransform
-
-Approximate floats as uchar with different scalings for each dimension.
- 
-
-* **file:** imgproc/histeqquantization.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# HistTransform
-
-Histograms the matrix
- 
-
-* **file:** imgproc/hist.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# HoGDescriptorTransform
-
-OpenCV HOGDescriptor wrapper
- 
-
-* **file:** imgproc/hog.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# InpaintTransform
-
-Wraps OpenCV inpainting
- 
-
-* **file:** imgproc/inpaint.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# IntegralHistTransform
-
-An integral histogram
- 
-
-* **file:** imgproc/integralhist.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# IntegralSamplerTransform
-
-Sliding window feature extraction from a multi-channel integral image.
- 
-
-* **file:** imgproc/integralsampler.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# IntegralSlidingWindowTransform
-
-Overloads SlidingWindowTransform for integral images that should be
-sampled at multiple scales.
- 
-
-* **file:** imgproc/slidingwindow.cpp
-* **inherits:** [SlidingWindowTransform](#slidingwindowtransform)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# IntegralTransform
-
-Computes integral image.
- 
-
-* **file:** imgproc/integral.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# KernelHashTransform
-
-Kernel hash
- 
-
-* **file:** imgproc/kernelhash.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# KeyPointDescriptorTransform
-
-Wraps OpenCV Key Point Descriptor
- 
-
-* **file:** imgproc/keypointdescriptor.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# LBPTransform
-
-Convert the image into a feature vector using Local Binary Patterns
- 
-
-* **file:** imgproc/lbp.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# LTPTransform
-
-DOCUMENT ME
- 
-
-* **file:** imgproc/ltp.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# 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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# LimitSizeTransform
-
-Limit the size of the template
- 
-
-* **file:** imgproc/limitsize.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# MAddTransform
-
-dst = a src+b
- 
-
-* **file:** imgproc/madd.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# MaskTransform
-
-Applies an eliptical mask
- 
-
-* **file:** imgproc/mask.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# MatStatsTransform
-
-Statistics
- 
-
-* **file:** imgproc/matstats.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# MeanFillTransform
-
-Fill 0 pixels with the mean of non-0 pixels.
- 
-
-* **file:** imgproc/meanfill.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# MeanTransform
-
-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(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# MergeTransform
-
-Wraps OpenCV merge
- 
-
-* **file:** imgproc/merge.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **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
-
-
----
-
-# MorphTransform
-
-Morphological operator
- 
-
-* **file:** imgproc/morph.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# NLMeansDenoisingTransform
-
-Wraps OpenCV Non-Local Means Denoising
- 
-
-* **file:** imgproc/denoising.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# NormalizeTransform
-
-Normalize matrix to unit length
- 
-
-* **file:** imgproc/normalize.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:**
-
-	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(s):** [E. Taborsky][mmtaborsky]
-* **properties:** None
-
-
----
-
-# PackTransform
-
-Compress two uchar into one uchar.
- 
-
-* **file:** imgproc/pack.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# PowTransform
-
-Raise each element to the specified power.
- 
-
-* **file:** imgproc/pow.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ProductQuantizationDistance
-
-Distance in a product quantized space
- 
-
-* **file:** imgproc/productquantization.cpp
-* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)
-* **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
-
-
----
-
-# ProductQuantizationTransform
-
-Product quantization
- 
-
-* **file:** imgproc/productquantization.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **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
-
-
----
-
-# QuantizeTransform
-
-Approximate floats as uchar.
- 
-
-* **file:** imgproc/quantize.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RGTransform
-
-Normalized RG color space.
- 
-
-* **file:** imgproc/rg.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ROIFromPtsTransform
-
-Crops the rectangular regions of interest from given points and sizes.
- 
-
-* **file:** imgproc/roifrompoints.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# ROITransform
-
-Crops the rectangular regions of interest.
- 
-
-* **file:** imgproc/roi.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RankTransform
-
-Converts each element to its rank-ordered value.
- 
-
-* **file:** imgproc/rank.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RectRegionsTransform
-
-Subdivide matrix into rectangular subregions.
- 
-
-* **file:** imgproc/rectregions.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RecursiveIntegralSamplerTransform
-
-Construct [Template](../cpp_api/template/template.md) in a recursive decent manner.
- 
-
-* **file:** imgproc/recursiveintegralsampler.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RedLinearRegressionTransform
-
-Prediction using only the red wavelength; magic numbers from jmp
- 
-
-* **file:** imgproc/redlinearregression.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [E. Taborsky][mmtaborsky]
-* **properties:** None
-
-
----
-
-# ReshapeTransform
-
-Reshape each matrix to the specified number of rows.
- 
-
-* **file:** imgproc/reshape.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ResizeTransform
-
-Resize the template
- 
-
-* **file:** imgproc/resize.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# RndPointTransform
-
-Generates a random landmark.
- 
-
-* **file:** imgproc/rndpoint.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RndRegionTransform
-
-Selects a random region.
- 
-
-* **file:** imgproc/rndregion.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RndRotateTransform
-
-Randomly rotates an image in a specified range.
- 
-
-* **file:** imgproc/rndrotate.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# RndSubspaceTransform
-
-Generates a random subspace.
- 
-
-* **file:** imgproc/rndsubspace.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RootNormTransform
-
-dst=sqrt(norm_L1(src)) proposed as RootSIFT (see paper)
- 
-
-* **file:** imgproc/rootnorm.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# RowWiseMeanCenterTransform
-
-Remove the row-wise training set average.
- 
-
-* **file:** imgproc/rowwisemeancenter.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# SIFTDescriptorTransform
-
-Specialize wrapper OpenCV SIFT wrapper
- 
-
-* **file:** imgproc/sift.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# SampleFromMaskTransform
-
-Samples pixels from a mask.
- 
-
-* **file:** imgproc/samplefrommask.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# ScaleTransform
-
-Scales using the given factor
- 
-
-* **file:** imgproc/scale.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# SkinMaskTransform
-
-Make a mask over skin in an image
- 
-
-* **file:** imgproc/skinmask.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **see:** [http://worldofcameras.wordpress.com/tag/skin-detection-opencv/](http://worldofcameras.wordpress.com/tag/skin-detection-opencv/)
-* **properties:** None
-
-
----
-
-# SlidingWindowTransform
-
-Applies a transform to a sliding window.
-Discards negative detections.
- 
-
-* **file:** imgproc/slidingwindow.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# SplitChannelsTransform
-
-Split a multi-channel matrix into several single-channel matrices.
- 
-
-* **file:** imgproc/splitchannels.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# SubdivideTransform
-
-Divide the matrix into 4 smaller matricies of equal size.
- 
-
-* **file:** imgproc/subdivide.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# SubtractTransform
-
-Subtract two matrices.
- 
-
-* **file:** imgproc/subtract.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ThresholdTransform
-
-Wraps OpenCV's adaptive thresholding.
- 
-
-* **file:** imgproc/threshold.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# WatershedSegmentationTransform
-
-Applies watershed segmentation.
- 
-
-* **file:** imgproc/watershedsegmentation.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# DecodeTransform
-
-Decodes images
- 
-
-* **file:** io/decode.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DownloadTransform
-
-Downloads an image from a URL
- 
-
-* **file:** io/download.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **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
-
-
----
-
-# IncrementalOutputTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# OpenTransform
-
-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(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
-
-
----
-
-# PrintTransform
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ReadLandmarksTransform
-
-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(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
-
-
----
-
-# ReadTransform
-
-Read images
- 
-
-* **file:** io/read.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# WriteTransform
-
-Write all mats to disk as images.
- 
-
-* **file:** io/write.cpp
-* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)
-* **author(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# YouTubeFacesDBTransform
-
-Implements the YouTubesFaceDB
- 
-
-* **file:** io/youtubefacesdb.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **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
-
-Find eye locations using an ASEF filter
- 
-
-* **file:** metadata/eyes.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# AnonymizeLandmarksTransform
-
-Remove a name from a point/rect
- 
-
-* **file:** metadata/anonymizelandmarks.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# AsTransform
-
-Change the [Template](../cpp_api/template/template.md) file extension
- 
-
-* **file:** metadata/as.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# AveragePointsTransform
-
-Averages a set of landmarks into a new landmark
- 
-
-* **file:** metadata/averagepoints.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# CascadeTransform
-
-Wraps OpenCV cascade classifier
- 
-
-* **file:** metadata/cascade.cpp
-* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)
-* **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
-
-
----
-
-# CheckTransform
-
-Checks the [Template](../cpp_api/template/template.md) for NaN values.
- 
-
-* **file:** metadata/check.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ClearPointsTransform
-
-Clears the points from a [Template](../cpp_api/template/template.md)
- 
-
-* **file:** metadata/clearpoints.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# ConsolidateDetectionsTransform
-
-Consolidate redundant/overlapping detections.
- 
-
-* **file:** metadata/consolidatedetections.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# CropRectTransform
-
-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(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# DelaunayTransform
-
-Creates a Delaunay triangulation based on a set of points
- 
-
-* **file:** metadata/delaunay.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# ExpandRectTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# ExtractMetadataTransform
-
-Create matrix from metadata values.
- 
-
-* **file:** metadata/extractmetadata.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **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
-
-
----
-
-# FilterDupeMetadataTransform
-
-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(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-
-# GridTransform
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# GroundTruthTransform
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# HOGPersonDetectorTransform
-
-Detects objects with OpenCV's built-in HOG detection.
- 
-
-* **file:** metadata/hogpersondetector.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# IfMetadataTransform
-
-Clear [Template](../cpp_api/template/template.md) without the required metadata.
- 
-
-* **file:** metadata/ifmetadata.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# ImpostorUniquenessMeasureTransform
-
-Impostor Uniqueness Measure
- 
-
-* **file:** metadata/imposteruniquenessmeasure.cpp
-* **inherits:** [Transform](../cpp_api/transform/transform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# JSONTransform
-
-Represent the metadata as JSON template data.
- 
-
-* **file:** metadata/json.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# 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(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# KeyPointDetectorTransform
-
-Wraps OpenCV Key Point Detector
- 
-
-* **file:** metadata/keypointdetector.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **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
-
-
----
-
-# 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(s):** [Jordan Cheney][JordanCheney]
-* **properties:** None
-
-
----
-
-# NameLandmarksTransform
-
-Name a point/rect
- 
-
-* **file:** metadata/namelandmarks.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# NameTransform
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# NormalizePointsTransform
-
-Normalize points to be relative to a single point
- 
-
-* **file:** metadata/normalizepoints.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# PointDisplacementTransform
-
-Normalize points to be relative to a single point
- 
-
-* **file:** metadata/pointdisplacement.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# PointsToMatrixTransform
-
-Converts either the file::points() list or a QList<QPointF> metadata item to be the template's matrix
- 
-
-* **file:** metadata/pointstomatrix.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# ProcrustesTransform
-
-Procrustes alignment of points
- 
-
-* **file:** metadata/procrustes.cpp
-* **inherits:** [MetadataTransform](../cpp_api/metadatatransform/metadatatransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# RectsToTemplatesTransform
-
-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(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# RegexPropertyTransform
-
-Apply the input regular expression to the value of inputProperty, store the matched portion in outputProperty.
- 
-
-* **file:** metadata/regexproperty.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# RemoveMetadataTransform
-
-Removes a metadata field from all [Template](../cpp_api/template/template.md)
- 
-
-* **file:** metadata/removemetadata.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# RemoveTemplatesTransform
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RenameFirstTransform
-
-Rename first found metadata key
- 
-
-* **file:** metadata/renamefirst.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# RenameTransform
-
-Rename metadata key
- 
-
-* **file:** metadata/rename.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# 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(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# RestoreMatTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# SaveMatTransform
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# SelectPointsTransform
-
-Retains only landmarks/points at the provided indices
- 
-
-* **file:** metadata/selectpoints.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Brendan Klare][bklare]
-* **properties:** None
-
-
----
-
-# SetMetadataTransform
-
-Sets the metadata key/value pair.
- 
-
-* **file:** metadata/setmetadata.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# SetPointsInRectTransform
-
-Set points relative to a rect
- 
-
-* **file:** metadata/setpointsinrect.cpp
-* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)
-* **author(s):** [Jordan Cheney][JordanCheney]
-* **properties:** None
-
-
----
-
-# StasmTransform
-
-Wraps STASM key point detector
- 
-
-* **file:** metadata/stasm4.cpp
-* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# StopWatchTransform
-
-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)
-* **author(s):** [Jordan Cheney][JordanCheney], [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DefaultOutput
-
-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(s):** [Charles Otto][caotto]
-* **properties:** None
-
-
----
-
-# EmptyOutput
-
-Output to the terminal.
- 
-
-* **file:** output/empty.cpp
-* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# bestOutput
-
-The highest scoring matches.
- 
-
-* **file:** output/best.cpp
-* **inherits:** [Output](../cpp_api/output/output.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# csvOutput
-
-Comma separated values output.
- 
-
-* **file:** output/csv.cpp
-* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# evalOutput
-
-Evaluate the output matrix.
- 
-
-* **file:** output/eval.cpp
-* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# heatOutput
-
-Matrix-like output for heat maps.
- 
-
-* **file:** output/heat.cpp
-* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# histOutput
-
-Score histogram.
- 
-
-* **file:** output/hist.cpp
-* **inherits:** [Output](../cpp_api/output/output.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# meltOutput
-
-One score per row.
- 
-
-* **file:** output/melt.cpp
-* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# mtxOutput
-
-simmat output.
- 
-
-* **file:** output/mtx.cpp
-* **inherits:** [Output](../cpp_api/output/output.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# nullOutput
-
-Discards the scores.
- 
-
-* **file:** output/null.cpp
-* **inherits:** [Output](../cpp_api/output/output.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# rankOutput
-
-Outputs highest ranked matches with scores.
- 
-
-* **file:** output/rank.cpp
-* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author(s):** [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# rrOutput
-
-Rank retrieval output.
- 
-
-* **file:** output/rr.cpp
-* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author(s):** [Josh Klontz][jklontz], [Scott Klum][sklum]
-* **properties:** None
-
-
----
-
-# tailOutput
-
-The highest scoring matches.
- 
-
-* **file:** output/tail.cpp
-* **inherits:** [Output](../cpp_api/output/output.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# txtOutput
-
-Text file output.
- 
-
-* **file:** output/txt.cpp
-* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
-* **author(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# AggregateFrames
-
-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(s):** [Josh Klontz][jklontz]
-* **properties:** None
-
-
----
-
-# DropFrames
-
-Only use one frame every n frames.
- 
-
-* **file:** video/drop.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Austin Blanton][imaus10
-  
-   For a video with m frames, DropFrames will pass on m/n frames.]
-* **properties:** None
-
-
----
-
-# OpticalFlowTransform
-
-Gets a one-channel dense optical flow from two images
- 
-
-* **file:** video/opticalflow.cpp
-* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)
-* **author(s):** [Austin Blanton][imaus10]
-* **properties:** None
-
-
----
-