Commit 1a784fc27037eecfe603a9e55db8d04e5d8610e6

Authored by Jordan Cheney
1 parent e41e8d5d

Empty file cleanup

Showing 70 changed files with 9 additions and 4564 deletions
docs/docs/api_docs/cpp_api/classifier/classifier.md
@@ -4,7 +4,6 @@ Inherits [Object](../object/object.md) @@ -4,7 +4,6 @@ Inherits [Object](../object/object.md)
4 4
5 See: 5 See:
6 6
7 -* [Members](members.md)  
8 * [Constructors](constructors.md) 7 * [Constructors](constructors.md)
9 * [Static Functions](statics.md) 8 * [Static Functions](statics.md)
10 * [Functions](functions.md) 9 * [Functions](functions.md)
docs/docs/api_docs/cpp_api/classifier/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/compositetransform/compositetransform.md
@@ -9,7 +9,6 @@ See: @@ -9,7 +9,6 @@ See:
9 * [Properties](properties.md) 9 * [Properties](properties.md)
10 * [Members](members.md) 10 * [Members](members.md)
11 * [Constructors](constructors.md) 11 * [Constructors](constructors.md)
12 -* [Static Functions](statics.md)  
13 * [Functions](functions.md) 12 * [Functions](functions.md)
14 13
15 -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.  
16 \ No newline at end of file 14 \ No newline at end of file
  15 +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.
docs/docs/api_docs/cpp_api/compositetransform/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/context/constructors.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/context/context.md
1 <!-- CONTEXT --> 1 <!-- CONTEXT -->
2 2
3 -The singleton class of global settings. 3 +The singleton class of global settings.
4 4
5 See: 5 See:
6 6
7 * [Members](members.md) 7 * [Members](members.md)
8 -* [Constructors](constructors.md)  
9 * [Static Functions](statics.md) 8 * [Static Functions](statics.md)
10 * [Functions](functions.md) 9 * [Functions](functions.md)
11 10
12 -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.  
13 \ No newline at end of file 11 \ No newline at end of file
  12 +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.
docs/docs/api_docs/cpp_api/distance/distance.md
@@ -6,7 +6,6 @@ Plugin base class for comparing two [Templates](../template/template.md) @@ -6,7 +6,6 @@ Plugin base class for comparing two [Templates](../template/template.md)
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 * [Static Functions](statics.md) 10 * [Static Functions](statics.md)
12 * [Functions](functions.md) 11 * [Functions](functions.md)
docs/docs/api_docs/cpp_api/distance/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/factory/factory.md
@@ -8,8 +8,7 @@ See: @@ -8,8 +8,7 @@ See:
8 * [Constructors](constructors.md) 8 * [Constructors](constructors.md)
9 * [Macros](macros.md) 9 * [Macros](macros.md)
10 * [Static Functions](statics.md) 10 * [Static Functions](statics.md)
11 -* [Functions](functions.md)  
12 11
13 Uses the Industrial Strength Pluggable Factory model described [here](http://adtmag.com/articles/2000/09/25/industrial-strength-pluggable-factories.aspx). 12 Uses the Industrial Strength Pluggable Factory model described [here](http://adtmag.com/articles/2000/09/25/industrial-strength-pluggable-factories.aspx).
14 13
15 -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.  
16 \ No newline at end of file 14 \ No newline at end of file
  15 +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.
docs/docs/api_docs/cpp_api/factory/functions.md deleted
1 -None  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/filegallery/filegallery.md
@@ -8,7 +8,6 @@ See: @@ -8,7 +8,6 @@ See:
8 8
9 * [Members](members.md) 9 * [Members](members.md)
10 * [Constructors](constructors.md) 10 * [Constructors](constructors.md)
11 -* [Static Functions](statics.md)  
12 * [Functions](functions.md) 11 * [Functions](functions.md)
13 12
14 -[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.  
15 \ No newline at end of file 13 \ No newline at end of file
  14 +[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.
docs/docs/api_docs/cpp_api/filegallery/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/filelist/filelist.md
@@ -4,7 +4,6 @@ Inherits [QList][QList]&amp;lt;[File](../file/file.md)&amp;gt;. @@ -4,7 +4,6 @@ Inherits [QList][QList]&amp;lt;[File](../file/file.md)&amp;gt;.
4 4
5 See: 5 See:
6 6
7 -* [Members](members.md)  
8 * [Constructors](constructors.md) 7 * [Constructors](constructors.md)
9 * [Static Functions](statics.md) 8 * [Static Functions](statics.md)
10 * [Functions](functions.md) 9 * [Functions](functions.md)
docs/docs/api_docs/cpp_api/filelist/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/format/format.md
@@ -6,7 +6,6 @@ Plugin base class for reading a template from disk. @@ -6,7 +6,6 @@ Plugin base class for reading a template from disk.
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 * [Static Functions](statics.md) 10 * [Static Functions](statics.md)
12 * [Functions](functions.md) 11 * [Functions](functions.md)
docs/docs/api_docs/cpp_api/format/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/gallery/gallery.md
@@ -7,7 +7,6 @@ Plugin base class for storing a list of enrolled templates. @@ -7,7 +7,6 @@ Plugin base class for storing a list of enrolled templates.
7 See: 7 See:
8 8
9 * [Properties](properties.md) 9 * [Properties](properties.md)
10 -* [Members](members.md)  
11 * [Constructors](constructors.md) 10 * [Constructors](constructors.md)
12 * [Static Functions](statics.md) 11 * [Static Functions](statics.md)
13 * [Functions](functions.md) 12 * [Functions](functions.md)
docs/docs/api_docs/cpp_api/gallery/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/initializer/initializer.md
@@ -4,9 +4,7 @@ Inherits [Object](../object/object.md) @@ -4,9 +4,7 @@ Inherits [Object](../object/object.md)
4 4
5 See: 5 See:
6 6
7 -* [Members](members.md)  
8 * [Constructors](constructors.md) 7 * [Constructors](constructors.md)
9 -* [Static Functions](statics.md)  
10 * [Functions](functions.md) 8 * [Functions](functions.md)
11 9
12 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. 10 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.
docs/docs/api_docs/cpp_api/initializer/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/initializer/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/matrixoutput/constructors.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/matrixoutput/matrixoutput.md
@@ -5,7 +5,6 @@ Inherits from [Output](../output/output.md) @@ -5,7 +5,6 @@ Inherits from [Output](../output/output.md)
5 See: 5 See:
6 6
7 * [Members](members.md) 7 * [Members](members.md)
8 -* [Constructors](constructors.md)  
9 * [Static Functions](statics.md) 8 * [Static Functions](statics.md)
10 * [Functions](functions.md) 9 * [Functions](functions.md)
11 10
docs/docs/api_docs/cpp_api/metadatatransform/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/metadatatransform/metadatatransform.md
@@ -6,9 +6,7 @@ A [Transform](../transform/transform.md) that requires only [Template](../templa @@ -6,9 +6,7 @@ A [Transform](../transform/transform.md) that requires only [Template](../templa
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 -* [Static Functions](statics.md)  
12 * [Functions](functions.md) 10 * [Functions](functions.md)
13 11
14 [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). 12 [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).
docs/docs/api_docs/cpp_api/metadatatransform/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/metatransform/functions.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/metatransform/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/metatransform/metatransform.md
@@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that expect multiple matrices per [Temp @@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that expect multiple matrices per [Temp
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 -* [Static Functions](statics.md)  
12 -* [Functions](functions.md)  
13 10
14 -[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. 11 +[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.
docs/docs/api_docs/cpp_api/metatransform/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/object/constructors.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/object/object.md
@@ -5,9 +5,8 @@ Inherits from [QObject][QObject] @@ -5,9 +5,8 @@ Inherits from [QObject][QObject]
5 See: 5 See:
6 6
7 * [Members](members.md) 7 * [Members](members.md)
8 -* [Constructors](constructors.md)  
9 * [Macros](macros.md) 8 * [Macros](macros.md)
10 * [Static Functions](statics.md) 9 * [Static Functions](statics.md)
11 * [Functions](functions.md) 10 * [Functions](functions.md)
12 11
13 -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.  
14 \ No newline at end of file 12 \ No newline at end of file
  13 +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.
docs/docs/api_docs/cpp_api/representation/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/representation/representation.md
@@ -6,7 +6,6 @@ Plugin base class for converting images into feature vectors @@ -6,7 +6,6 @@ Plugin base class for converting images into feature vectors
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 * [Static Functions](statics.md) 10 * [Static Functions](statics.md)
12 * [Functions](functions.md) 11 * [Functions](functions.md)
docs/docs/api_docs/cpp_api/templatelist/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/templatelist/templatelist.md
@@ -6,8 +6,6 @@ Convenience class for working with a list of templates. @@ -6,8 +6,6 @@ Convenience class for working with a list of templates.
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 * [Static Functions](statics.md) 10 * [Static Functions](statics.md)
12 * [Functions](functions.md) 11 * [Functions](functions.md)
13 -  
docs/docs/api_docs/cpp_api/timevaryingtransform/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/timevaryingtransform/timevaryingtransform.md
@@ -8,7 +8,6 @@ See: @@ -8,7 +8,6 @@ See:
8 8
9 * [Members](members.md) 9 * [Members](members.md)
10 * [Constructors](constructors.md) 10 * [Constructors](constructors.md)
11 -* [Static Functions](statics.md)  
12 * [Functions](functions.md) 11 * [Functions](functions.md)
13 12
14 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. 13 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.
docs/docs/api_docs/cpp_api/untrainabledistance/constructors.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainabledistance/functions.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainabledistance/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainabledistance/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainabledistance/untrainabledistance.md
@@ -6,9 +6,4 @@ A [Distance](../distance/distance.md) that does not require training. @@ -6,9 +6,4 @@ A [Distance](../distance/distance.md) that does not require training.
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 -* [Constructors](constructors.md)  
11 -* [Static Functions](statics.md)  
12 -* [Functions](functions.md)  
13 -  
14 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. 9 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.
docs/docs/api_docs/cpp_api/untrainablemetadatatransform/functions.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainablemetadatatransform/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainablemetadatatransform/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md
@@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that requires only [Template](../templa @@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that requires only [Template](../templa
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 -* [Static Functions](statics.md)  
12 -* [Functions](functions.md)  
13 10
14 [UntrainableMetadataTransforms](untrainablemetadatatransform.md) are [Transforms](../transform/transform.md) that operate soley on textual [metadata](../template/members.md#file). They are *not* [independent](../transform/members.md#independent), because [Templates](../template/template.md) can only every have one collection of [metadata](../template/members.md#file), and they are *not* [trainable](../transform/members.md#trainable). 11 [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).
docs/docs/api_docs/cpp_api/untrainablemetatransform/functions.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainablemetatransform/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainablemetatransform/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainablemetatransform/untrainablemetatransform.md
@@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that expect multiple matrices per [Temp @@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that expect multiple matrices per [Temp
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 -* [Static Functions](statics.md)  
12 -* [Functions](functions.md)  
13 10
14 -[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. 11 +[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.
docs/docs/api_docs/cpp_api/untrainabletransform/functions.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainabletransform/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainabletransform/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/untrainabletransform/untrainabletransform.md
@@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that does not require training. @@ -6,9 +6,6 @@ A [Transform](../transform/transform.md) that does not require training.
6 6
7 See: 7 See:
8 8
9 -* [Members](members.md)  
10 * [Constructors](constructors.md) 9 * [Constructors](constructors.md)
11 -* [Static Functions](statics.md)  
12 -* [Functions](functions.md)  
13 10
14 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. 11 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.
docs/docs/api_docs/cpp_api/wrappertransform/members.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/wrappertransform/statics.md deleted
1 -NONE  
2 \ No newline at end of file 0 \ No newline at end of file
docs/docs/api_docs/cpp_api/wrappertransform/wrappertransform.md
@@ -7,9 +7,7 @@ Base class for [Transforms](../transform/transform.md) that have a single child @@ -7,9 +7,7 @@ Base class for [Transforms](../transform/transform.md) that have a single child
7 See: 7 See:
8 8
9 * [Properties](properties.md) 9 * [Properties](properties.md)
10 -* [Members](members.md)  
11 * [Constructors](constructors.md) 10 * [Constructors](constructors.md)
12 -* [Static Functions](statics.md)  
13 * [Functions](functions.md) 11 * [Functions](functions.md)
14 12
15 -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.  
16 \ No newline at end of file 13 \ No newline at end of file
  14 +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.
docs/docs/api_docs/plugins/classification.md deleted
1 -# AdaBoostTransform  
2 -  
3 -Wraps OpenCV's Ada Boost framework  
4 -  
5 -  
6 -* **file:** classification/adaboost.cpp  
7 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
8 -* **author(s):** [Scott Klum][sklum]  
9 -* **see:** [http://docs.opencv.org/modules/ml/doc/boosting.html](http://docs.opencv.org/modules/ml/doc/boosting.html)  
10 -* **properties:**  
11 -  
12 - Property | Type | Description  
13 - --- | --- | ---  
14 - 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.  
15 - 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.  
16 - int | weakCount | Maximum number of weak classifiers per stage. Default is 100.  
17 - float | trimRate | A threshold between 0 and 1 used to save computational time. Samples with summary weight  
18 - int | folds | OpenCV parameter variable. Default value is 0.  
19 - int | maxDepth | Maximum height of each weak classifier tree. Default is 1 (stumps).  
20 - bool | returnConfidence | Return the confidence value of the classification or the class value of the classification. Default is true (return confidence value).  
21 - 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.  
22 - QString | inputVariable | Metadata variable storing the label for each template. Default is "Label".  
23 - 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 "".  
24 -  
25 ----  
26 -  
27 -# DFFSTransform  
28 -  
29 -Computes [Distance](../cpp_api/distance/distance.md) From Feature Space (DFFS)  
30 -  
31 -  
32 -* **file:** classification/lda.cpp  
33 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
34 -* **author(s):** [Josh Klontz][jklontz]  
35 -* **read:**  
36 -  
37 - 1. *Moghaddam, Baback, and Alex Pentland.*  
38 - **"Probabilistic visual learning for object representation."**  
39 - Pattern Analysis and Machine Intelligence, IEEE Transactions on 19.7 (1997): 696-710.  
40 -  
41 -* **properties:**  
42 -  
43 - Property | Type | Description  
44 - --- | --- | ---  
45 - keep | float | Sets PCA keep property. Default is 0.95.  
46 -  
47 ----  
48 -  
49 -# EBIFTransform  
50 -  
51 -Face Recognition Using Early Biologically Inspired Features  
52 -  
53 -  
54 -* **file:** classification/ebif.cpp  
55 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
56 -* **author(s):** [Josh Klontz][jklontz]  
57 -* **read:**  
58 -  
59 - 1. *Li, Min, et al.*  
60 - **"Face recognition using early biologically inspired features."**  
61 - Biometrics: Theory, Applications and Systems (BTAS), 2013 IEEE Sixth International Conference on. IEEE, 2013.  
62 -  
63 -* **properties:**  
64 -  
65 - Property | Type | Description  
66 - --- | --- | ---  
67 - N | int | The number of scales. Default is 6.  
68 - M | int | The number of orientations between 0 and pi. Default is 9.  
69 -  
70 ----  
71 -  
72 -# ForestInductionTransform  
73 -  
74 -Wraps OpenCV's random trees framework to induce features  
75 -  
76 -  
77 -* **file:** classification/forest.cpp  
78 -* **inherits:** [ForestTransform](#foresttransform)  
79 -* **author(s):** [Scott Klum][sklum]  
80 -* **see:** [https://lirias.kuleuven.be/bitstream/123456789/316661/1/icdm11-camready.pdf](https://lirias.kuleuven.be/bitstream/123456789/316661/1/icdm11-camready.pdf)  
81 -* **properties:**  
82 -  
83 - Property | Type | Description  
84 - --- | --- | ---  
85 - useRegressionValue | bool | SCOTT FILL ME IN.  
86 -  
87 ----  
88 -  
89 -# ForestTransform  
90 -  
91 -Wraps OpenCV's random trees framework  
92 -  
93 -  
94 -* **file:** classification/forest.cpp  
95 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
96 -* **author(s):** [Scott Klum][sklum]  
97 -* **see:** [http://docs.opencv.org/modules/ml/doc/random_trees.html](http://docs.opencv.org/modules/ml/doc/random_trees.html)  
98 -* **properties:**  
99 -  
100 - Property | Type | Description  
101 - --- | --- | ---  
102 - classification | bool | If true the labels are expected to be categorical. Otherwise they are expected to be numerical. Default is true.  
103 - 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.  
104 - maxDepth | int | The maximum depth of each decision tree. Default is std::numeric_limits<int>::max() and typically should be set by the user.  
105 - maxTrees | int | The maximum number of trees in the forest. Default is 10.  
106 - forestAccuracy | float | A sufficient accuracy for the forest for training to terminate. Used if termCrit is EPS or Both. Default is 0.1.  
107 - returnConfidence | bool | If both classification and returnConfidence are use a fuzzy class label as the output of the forest. Default is true.  
108 - 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.  
109 - inputVariable | QString | The metadata key for each templates label. Default is "Label".  
110 - outputVariable | QString | The metadata key for the forest response if overwriteMat is false. Default is "".  
111 - weight | bool | If true and classification is true the random forest will use prior accuracies. Default is false.  
112 - 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.  
113 -  
114 ----  
115 -  
116 -# IPC2013FaceRecognitionTransform  
117 -  
118 -Intel Perceptual Computing SDK 2013 Face Recognition  
119 -  
120 -  
121 -* **file:** classification/ipc2013.cpp  
122 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
123 -* **author(s):** [Josh Klontz][jklontz]  
124 -* **properties:** None  
125 -  
126 -  
127 ----  
128 -  
129 -# LDATransform  
130 -  
131 -Projects input into learned Linear Discriminant Analysis subspace.  
132 -  
133 -  
134 -* **file:** classification/lda.cpp  
135 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
136 -* **author(s):** [Brendan Klare][bklare], [Josh Klontz][jklontz]  
137 -* **properties:**  
138 -  
139 - Property | Type | Description  
140 - --- | --- | ---  
141 - pcaKeep | float | BRENDAN OR JOSH FILL ME IN. Default is 0.98.  
142 - pcaWhiten | bool | BRENDAN OR JOSH FILL ME IN. Default is false.  
143 - directLDA | int | BRENDAN OR JOSH FILL ME IN. Default is 0.  
144 - directDrop | float | BRENDAN OR JOSH FILL ME IN. Default is 0.1.  
145 - inputVariable | QString | BRENDAN OR JOSH FILL ME IN. Default is "Label".  
146 - isBinary | bool | BRENDAN OR JOSH FILL ME IN. Default is false.  
147 - normalize | bool | BRENDAN OR JOSH FILL ME IN. Default is true.  
148 -  
149 ----  
150 -  
151 -# Linear  
152 -  
153 -DOCUMENT ME SCOTT  
154 -  
155 -  
156 -* **file:** classification/liblinear.cpp  
157 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
158 -* **author(s):** [Scott Klum][sklum]  
159 -* **properties:** None  
160 -  
161 -  
162 ----  
163 -  
164 -# MLPTransform  
165 -  
166 -Wraps OpenCV's multi-layer perceptron framework  
167 -  
168 -  
169 -* **file:** classification/mlp.cpp  
170 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
171 -* **author(s):** [Scott Klum][sklum]  
172 -* **see:** [http://docs.opencv.org/modules/ml/doc/neural_networks.html](http://docs.opencv.org/modules/ml/doc/neural_networks.html)  
173 -* **properties:**  
174 -  
175 - Property | Type | Description  
176 - --- | --- | ---  
177 - kernel | enum | Type of MLP kernel to use. Options are Identity, Sigmoid, Gaussian. Default is Sigmoid.  
178 - alpha | float | Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.  
179 - beta | float | Determines activation function for neural network. See OpenCV documentation for more details. Default is 1.  
180 - 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().  
181 - 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().  
182 - neuronsPerLayer | QList<int> | The number of neurons in each layer of the net. Default is QList<int>() << 1 << 1.  
183 -  
184 ----  
185 -  
186 -# NT4Compare  
187 -  
188 -Compare templates with Neurotech SDK 4  
189 -  
190 -  
191 -* **file:** classification/nt4.cpp  
192 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
193 -* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]  
194 -* **properties:** None  
195 -  
196 -  
197 ----  
198 -  
199 -# NT4DetectFace  
200 -  
201 -Neurotech face detection  
202 -  
203 -  
204 -* **file:** classification/nt4.cpp  
205 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
206 -* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]  
207 -* **properties:** None  
208 -  
209 -  
210 ----  
211 -  
212 -# NT4EnrollFace  
213 -  
214 -Enroll face in Neurotech SDK 4  
215 -  
216 -  
217 -* **file:** classification/nt4.cpp  
218 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
219 -* **author(s):** [Josh Klontz][jklontz]  
220 -* **properties:** None  
221 -  
222 -  
223 ----  
224 -  
225 -# NT4EnrollIris  
226 -  
227 -Enroll iris in Neurotech SDK 4  
228 -  
229 -  
230 -* **file:** classification/nt4.cpp  
231 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
232 -* **author(s):** [E. Taborsky][mmtaborsky]  
233 -* **properties:** None  
234 -  
235 -  
236 ----  
237 -  
238 -# PCATransform  
239 -  
240 -Projects input into learned Principal Component Analysis subspace.  
241 -  
242 -  
243 -* **file:** classification/lda.cpp  
244 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
245 -* **author(s):** [Brendan Klare][bklare], [Josh Klontz][jklontz]  
246 -* **properties:**  
247 -  
248 - Property | Type | Description  
249 - --- | --- | ---  
250 - 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.  
251 - drop | int | BRENDAN OR JOSH FILL ME IN. Default is 0.  
252 - whiten | bool | BRENDAN OR JOSH FILL ME IN. Default is false.  
253 -  
254 ----  
255 -  
256 -# PP4Compare  
257 -  
258 -Compare faces using PittPatt 4.  
259 -  
260 -  
261 -* **file:** classification/pp4.cpp  
262 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
263 -* **author(s):** [Josh Klontz][jklontz]  
264 -* **properties:** None  
265 -  
266 -  
267 ----  
268 -  
269 -# PP4EnrollTransform  
270 -  
271 -Enroll faces in PittPatt 4  
272 -  
273 -  
274 -* **file:** classification/pp4.cpp  
275 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
276 -* **author(s):** [Josh Klontz][jklontz]  
277 -* **properties:**  
278 -  
279 - Property | Type | Description  
280 - --- | --- | ---  
281 - detectOnly | bool | If true, return all detected faces. Otherwise, return only faces that are suitable for recognition. Default is false.  
282 -  
283 ----  
284 -  
285 -# PP5CompareDistance  
286 -  
287 -Compare templates with PP5. PP5 distance is known to be asymmetric  
288 -  
289 -  
290 -* **file:** classification/pp5.cpp  
291 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
292 -* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]  
293 -* **properties:** None  
294 -  
295 -  
296 ----  
297 -  
298 -# PP5EnrollTransform  
299 -  
300 -Enroll faces in PP5  
301 -  
302 -  
303 -* **file:** classification/pp5.cpp  
304 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
305 -* **author(s):** [Josh Klontz][jklontz], [E. Taborsky][mmtaborsky]  
306 -* **properties:**  
307 -  
308 - Property | Type | Description  
309 - --- | --- | ---  
310 - detectOnly | bool | If true, enroll all detected faces. Otherwise, only enroll faces suitable for recognition. Default is false.  
311 - 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.  
312 - 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.  
313 - 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.  
314 - landmarkRange | enum | Range of landmarks to search for. Options are Frontal, Extended, Full, and Comprehensive. Default is Comprehensive.  
315 - 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.  
316 -  
317 ----  
318 -  
319 -# PP5GalleryTransform  
320 -  
321 -DOCUMENT ME  
322 -  
323 -  
324 -* **file:** classification/pp5.cpp  
325 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
326 -* **author(s):** [Unknown][unknown]  
327 -* **properties:** None  
328 -  
329 -  
330 ----  
331 -  
332 -# RowWisePCATransform  
333 -  
334 -PCA on each row.  
335 -  
336 -  
337 -* **file:** classification/lda.cpp  
338 -* **inherits:** [PCATransform](#pcatransform)  
339 -* **author(s):** [Josh Klontz][jklontz]  
340 -* **properties:** None  
341 -  
342 -  
343 ----  
344 -  
345 -# SVMTransform  
346 -  
347 -Wraps OpenCV's SVM framework.  
348 -  
349 -  
350 -* **file:** classification/svm.cpp  
351 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
352 -* **author(s):** [Josh Klontz][jklontz]  
353 -* **see:** [http://docs.opencv.org/modules/ml/doc/support_vector_machines.html](http://docs.opencv.org/modules/ml/doc/support_vector_machines.html)  
354 -* **read:**  
355 -  
356 - 1. *C. Burges.*  
357 - **"A tutorial on support vector machines for pattern recognition"**  
358 - Knowledge Discovery and Data Mining 2(2), 1998.  
359 -  
360 -* **properties:**  
361 -  
362 - Property | Type | Description  
363 - --- | --- | ---  
364 - Kernel | enum | The type of SVM kernel to use. Options are Linear, Poly, RBF, Sigmoid. Default is Linear.  
365 - Type | enum | The type of SVM to do. Options are C_SVC, NU_SVC, ONE_CLASS, EPS_SVR, NU_SVR. Default is C_SVC.  
366 - C | float | Parameter C of an SVM optimization problem. Needed when Type is C_SVC, EPS_SVR or NU_SVR. Default is -1.  
367 - gamma | float | Parameter gamma of a kernel function. Needed when Kernel is Poly, RBF, or Sigmoid. Default is -1.  
368 - inputVariable | QString | Metadata variable storing the label for each template. Default is "Label".  
369 - 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 "".  
370 - returnDFVal | bool | If true, dst is set to a 1x1 Mat with value equal to the predicted output of the SVM. Default is false.  
371 - termCriteria | int | The maximum number of training iterations. Default is 1000.  
372 - folds | int | Cross validation parameter used for autoselecting other parameters. Default is 5.  
373 - balanceFolds | bool | If true and the problem is 2-class classification then more balanced cross validation subsets are created. Default is false.  
374 -  
375 ----  
376 -  
377 -# SparseLDATransform  
378 -  
379 -Projects input into learned Linear Discriminant Analysis subspace learned on a sparse subset of features with the highest weight in the original LDA algorithm.  
380 -  
381 -  
382 -* **file:** classification/lda.cpp  
383 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
384 -* **author(s):** [Brendan Klare][bklare]  
385 -* **properties:**  
386 -  
387 - Property | Type | Description  
388 - --- | --- | ---  
389 - varThreshold | float | BRENDAN FILL ME IN. Default is 1.5.  
390 - pcaKeep | float | BRENDAN FILL ME IN. Default is 0.98.  
391 - normalize | bool | BRENDAN FILL ME IN. Default is true.  
392 -  
393 ----  
394 -  
395 -# TurkClassifierTransform  
396 -  
397 -Convenience class for training turk attribute regressors  
398 -  
399 -  
400 -* **file:** classification/turk.cpp  
401 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
402 -* **author(s):** [Josh Klontz][jklontz]  
403 -* **properties:**  
404 -  
405 - Property | Type | Description  
406 - --- | --- | ---  
407 - 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 "".  
408 - 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 "".  
409 - isMeta | bool | If true, "Average+SaveMat(predicted_key_value)" is appended to each classifier. If false, nothing is appended. Default is false.  
410 -  
411 ----  
412 -  
docs/docs/api_docs/plugins/cluster.md deleted
1 -# CollectNNTransform  
2 -  
3 -Collect nearest neighbors and append them to metadata.  
4 -  
5 -  
6 -* **file:** cluster/collectnn.cpp  
7 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
8 -* **author(s):** [Charles Otto][caotto]  
9 -* **properties:**  
10 -  
11 - Property | Type | Description  
12 - --- | --- | ---  
13 - keep | int | The maximum number of nearest neighbors to keep. Default is 20.  
14 -  
15 ----  
16 -  
17 -# KMeansTransform  
18 -  
19 -Wraps OpenCV kmeans and flann.  
20 -  
21 -  
22 -* **file:** cluster/kmeans.cpp  
23 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
24 -* **author(s):** [Josh Klontz][jklontz]  
25 -* **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)  
26 -* **properties:**  
27 -  
28 - Property | Type | Description  
29 - --- | --- | ---  
30 - kTrain | int | The number of random centroids to make at train time. Default is 256.  
31 - kSearch | int | The number of nearest neighbors to search for at runtime. Default is 1.  
32 -  
33 ----  
34 -  
35 -# KNNTransform  
36 -  
37 -K nearest neighbors classifier.  
38 -  
39 -  
40 -* **file:** cluster/knn.cpp  
41 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
42 -* **author(s):** [Josh Klontz][jklontz]  
43 -* **properties:** None  
44 -  
45 -  
46 ----  
47 -  
48 -# LogNNTransform  
49 -  
50 -Log nearest neighbors to specified file.  
51 -  
52 -  
53 -* **file:** cluster/lognn.cpp  
54 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
55 -* **author(s):** [Charles Otto][caotto]  
56 -* **properties:**  
57 -  
58 - Property | Type | Description  
59 - --- | --- | ---  
60 - fileName | QString | The name of the log file. An empty fileName won't be written to. Default is "".  
61 -  
62 ----  
63 -  
64 -# RandomCentroidsTransform  
65 -  
66 -Chooses k random points to be centroids.  
67 -  
68 -  
69 -* **file:** cluster/randomcentroids.cpp  
70 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
71 -* **author(s):** [Austin Blanton][imaus10]  
72 -* **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)  
73 -* **properties:**  
74 -  
75 - Property | Type | Description  
76 - --- | --- | ---  
77 - kTrain | int | The number of random centroids to make at train time. Default is 256.  
78 - kSearch | int | The number of nearest neighbors to search for at runtime. Default is 1.  
79 -  
80 ----  
81 -  
docs/docs/api_docs/plugins/core.md deleted
1 -# CacheTransform  
2 -  
3 -Caches [Transform](../cpp_api/transform/transform.md)::project() results.  
4 -  
5 -  
6 -* **file:** core/cache.cpp  
7 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
8 -* **author(s):** [Josh Klontz][jklontz]  
9 -* **properties:** None  
10 -  
11 -  
12 ----  
13 -  
14 -# CollectOutputTransform  
15 -  
16 -DOCUMENT ME CHARLES  
17 -  
18 -  
19 -* **file:** core/stream.cpp  
20 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
21 -* **author(s):** [Charles Otto][caotto]  
22 -* **properties:** None  
23 -  
24 -  
25 ----  
26 -  
27 -# ContractTransform  
28 -  
29 -It's like the opposite of ExpandTransform, but not really  
30 -  
31 -Given a [TemplateList](../cpp_api/templatelist/templatelist.md) as input, concatenate them into a single [Template](../cpp_api/template/template.md)  
32 -  
33 -  
34 -* **file:** core/contract.cpp  
35 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
36 -* **author(s):** [Charles Otto][caotto]  
37 -* **properties:** None  
38 -  
39 -  
40 ----  
41 -  
42 -# CrossValidateTransform  
43 -  
44 -Cross validate a trainable [Transform](../cpp_api/transform/transform.md).  
45 -  
46 -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  
47 -against for all testing partitions.  
48 -  
49 -  
50 -* **file:** core/crossvalidate.cpp  
51 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
52 -* **author(s):** [Josh Klontz][jklontz], [Scott Klum][sklum]  
53 -* **properties:** None  
54 -  
55 -  
56 ----  
57 -  
58 -# DirectStreamTransform  
59 -  
60 -DOCUMENT ME CHARLES  
61 -  
62 -  
63 -* **file:** core/stream.cpp  
64 -* **inherits:** [CompositeTransform](../cpp_api/compositetransform/compositetransform.md)  
65 -* **author(s):** [Charles Otto][caotto]  
66 -* **properties:** None  
67 -  
68 -  
69 ----  
70 -  
71 -# DiscardTemplatesTransform  
72 -  
73 -DOCUMENT ME  
74 -  
75 -  
76 -* **file:** core/discardtemplates.cpp  
77 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
78 -* **author(s):** [Unknown][unknown]  
79 -* **properties:** None  
80 -  
81 -  
82 ----  
83 -  
84 -# DiscardTransform  
85 -  
86 -Removes all matrices from a [Template](../cpp_api/template/template.md).  
87 -  
88 -  
89 -* **file:** core/discard.cpp  
90 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
91 -* **author(s):** [Josh Klontz][jklontz]  
92 -* **properties:** None  
93 -  
94 -  
95 ----  
96 -  
97 -# DistributeTemplateTransform  
98 -  
99 -DOCUMENT ME  
100 -  
101 -  
102 -* **file:** core/distributetemplate.cpp  
103 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
104 -* **author(s):** [Unknown][unknown]  
105 -* **properties:** None  
106 -  
107 -  
108 ----  
109 -  
110 -# DownsampleTrainingTransform  
111 -  
112 -DOCUMENT ME JOSH  
113 -  
114 -  
115 -* **file:** core/downsampletraining.cpp  
116 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
117 -* **author(s):** [Josh Klontz][jklontz]  
118 -* **properties:** None  
119 -  
120 -  
121 ----  
122 -  
123 -# EventTransform  
124 -  
125 -DOCUMENT ME  
126 -  
127 -  
128 -* **file:** core/event.cpp  
129 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
130 -* **author(s):** [Unknown][unknown]  
131 -* **properties:** None  
132 -  
133 -  
134 ----  
135 -  
136 -# ExpandTransform  
137 -  
138 -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).  
139 -  
140 -  
141 -* **file:** core/expand.cpp  
142 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
143 -* **author(s):** [Josh Klontz][jklontz]  
144 -* **properties:** None  
145 -  
146 -  
147 ----  
148 -  
149 -# FTETransform  
150 -  
151 -Flags images that failed to enroll based on the specified [Transform](../cpp_api/transform/transform.md).  
152 -  
153 -  
154 -* **file:** core/fte.cpp  
155 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
156 -* **author(s):** [Josh Klontz][jklontz]  
157 -* **properties:** None  
158 -  
159 -  
160 ----  
161 -  
162 -# FirstTransform  
163 -  
164 -Removes all but the first matrix from the [Template](../cpp_api/template/template.md).  
165 -  
166 -  
167 -* **file:** core/first.cpp  
168 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
169 -* **author(s):** [Josh Klontz][jklontz]  
170 -* **properties:** None  
171 -  
172 -  
173 ----  
174 -  
175 -# ForkTransform  
176 -  
177 -Transforms in parallel.  
178 -  
179 -The source [Template](../cpp_api/template/template.md) is seperately given to each transform and the results are appended together.  
180 -  
181 -  
182 -* **file:** core/fork.cpp  
183 -* **inherits:** [CompositeTransform](../cpp_api/compositetransform/compositetransform.md)  
184 -* **author(s):** [Josh Klontz][jklontz]  
185 -* **properties:** None  
186 -  
187 -  
188 ----  
189 -  
190 -# GalleryCompareTransform  
191 -  
192 -Compare each [Template](../cpp_api/template/template.md) to a fixed [Gallery](../cpp_api/gallery/gallery.md) (with name = galleryName), using the specified distance.  
193 -dst will contain a 1 by n vector of scores.  
194 -  
195 -  
196 -* **file:** core/gallerycompare.cpp  
197 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
198 -* **author(s):** [Charles Otto][caotto]  
199 -* **properties:** None  
200 -  
201 -  
202 ----  
203 -  
204 -# IdentityTransform  
205 -  
206 -A no-op [Transform](../cpp_api/transform/transform.md).  
207 -  
208 -  
209 -* **file:** core/identity.cpp  
210 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
211 -* **author(s):** [Josh Klontz][jklontz]  
212 -* **properties:** None  
213 -  
214 -  
215 ----  
216 -  
217 -# IndependentTransform  
218 -  
219 -Clones the [Transform](../cpp_api/transform/transform.md) so that it can be applied independently.  
220 -  
221 -Independent [Transform](../cpp_api/transform/transform.md)s expect single-matrix [Template](../cpp_api/template/template.md).  
222 -  
223 -  
224 -* **file:** core/independent.cpp  
225 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
226 -* **author(s):** [Josh Klontz][jklontz]  
227 -* **properties:** None  
228 -  
229 -  
230 ----  
231 -  
232 -# JNITransform  
233 -  
234 -Execute Java code from OpenBR using the JNI  
235 -  
236 -  
237 -* **file:** core/jni.cpp  
238 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
239 -* **author(s):** [Jordan Cheney][jcheney]  
240 -* **properties:** None  
241 -  
242 -  
243 ----  
244 -  
245 -# LikelyTransform  
246 -  
247 -Generic interface to Likely JIT compiler  
248 -  
249 -  
250 -* **file:** core/likely.cpp  
251 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
252 -* **author(s):** [Josh Klontz][jklontz]  
253 -* **see:** [www.liblikely.org](www.liblikely.org)  
254 -* **properties:** None  
255 -  
256 -  
257 ----  
258 -  
259 -# LoadStoreTransform  
260 -  
261 -Caches [Transform](../cpp_api/transform/transform.md) training.  
262 -  
263 -  
264 -* **file:** core/loadstore.cpp  
265 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
266 -* **author(s):** [Josh Klontz][jklontz]  
267 -* **properties:** None  
268 -  
269 -  
270 ----  
271 -  
272 -# PipeTransform  
273 -  
274 -Transforms in series.  
275 -  
276 -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.  
277 -  
278 -  
279 -* **file:** core/pipe.cpp  
280 -* **inherits:** [CompositeTransform](../cpp_api/compositetransform/compositetransform.md)  
281 -* **author(s):** [Josh Klontz][jklontz]  
282 -* **properties:** None  
283 -  
284 -  
285 ----  
286 -  
287 -# ProcessWrapperTransform  
288 -  
289 -Interface to a separate process  
290 -  
291 -  
292 -* **file:** core/processwrapper.cpp  
293 -* **inherits:** [WrapperTransform](../cpp_api/wrappertransform/wrappertransform.md)  
294 -* **author(s):** [Charles Otto][caotto]  
295 -* **properties:** None  
296 -  
297 -  
298 ----  
299 -  
300 -# ProcrustesAlignTransform  
301 -  
302 -Improved procrustes alignment of points, to include a post processing scaling of points  
303 -to faciliate subsequent texture mapping.  
304 -  
305 -  
306 -* **file:** core/align.cpp  
307 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
308 -* **author(s):** [Brendan Klare][bklare]  
309 -* **properties:**  
310 -  
311 - Property | Type | Description  
312 - --- | --- | ---  
313 - width | float | Width of output coordinate space (before padding)  
314 - padding | float | Amount of padding around the coordinate space  
315 - useFirst | bool | Whether or not to use the first instance as the reference object  
316 -  
317 ----  
318 -  
319 -# ProgressCounterTransform  
320 -  
321 -DOCUMENT ME  
322 -  
323 -  
324 -* **file:** core/progresscounter.cpp  
325 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
326 -* **author(s):** [Unknown][unknown]  
327 -* **properties:** None  
328 -  
329 -  
330 ----  
331 -  
332 -# RemoveTransform  
333 -  
334 -Removes the matrix from the [Template](../cpp_api/template/template.md) at the specified index.  
335 -  
336 -  
337 -* **file:** core/remove.cpp  
338 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
339 -* **author(s):** [Josh Klontz][jklontz]  
340 -* **properties:** None  
341 -  
342 -  
343 ----  
344 -  
345 -# RestTransform  
346 -  
347 -Removes the first matrix from the [Template](../cpp_api/template/template.md).  
348 -  
349 -  
350 -* **file:** core/rest.cpp  
351 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
352 -* **author(s):** [Josh Klontz][jklontz]  
353 -* **properties:** None  
354 -  
355 -  
356 ----  
357 -  
358 -# SchrodingerTransform  
359 -  
360 -Generates two [Template](../cpp_api/template/template.md), one of which is passed through a [Transform](../cpp_api/transform/transform.md) and the other  
361 -is not. No cats were harmed in the making of this [Transform](../cpp_api/transform/transform.md).  
362 -  
363 -  
364 -* **file:** core/schrodinger.cpp  
365 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
366 -* **author(s):** [Scott Klum][sklum]  
367 -* **properties:** None  
368 -  
369 -  
370 ----  
371 -  
372 -# SingletonTransform  
373 -  
374 -A globally shared [Transform](../cpp_api/transform/transform.md).  
375 -  
376 -  
377 -* **file:** core/singleton.cpp  
378 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
379 -* **author(s):** [Josh Klontz][jklontz]  
380 -* **properties:** None  
381 -  
382 -  
383 ----  
384 -  
385 -# StreamTransform  
386 -  
387 -DOCUMENT ME CHARLES  
388 -  
389 -  
390 -* **file:** core/stream.cpp  
391 -* **inherits:** [WrapperTransform](../cpp_api/wrappertransform/wrappertransform.md)  
392 -* **author(s):** [Charles Otto][caotto]  
393 -* **properties:** None  
394 -  
395 -  
396 ----  
397 -  
398 -# SynthesizePointsTransform  
399 -  
400 -Synthesize additional points via triangulation.  
401 -  
402 -  
403 -* **file:** core/align.cpp  
404 -* **inherits:** [MetadataTransform](../cpp_api/metadatatransform/metadatatransform.md)  
405 -* **author(s):** [Josh Klontz][jklontz]  
406 -* **properties:** None  
407 -  
408 -  
409 ----  
410 -  
411 -# TextureMapTransform  
412 -  
413 -Maps texture from one set of points to another. Assumes that points are rigidly transformed  
414 -  
415 -  
416 -* **file:** core/align.cpp  
417 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
418 -* **author(s):** [Brendan Klare][bklare], [Scott Klum][sklum]  
419 -* **properties:** None  
420 -  
421 -  
422 ----  
423 -  
docs/docs/api_docs/plugins/distance.md deleted
1 -# AttributeDistance  
2 -  
3 -Attenuation function based distance from attributes  
4 -  
5 -  
6 -* **file:** distance/attribute.cpp  
7 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
8 -* **author(s):** [Scott Klum][sklum]  
9 -* **properties:** None  
10 -  
11 -  
12 ----  
13 -  
14 -# BayesianQuantizationDistance  
15 -  
16 -Bayesian quantization [Distance](../cpp_api/distance/distance.md)  
17 -  
18 -  
19 -* **file:** distance/bayesianquantization.cpp  
20 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
21 -* **author(s):** [Josh Klontz][jklontz]  
22 -* **properties:** None  
23 -  
24 -  
25 ----  
26 -  
27 -# ByteL1Distance  
28 -  
29 -Fast 8-bit L1 distance  
30 -  
31 -  
32 -* **file:** distance/byteL1.cpp  
33 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
34 -* **author(s):** [Josh Klontz][jklontz]  
35 -* **properties:** None  
36 -  
37 -  
38 ----  
39 -  
40 -# CrossValidateDistance  
41 -  
42 -Cross validate a [Distance](../cpp_api/distance/distance.md) metric.  
43 -  
44 -  
45 -* **file:** distance/crossvalidate.cpp  
46 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
47 -* **author(s):** [Josh Klontz][jklontz]  
48 -* **properties:** None  
49 -  
50 -  
51 ----  
52 -  
53 -# DefaultDistance  
54 -  
55 -DistDistance wrapper.  
56 -  
57 -  
58 -* **file:** distance/default.cpp  
59 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
60 -* **author(s):** [Josh Klontz][jklontz]  
61 -* **properties:** None  
62 -  
63 -  
64 ----  
65 -  
66 -# DistDistance  
67 -  
68 -Standard [Distance](../cpp_api/distance/distance.md) metrics  
69 -  
70 -  
71 -* **file:** distance/dist.cpp  
72 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
73 -* **author(s):** [Josh Klontz][jklontz]  
74 -* **properties:** None  
75 -  
76 -  
77 ----  
78 -  
79 -# FilterDistance  
80 -  
81 -Checks target metadata against filters.  
82 -  
83 -  
84 -* **file:** distance/filter.cpp  
85 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
86 -* **author(s):** [Josh Klontz][jklontz]  
87 -* **properties:** None  
88 -  
89 -  
90 ----  
91 -  
92 -# FuseDistance  
93 -  
94 -Fuses similarity scores across multiple matrices of compared [Template](../cpp_api/template/template.md)  
95 -  
96 -  
97 -* **file:** distance/fuse.cpp  
98 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
99 -* **author(s):** [Scott Klum][sklum]  
100 -* **properties:**  
101 -  
102 - Property | Type | Description  
103 - --- | --- | ---  
104 - Operation | enum | Possible values are:<ul><li>Mean</li><li>sum</li><li>min</li><li>max</li></ul>.  
105 -  
106 ----  
107 -  
108 -# HalfByteL1Distance  
109 -  
110 -Fast 4-bit L1 distance  
111 -  
112 -  
113 -* **file:** distance/halfbyteL1.cpp  
114 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
115 -* **author(s):** [Josh Klontz][jklontz]  
116 -* **properties:** None  
117 -  
118 -  
119 ----  
120 -  
121 -# HeatMapDistance  
122 -  
123 -1v1 heat map comparison  
124 -  
125 -  
126 -* **file:** distance/heatmap.cpp  
127 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
128 -* **author(s):** [Scott Klum][sklum]  
129 -* **properties:** None  
130 -  
131 -  
132 ----  
133 -  
134 -# IdenticalDistance  
135 -  
136 -Returns true if the [Template](../cpp_api/template/template.md) are identical, false otherwise.  
137 -  
138 -  
139 -* **file:** distance/identical.cpp  
140 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
141 -* **author(s):** [Josh Klontz][jklontz]  
142 -* **properties:** None  
143 -  
144 -  
145 ----  
146 -  
147 -# KeyPointMatcherDistance  
148 -  
149 -Wraps OpenCV Key Point Matcher  
150 -  
151 -  
152 -* **file:** distance/keypointmatcher.cpp  
153 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
154 -* **author(s):** [Josh Klontz][jklontz]  
155 -* **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)  
156 -* **properties:** None  
157 -  
158 -  
159 ----  
160 -  
161 -# L1Distance  
162 -  
163 -L1 distance computed using eigen.  
164 -  
165 -  
166 -* **file:** distance/L1.cpp  
167 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
168 -* **author(s):** [Josh Klontz][jklontz]  
169 -* **properties:** None  
170 -  
171 -  
172 ----  
173 -  
174 -# L2Distance  
175 -  
176 -L2 distance computed using eigen.  
177 -  
178 -  
179 -* **file:** distance/L2.cpp  
180 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
181 -* **author(s):** [Josh Klontz][jklontz]  
182 -* **properties:** None  
183 -  
184 -  
185 ----  
186 -  
187 -# MatchProbabilityDistance  
188 -  
189 -Match Probability  
190 -  
191 -  
192 -* **file:** distance/matchprobability.cpp  
193 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
194 -* **author(s):** [Josh Klontz][jklontz]  
195 -* **properties:** None  
196 -  
197 -  
198 ----  
199 -  
200 -# MetadataDistance  
201 -  
202 -Checks target metadata against query metadata.  
203 -  
204 -  
205 -* **file:** distance/metadata.cpp  
206 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
207 -* **author(s):** [Scott Klum][sklum]  
208 -* **properties:** None  
209 -  
210 -  
211 ----  
212 -  
213 -# NegativeLogPlusOneDistance  
214 -  
215 -Returns -log(distance(a,b)+1)  
216 -  
217 -  
218 -* **file:** distance/neglogplusone.cpp  
219 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
220 -* **author(s):** [Josh Klontz][jklontz]  
221 -* **properties:** None  
222 -  
223 -  
224 ----  
225 -  
226 -# OnlineDistance  
227 -  
228 -Online [Distance](../cpp_api/distance/distance.md) metric to attenuate match scores across multiple frames  
229 -  
230 -  
231 -* **file:** distance/online.cpp  
232 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
233 -* **author(s):** [Brendan klare][bklare]  
234 -* **properties:** None  
235 -  
236 -  
237 ----  
238 -  
239 -# PipeDistance  
240 -  
241 -Distances in series.  
242 -  
243 -The [Template](../cpp_api/template/template.md) are compared using each [Distance](../cpp_api/distance/distance.md) in order.  
244 -If the result of the comparison with any given distance is -FLOAT_MAX then this result is returned early.  
245 -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).  
246 -  
247 -  
248 -* **file:** distance/pipe.cpp  
249 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
250 -* **author(s):** [Josh Klontz][jklontz]  
251 -* **properties:** None  
252 -  
253 -  
254 ----  
255 -  
256 -# RejectDistance  
257 -  
258 -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.  
259 -  
260 -  
261 -* **file:** distance/reject.cpp  
262 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
263 -* **author(s):** [Scott Klum][sklum]  
264 -* **properties:** None  
265 -  
266 -  
267 ----  
268 -  
269 -# SVMDistance  
270 -  
271 -SVM Regression on [Template](../cpp_api/template/template.md) absolute differences.  
272 -  
273 -  
274 -* **file:** distance/svm.cpp  
275 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
276 -* **author(s):** [Josh Klontz][jklontz]  
277 -* **properties:** None  
278 -  
279 -  
280 ----  
281 -  
282 -# SumDistance  
283 -  
284 -Sum match scores across multiple [Distance](../cpp_api/distance/distance.md)  
285 -  
286 -  
287 -* **file:** distance/sum.cpp  
288 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
289 -* **author(s):** [Scott Klum][sklum]  
290 -* **properties:** None  
291 -  
292 -  
293 ----  
294 -  
295 -# TurkDistance  
296 -  
297 -Unmaps Turk HITs to be compared against query mats  
298 -  
299 -  
300 -* **file:** distance/turk.cpp  
301 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
302 -* **author(s):** [Scott Klum][sklum]  
303 -* **properties:** None  
304 -  
305 -  
306 ----  
307 -  
308 -# UnitDistance  
309 -  
310 -Linear normalizes of a [Distance](../cpp_api/distance/distance.md) so the mean impostor score is 0 and the mean genuine score is 1.  
311 -  
312 -  
313 -* **file:** distance/unit.cpp  
314 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
315 -* **author(s):** [Josh Klontz][jklontz]  
316 -* **properties:** None  
317 -  
318 -  
319 ----  
320 -  
321 -# ZScoreDistance  
322 -  
323 -DOCUMENT ME  
324 -  
325 -  
326 -* **file:** distance/zscore.cpp  
327 -* **inherits:** [Distance](../cpp_api/distance/distance.md)  
328 -* **author(s):** [Unknown][unknown]  
329 -* **properties:** None  
330 -  
331 -  
332 ----  
333 -  
docs/docs/api_docs/plugins/format.md deleted
1 -# DefaultFormat  
2 -  
3 -Reads image files.  
4 -  
5 -  
6 -* **file:** format/video.cpp  
7 -* **inherits:** [Format](../cpp_api/format/format.md)  
8 -* **author(s):** [Josh Klontz][jklontz]  
9 -* **properties:** None  
10 -  
11 -  
12 ----  
13 -  
14 -# binaryFormat  
15 -  
16 -A simple binary matrix format.  
17 -  
18 -  
19 -* **file:** format/binary.cpp  
20 -* **inherits:** [Format](../cpp_api/format/format.md)  
21 -* **author(s):** [Josh Klontz][jklontz]  
22 -* **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.  
23 -* **properties:** None  
24 -  
25 -  
26 ----  
27 -  
28 -# csvFormat  
29 -  
30 -Reads a comma separated value file.  
31 -  
32 -  
33 -* **file:** format/csv.cpp  
34 -* **inherits:** [Format](../cpp_api/format/format.md)  
35 -* **author(s):** [Josh Klontz][jklontz]  
36 -* **properties:** None  
37 -  
38 -  
39 ----  
40 -  
41 -# ebtsFormat  
42 -  
43 -Reads FBI EBTS transactions.  
44 -  
45 -  
46 -* **file:** format/ebts.cpp  
47 -* **inherits:** [Format](../cpp_api/format/format.md)  
48 -* **author(s):** [Scott Klum][sklum]  
49 -* **see:** [https://www.fbibiospecs.org/ebts.html](https://www.fbibiospecs.org/ebts.html)  
50 -* **properties:** None  
51 -  
52 -  
53 ----  
54 -  
55 -# lffsFormat  
56 -  
57 -Reads a NIST LFFS file.  
58 -  
59 -  
60 -* **file:** format/lffs.cpp  
61 -* **inherits:** [Format](../cpp_api/format/format.md)  
62 -* **author(s):** [Josh Klontz][jklontz]  
63 -* **properties:** None  
64 -  
65 -  
66 ----  
67 -  
68 -# lmatFormat  
69 -  
70 -Likely matrix format  
71 -  
72 -  
73 -* **file:** format/lmat.cpp  
74 -* **inherits:** [Format](../cpp_api/format/format.md)  
75 -* **author(s):** [Josh Klontz][jklontz]  
76 -* **see:** [www.liblikely.org](www.liblikely.org)  
77 -* **properties:** None  
78 -  
79 -  
80 ----  
81 -  
82 -# maskFormat  
83 -  
84 -Reads a NIST BEE mask matrix.  
85 -  
86 -  
87 -* **file:** format/mtx.cpp  
88 -* **inherits:** [mtxFormat](#mtxformat)  
89 -* **author(s):** [Josh Klontz][jklontz]  
90 -* **properties:** None  
91 -  
92 -  
93 ----  
94 -  
95 -# matFormat  
96 -  
97 -MATLAB <tt>.mat</tt> format.  
98 -  
99 -matFormat is known not to work with compressed matrices  
100 -  
101 -  
102 -* **file:** format/mat.cpp  
103 -* **inherits:** [Format](../cpp_api/format/format.md)  
104 -* **author(s):** [Josh Klontz][jklontz]  
105 -* **see:** [http://www.mathworks.com/help/pdf_doc/matlab/matfile_format.pdf](http://www.mathworks.com/help/pdf_doc/matlab/matfile_format.pdf)  
106 -* **properties:** None  
107 -  
108 -  
109 ----  
110 -  
111 -# mtxFormat  
112 -  
113 -Reads a NIST BEE similarity matrix.  
114 -  
115 -  
116 -* **file:** format/mtx.cpp  
117 -* **inherits:** [Format](../cpp_api/format/format.md)  
118 -* **author(s):** [Josh Klontz][jklontz]  
119 -* **properties:** None  
120 -  
121 -  
122 ----  
123 -  
124 -# nullFormat  
125 -  
126 -Returns an empty matrix.  
127 -  
128 -  
129 -* **file:** format/null.cpp  
130 -* **inherits:** [Format](../cpp_api/format/format.md)  
131 -* **author(s):** [Josh Klontz][jklontz]  
132 -* **properties:** None  
133 -  
134 -  
135 ----  
136 -  
137 -# postFormat  
138 -  
139 -Handle POST requests  
140 -  
141 -  
142 -* **file:** format/post.cpp  
143 -* **inherits:** [Format](../cpp_api/format/format.md)  
144 -* **author(s):** [Josh Klontz][jklontz]  
145 -* **properties:** None  
146 -  
147 -  
148 ----  
149 -  
150 -# rawFormat  
151 -  
152 -RAW format  
153 -  
154 -  
155 -* **file:** format/raw.cpp  
156 -* **inherits:** [Format](../cpp_api/format/format.md)  
157 -* **author(s):** [Josh Klontz][jklontz]  
158 -* **see:** [http://www.nist.gov/srd/nistsd27.cfm](http://www.nist.gov/srd/nistsd27.cfm)  
159 -* **properties:** None  
160 -  
161 -  
162 ----  
163 -  
164 -# scoresFormat  
165 -  
166 -Reads in scores or ground truth from a text table.  
167 -  
168 -  
169 -* **file:** format/scores.cpp  
170 -* **inherits:** [Format](../cpp_api/format/format.md)  
171 -* **author(s):** [Josh Klontz][jklontz]  
172 -* **format:** Example of the format: <pre><code>2.2531514 FALSE 99990377 99990164  
173 -2.2549822 TRUE 99990101 99990101  
174 -</code></pre>  
175 -* **properties:** None  
176 -  
177 -  
178 ----  
179 -  
180 -# urlFormat  
181 -  
182 -Reads image files from the web.  
183 -  
184 -  
185 -* **file:** format/url.cpp  
186 -* **inherits:** [Format](../cpp_api/format/format.md)  
187 -* **author(s):** [Josh Klontz][jklontz]  
188 -* **properties:** None  
189 -  
190 -  
191 ----  
192 -  
193 -# videoFormat  
194 -  
195 -Read all frames of a video using OpenCV  
196 -  
197 -  
198 -* **file:** format/video.cpp  
199 -* **inherits:** [Format](../cpp_api/format/format.md)  
200 -* **author(s):** [Charles Otto][caotto]  
201 -* **properties:** None  
202 -  
203 -  
204 ----  
205 -  
206 -# webcamFormat  
207 -  
208 -Retrieves an image from a webcam.  
209 -  
210 -  
211 -* **file:** format/video.cpp  
212 -* **inherits:** [Format](../cpp_api/format/format.md)  
213 -* **author(s):** [Josh Klontz][jklontz]  
214 -* **properties:** None  
215 -  
216 -  
217 ----  
218 -  
219 -# xmlFormat  
220 -  
221 -Decodes images from Base64 xml  
222 -  
223 -  
224 -* **file:** format/xml.cpp  
225 -* **inherits:** [Format](../cpp_api/format/format.md)  
226 -* **author(s):** [Scott Klum][sklum], [Josh Klontz][jklontz]  
227 -* **properties:** None  
228 -  
229 -  
230 ----  
231 -  
docs/docs/api_docs/plugins/gallery.md deleted
1 -# BinaryGallery  
2 -  
3 -An abstract gallery for handling binary data  
4 -  
5 -  
6 -* **file:** gallery/binary.cpp  
7 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
8 -* **author(s):** [Josh Klontz][jklontz]  
9 -* **properties:** None  
10 -  
11 -  
12 ----  
13 -  
14 -# DefaultGallery  
15 -  
16 -Treats the gallery as a [Format](../cpp_api/format/format.md).  
17 -  
18 -  
19 -* **file:** gallery/default.cpp  
20 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
21 -* **author(s):** [Josh Klontz][jklontz]  
22 -* **properties:** None  
23 -  
24 -  
25 ----  
26 -  
27 -# EmptyGallery  
28 -  
29 -Reads/writes templates to/from folders.  
30 -  
31 -  
32 -* **file:** gallery/empty.cpp  
33 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
34 -* **author(s):** [Josh Klontz][jklontz]  
35 -* **properties:**  
36 -  
37 - Property | Type | Description  
38 - --- | --- | ---  
39 - regexp | QString | An optional regular expression to match against the files extension.  
40 -  
41 ----  
42 -  
43 -# FDDBGallery  
44 -  
45 -Implements the FDDB detection format.  
46 -  
47 -  
48 -* **file:** gallery/fddb.cpp  
49 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
50 -* **author(s):** [Josh Klontz][jklontz]  
51 -* **see:** [http://vis-www.cs.umass.edu/fddb/README.txt](http://vis-www.cs.umass.edu/fddb/README.txt)  
52 -* **properties:** None  
53 -  
54 -  
55 ----  
56 -  
57 -# arffGallery  
58 -  
59 -Weka ARFF file format.  
60 -  
61 -  
62 -* **file:** gallery/arff.cpp  
63 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
64 -* **author(s):** [Josh Klontz][jklontz]  
65 -* **see:** [http://weka.wikispaces.com/ARFF+%28stable+version%29](http://weka.wikispaces.com/ARFF+%28stable+version%29)  
66 -* **properties:** None  
67 -  
68 -  
69 ----  
70 -  
71 -# aviGallery  
72 -  
73 -Read videos of format .avi  
74 -  
75 -  
76 -* **file:** gallery/video.cpp  
77 -* **inherits:** [videoGallery](#videogallery)  
78 -* **author(s):** [Unknown][unknown]  
79 -* **properties:** None  
80 -  
81 -  
82 ----  
83 -  
84 -# crawlGallery  
85 -  
86 -Crawl a root location for image files.  
87 -  
88 -  
89 -* **file:** gallery/crawl.cpp  
90 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
91 -* **author(s):** [Josh Klontz][jklontz]  
92 -* **properties:** None  
93 -  
94 -  
95 ----  
96 -  
97 -# csvGallery  
98 -  
99 -Treats each line as a file.  
100 -  
101 -  
102 -* **file:** gallery/csv.cpp  
103 -* **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)  
104 -* **author(s):** [Josh Klontz][jklontz]  
105 -* **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.  
106 -* **properties:** None  
107 -  
108 -  
109 ----  
110 -  
111 -# dbGallery  
112 -  
113 -Database input.  
114 -  
115 -  
116 -* **file:** gallery/db.cpp  
117 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
118 -* **author(s):** [Josh Klontz][jklontz]  
119 -* **properties:** None  
120 -  
121 -  
122 ----  
123 -  
124 -# flatGallery  
125 -  
126 -Treats each line as a call to [File](../cpp_api/file/file.md)::flat()  
127 -  
128 -  
129 -* **file:** gallery/flat.cpp  
130 -* **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)  
131 -* **author(s):** [Josh Klontz][jklontz]  
132 -* **properties:** None  
133 -  
134 -  
135 ----  
136 -  
137 -# galGallery  
138 -  
139 -A binary gallery.  
140 -  
141 -Designed to be a literal translation of templates to disk.  
142 -Compatible with [TemplateList](../cpp_api/templatelist/templatelist.md)::fromBuffer.  
143 -  
144 -  
145 -* **file:** gallery/binary.cpp  
146 -* **inherits:** [BinaryGallery](#binarygallery)  
147 -* **author(s):** [Josh Klontz][jklontz]  
148 -* **properties:** None  
149 -  
150 -  
151 ----  
152 -  
153 -# googleGallery  
154 -  
155 -Input from a google image search.  
156 -  
157 -  
158 -* **file:** gallery/google.cpp  
159 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
160 -* **author(s):** [Josh Klontz][jklontz]  
161 -* **properties:** None  
162 -  
163 -  
164 ----  
165 -  
166 -# jsonGallery  
167 -  
168 -Newline-separated JSON objects.  
169 -  
170 -  
171 -* **file:** gallery/binary.cpp  
172 -* **inherits:** [BinaryGallery](#binarygallery)  
173 -* **author(s):** [Josh Klontz][jklontz]  
174 -* **properties:** None  
175 -  
176 -  
177 ----  
178 -  
179 -# keyframesGallery  
180 -  
181 -Read key frames of a video with LibAV  
182 -  
183 -  
184 -* **file:** gallery/keyframes.cpp  
185 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
186 -* **author(s):** [Ben Klein][bhklein]  
187 -* **properties:** None  
188 -  
189 -  
190 ----  
191 -  
192 -# landmarksGallery  
193 -  
194 -Text format for associating anonymous landmarks with images.  
195 -  
196 -  
197 -* **file:** gallery/landmarks.cpp  
198 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
199 -* **author(s):** [Josh Klontz][jklontz]  
200 -* **format:** The input should be formatted as follows: <pre><code>file_name:x1,y1,x2,y2,...,xn,yn  
201 -file_name:x1,y1,x2,y2,...,xn,yn  
202 -...  
203 -file_name:x1,y1,x2,y2,...,xn,yn  
204 -</code></pre>  
205 -* **properties:** None  
206 -  
207 -  
208 ----  
209 -  
210 -# lmatGallery  
211 -  
212 -Likely matrix format  
213 -  
214 -  
215 -* **file:** gallery/lmat.cpp  
216 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
217 -* **author(s):** [Josh Klontz][jklontz]  
218 -* **see:** [www.liblikely.org](www.liblikely.org)  
219 -* **properties:** None  
220 -  
221 -  
222 ----  
223 -  
224 -# matrixGallery  
225 -  
226 -Combine all [Template](../cpp_api/template/template.md) into one large matrix and process it as a [Format](../cpp_api/format/format.md)  
227 -  
228 -  
229 -* **file:** gallery/matrix.cpp  
230 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
231 -* **author(s):** [Josh Klontz][jklontz]  
232 -* **properties:** None  
233 -  
234 -  
235 ----  
236 -  
237 -# memGallery  
238 -  
239 -A gallery held in memory.  
240 -  
241 -  
242 -* **file:** gallery/mem.cpp  
243 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
244 -* **author(s):** [Josh Klontz][jklontz]  
245 -* **properties:** None  
246 -  
247 -  
248 ----  
249 -  
250 -# mp4Gallery  
251 -  
252 -Read key frames of a .mp4 video file with LibAV  
253 -  
254 -  
255 -* **file:** gallery/keyframes.cpp  
256 -* **inherits:** [keyframesGallery](#keyframesgallery)  
257 -* **author(s):** [Ben Klein][bhklein]  
258 -* **properties:** None  
259 -  
260 -  
261 ----  
262 -  
263 -# postGallery  
264 -  
265 -Handle POST requests  
266 -  
267 -  
268 -* **file:** gallery/post.cpp  
269 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
270 -* **author(s):** [Josh Klontz][jklontz]  
271 -* **properties:** None  
272 -  
273 -  
274 ----  
275 -  
276 -# seqGallery  
277 -  
278 -DOCUMENT ME  
279 -  
280 -  
281 -* **file:** gallery/seq.cpp  
282 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
283 -* **author(s):** [Unknown][unknown]  
284 -* **properties:** None  
285 -  
286 -  
287 ----  
288 -  
289 -# statGallery  
290 -  
291 -Print [Template](../cpp_api/template/template.md) statistics.  
292 -  
293 -  
294 -* **file:** gallery/stat.cpp  
295 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
296 -* **author(s):** [Josh Klontz][jklontz]  
297 -* **properties:** None  
298 -  
299 -  
300 ----  
301 -  
302 -# templateGallery  
303 -  
304 -Treat the file as a single binary [Template](../cpp_api/template/template.md).  
305 -  
306 -  
307 -* **file:** gallery/template.cpp  
308 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
309 -* **author(s):** [Josh Klontz][jklontz]  
310 -* **properties:** None  
311 -  
312 -  
313 ----  
314 -  
315 -# turkGallery  
316 -  
317 -For Amazon Mechanical Turk datasets  
318 -  
319 -  
320 -* **file:** gallery/turk.cpp  
321 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
322 -* **author(s):** [Scott Klum][sklum]  
323 -* **properties:** None  
324 -  
325 -  
326 ----  
327 -  
328 -# txtGallery  
329 -  
330 -Treats each line as a file.  
331 -  
332 -  
333 -* **file:** gallery/txt.cpp  
334 -* **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)  
335 -* **author(s):** [Josh Klontz][jklontz]  
336 -* **format:** The entire line is treated as the file path. <pre><code>&lt;FILE&gt;  
337 -&lt;FILE&gt;  
338 -...  
339 -&lt;FILE&gt;  
340 -</code></pre>An optional label may be specified using a space ' ' separator: <pre><code>&lt;FILE&gt; &lt;LABEL&gt;  
341 -&lt;FILE&gt; &lt;LABEL&gt;  
342 -...  
343 -&lt;FILE&gt; &lt;LABEL&gt;  
344 -</code></pre>  
345 -* **properties:** None  
346 -  
347 -  
348 ----  
349 -  
350 -# urlGallery  
351 -  
352 -Newline-separated URLs.  
353 -  
354 -  
355 -* **file:** gallery/binary.cpp  
356 -* **inherits:** [BinaryGallery](#binarygallery)  
357 -* **author(s):** [Josh Klontz][jklontz]  
358 -* **properties:** None  
359 -  
360 -  
361 ----  
362 -  
363 -# utGallery  
364 -  
365 -A contiguous array of br_universal_template.  
366 -  
367 -  
368 -* **file:** gallery/binary.cpp  
369 -* **inherits:** [BinaryGallery](#binarygallery)  
370 -* **author(s):** [Josh Klontz][jklontz]  
371 -* **properties:** None  
372 -  
373 -  
374 ----  
375 -  
376 -# vbbGallery  
377 -  
378 -DOCUMENT ME  
379 -  
380 -  
381 -* **file:** gallery/vbb.cpp  
382 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
383 -* **author(s):** [Unknown][unknown]  
384 -* **properties:** None  
385 -  
386 -  
387 ----  
388 -  
389 -# videoGallery  
390 -  
391 -Read a video frame by frame using cv::VideoCapture  
392 -  
393 -  
394 -* **file:** gallery/video.cpp  
395 -* **inherits:** [Gallery](../cpp_api/gallery/gallery.md)  
396 -* **author(s):** [Unknown][unknown]  
397 -* **properties:** None  
398 -  
399 -  
400 ----  
401 -  
402 -# webcamGallery  
403 -  
404 -Read a video from the webcam  
405 -  
406 -  
407 -* **file:** gallery/video.cpp  
408 -* **inherits:** [videoGallery](#videogallery)  
409 -* **author(s):** [Unknown][unknown]  
410 -* **properties:** None  
411 -  
412 -  
413 ----  
414 -  
415 -# wmvGallery  
416 -  
417 -Read videos of format .wmv  
418 -  
419 -  
420 -* **file:** gallery/video.cpp  
421 -* **inherits:** [videoGallery](#videogallery)  
422 -* **author(s):** [Unknown][unknown]  
423 -* **properties:** None  
424 -  
425 -  
426 ----  
427 -  
428 -# xmlGallery  
429 -  
430 -A sigset input.  
431 -  
432 -  
433 -* **file:** gallery/xml.cpp  
434 -* **inherits:** [FileGallery](../cpp_api/filegallery/filegallery.md)  
435 -* **author(s):** [Josh Klontz][jklontz]  
436 -* **properties:** None  
437 -  
438 -  
439 ----  
440 -  
docs/docs/api_docs/plugins/gui.md deleted
1 -# AdjacentOverlayTransform  
2 -  
3 -Load the image named in the specified property, draw it on the current matrix adjacent to the rect specified in the other property.  
4 -  
5 -  
6 -* **file:** gui/adjacentoverlay.cpp  
7 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
8 -* **author(s):** [Charles Otto][caotto]  
9 -* **properties:** None  
10 -  
11 -  
12 ----  
13 -  
14 -# DrawDelaunayTransform  
15 -  
16 -Creates a Delaunay triangulation based on a set of points  
17 -  
18 -  
19 -* **file:** gui/drawdelaunay.cpp  
20 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
21 -* **author(s):** [Scott Klum][sklum]  
22 -* **properties:** None  
23 -  
24 -  
25 ----  
26 -  
27 -# DrawGridLinesTransform  
28 -  
29 -Draws a grid on the image  
30 -  
31 -  
32 -* **file:** gui/drawgridlines.cpp  
33 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
34 -* **author(s):** [Josh Klontz][jklontz]  
35 -* **properties:** None  
36 -  
37 -  
38 ----  
39 -  
40 -# DrawOpticalFlow  
41 -  
42 -Draw a line representing the direction and magnitude of optical flow at the specified points.  
43 -  
44 -  
45 -* **file:** gui/drawopticalflow.cpp  
46 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
47 -* **author(s):** [Austin Blanton][imaus10]  
48 -* **properties:** None  
49 -  
50 -  
51 ----  
52 -  
53 -# DrawPropertiesPointTransform  
54 -  
55 -Draw the values of a list of properties at the specified point on the image  
56 -  
57 -The inPlace argument controls whether or not the image is cloned before it is drawn on.  
58 -  
59 -  
60 -* **file:** gui/drawpropertiespoint.cpp  
61 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
62 -* **author(s):** [Charles Otto][caotto]  
63 -* **properties:** None  
64 -  
65 -  
66 ----  
67 -  
68 -# DrawPropertyPointTransform  
69 -  
70 -Draw the value of the specified property at the specified point on the image  
71 -  
72 -The inPlace argument controls whether or not the image is cloned before it is drawn on.  
73 -  
74 -  
75 -* **file:** gui/drawpropertypoint.cpp  
76 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
77 -* **author(s):** [Charles Otto][caotto]  
78 -* **properties:** None  
79 -  
80 -  
81 ----  
82 -  
83 -# DrawSegmentation  
84 -  
85 -Fill in the segmentations or draw a line between intersecting segments.  
86 -  
87 -  
88 -* **file:** gui/drawsegmentation.cpp  
89 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
90 -* **author(s):** [Austin Blanton][imaus10]  
91 -* **properties:** None  
92 -  
93 -  
94 ----  
95 -  
96 -# DrawTransform  
97 -  
98 -Renders metadata onto the image.  
99 -  
100 -The inPlace argument controls whether or not the image is cloned before the metadata is drawn.  
101 -  
102 -  
103 -* **file:** gui/draw.cpp  
104 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
105 -* **author(s):** [Josh Klontz][jklontz]  
106 -* **properties:** None  
107 -  
108 -  
109 ----  
110 -  
111 -# ElicitTransform  
112 -  
113 -Elicits metadata for templates in a pretty GUI  
114 -  
115 -  
116 -* **file:** gui/show.cpp  
117 -* **inherits:** [ShowTransform](#showtransform)  
118 -* **author(s):** [Scott Klum][sklum]  
119 -* **properties:** None  
120 -  
121 -  
122 ----  
123 -  
124 -# FPSCalc  
125 -  
126 -Calculates the average FPS of projects going through this transform, stores the result in AvgFPS  
127 -Reports an average FPS from the initialization of this transform onwards.  
128 -  
129 -  
130 -* **file:** gui/show.cpp  
131 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
132 -* **author(s):** [Charles Otto][caotto]  
133 -* **properties:** None  
134 -  
135 -  
136 ----  
137 -  
138 -# FPSLimit  
139 -  
140 -Limits the frequency of projects going through this transform to the input targetFPS  
141 -  
142 -  
143 -* **file:** gui/show.cpp  
144 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
145 -* **author(s):** [Charles Otto][caotto]  
146 -* **properties:** None  
147 -  
148 -  
149 ----  
150 -  
151 -# FilterTransform  
152 -  
153 -DOCUMENT ME  
154 -  
155 -  
156 -* **file:** gui/show.cpp  
157 -* **inherits:** [ShowTransform](#showtransform)  
158 -* **author(s):** [Unknown][unknown]  
159 -* **properties:** None  
160 -  
161 -  
162 ----  
163 -  
164 -# ManualRectsTransform  
165 -  
166 -Manual select rectangular regions on an image.  
167 -Stores marked rectangles as anonymous rectangles, or if a set of labels is provided, prompt the user  
168 -to select one of those labels after drawing each rectangle.  
169 -  
170 -  
171 -* **file:** gui/show.cpp  
172 -* **inherits:** [ShowTransform](#showtransform)  
173 -* **author(s):** [Charles Otto][caotto]  
174 -* **properties:** None  
175 -  
176 -  
177 ----  
178 -  
179 -# ManualTransform  
180 -  
181 -Manual selection of landmark locations  
182 -  
183 -  
184 -* **file:** gui/show.cpp  
185 -* **inherits:** [ShowTransform](#showtransform)  
186 -* **author(s):** [Scott Klum][sklum]  
187 -* **properties:** None  
188 -  
189 -  
190 ----  
191 -  
192 -# ShowTrainingTransform  
193 -  
194 -Show the training data  
195 -  
196 -  
197 -* **file:** gui/show.cpp  
198 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
199 -* **author(s):** [Josh Klontz][jklontz]  
200 -* **properties:** None  
201 -  
202 -  
203 ----  
204 -  
205 -# ShowTransform  
206 -  
207 -Displays templates in a GUI pop-up window using QT.  
208 -  
209 -Can be used with parallelism enabled, although it is considered TimeVarying.  
210 -  
211 -  
212 -* **file:** gui/show.cpp  
213 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
214 -* **author(s):** [Charles Otto][caotto]  
215 -* **properties:** None  
216 -  
217 -  
218 ----  
219 -  
220 -# SurveyTransform  
221 -  
222 -Display an image, and asks a yes/no question about it  
223 -  
224 -  
225 -* **file:** gui/show.cpp  
226 -* **inherits:** [ShowTransform](#showtransform)  
227 -* **author(s):** [Charles Otto][caotto]  
228 -* **properties:** None  
229 -  
230 -  
231 ----  
232 -  
docs/docs/api_docs/plugins/imgproc.md deleted
1 -# AbsDiffTransform  
2 -  
3 -Take the absolute difference of two matrices.  
4 -  
5 -  
6 -* **file:** imgproc/absdiff.cpp  
7 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
8 -* **author(s):** [Josh Klontz][jklontz]  
9 -* **properties:** None  
10 -  
11 -  
12 ----  
13 -  
14 -# AbsTransform  
15 -  
16 -Computes the absolute value of each element.  
17 -  
18 -  
19 -* **file:** imgproc/abs.cpp  
20 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
21 -* **author(s):** [Josh Klontz][jklontz]  
22 -* **properties:** None  
23 -  
24 -  
25 ----  
26 -  
27 -# AdaptiveThresholdTransform  
28 -  
29 -Wraps OpenCV's adaptive thresholding.  
30 -  
31 -  
32 -* **file:** imgproc/adaptivethreshold.cpp  
33 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
34 -* **author(s):** [Scott Klum][sklum]  
35 -* **see:** [http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html](http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html)  
36 -* **properties:** None  
37 -  
38 -  
39 ----  
40 -  
41 -# AffineTransform  
42 -  
43 -Performs a two or three point registration.  
44 -  
45 -  
46 -* **file:** imgproc/affine.cpp  
47 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
48 -* **author(s):** [Josh Klontz][jklontz]  
49 -* **properties:** None  
50 -  
51 -  
52 ----  
53 -  
54 -# AndTransform  
55 -  
56 -Logical AND of two matrices.  
57 -  
58 -  
59 -* **file:** imgproc/and.cpp  
60 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
61 -* **author(s):** [Josh Klontz][jklontz]  
62 -* **properties:** None  
63 -  
64 -  
65 ----  
66 -  
67 -# ApplyMaskTransform  
68 -  
69 -Applies a mask from the metadata.  
70 -  
71 -  
72 -* **file:** imgproc/applymask.cpp  
73 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
74 -* **author(s):** [Austin Blanton][imaus10]  
75 -* **properties:** None  
76 -  
77 -  
78 ----  
79 -  
80 -# BayesianQuantizationTransform  
81 -  
82 -Quantize into a space where L1 distance approximates log-likelihood.  
83 -  
84 -  
85 -* **file:** imgproc/bayesianquantization.cpp  
86 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
87 -* **author(s):** [Josh Klontz][jklontz]  
88 -* **properties:** None  
89 -  
90 -  
91 ----  
92 -  
93 -# BinarizeTransform  
94 -  
95 -Approximate floats as signed bit.  
96 -  
97 -  
98 -* **file:** imgproc/binarize.cpp  
99 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
100 -* **author(s):** [Josh Klontz][jklontz]  
101 -* **properties:** None  
102 -  
103 -  
104 ----  
105 -  
106 -# BlendTransform  
107 -  
108 -Alpha-blend two matrices  
109 -  
110 -  
111 -* **file:** imgproc/blend.cpp  
112 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
113 -* **author(s):** [Josh Klontz][jklontz]  
114 -* **properties:** None  
115 -  
116 -  
117 ----  
118 -  
119 -# BlurTransform  
120 -  
121 -Gaussian blur  
122 -  
123 -  
124 -* **file:** imgproc/blur.cpp  
125 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
126 -* **author(s):** [Josh Klontz][jklontz]  
127 -* **properties:** None  
128 -  
129 -  
130 ----  
131 -  
132 -# BuildScalesTransform  
133 -  
134 -DOCUMENT ME  
135 -  
136 -  
137 -* **file:** imgproc/multiscale.cpp  
138 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
139 -* **author(s):** [Austin Blanton][imaus10]  
140 -* **properties:** None  
141 -  
142 -  
143 ----  
144 -  
145 -# ByRowTransform  
146 -  
147 -Turns each row into its own matrix.  
148 -  
149 -  
150 -* **file:** imgproc/byrow.cpp  
151 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
152 -* **author(s):** [Josh Klontz][jklontz]  
153 -* **properties:** None  
154 -  
155 -  
156 ----  
157 -  
158 -# CannyTransform  
159 -  
160 -Wrapper to OpenCV Canny edge detector  
161 -  
162 -  
163 -* **file:** imgproc/canny.cpp  
164 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
165 -* **author(s):** [Scott Klum][sklum]  
166 -* **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)  
167 -* **properties:** None  
168 -  
169 -  
170 ----  
171 -  
172 -# CatColsTransform  
173 -  
174 -Concatenates all input matrices by column into a single matrix.  
175 -Use after a fork to concatenate two feature matrices by column.  
176 -  
177 -  
178 -* **file:** imgproc/catcols.cpp  
179 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
180 -* **author(s):** [Austin Blanton][imaus10]  
181 -* **properties:** None  
182 -  
183 -  
184 ----  
185 -  
186 -# CatRowsTransform  
187 -  
188 -Concatenates all input matrices by row into a single matrix.  
189 -All matricies must have the same column counts.  
190 -  
191 -  
192 -* **file:** imgproc/catrows.cpp  
193 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
194 -* **author(s):** [Josh Klontz][jklontz]  
195 -* **properties:** None  
196 -  
197 -  
198 ----  
199 -  
200 -# CatTransform  
201 -  
202 -Concatenates all input matrices into a single matrix.  
203 -  
204 -  
205 -* **file:** imgproc/cat.cpp  
206 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
207 -* **author(s):** [Josh Klontz][jklontz]  
208 -* **properties:** None  
209 -  
210 -  
211 ----  
212 -  
213 -# CenterTransform  
214 -  
215 -Normalize each dimension based on training data.  
216 -  
217 -  
218 -* **file:** imgproc/center.cpp  
219 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
220 -* **author(s):** [Josh Klontz][jklontz]  
221 -* **properties:** None  
222 -  
223 -  
224 ----  
225 -  
226 -# ContrastEqTransform  
227 -  
228 -Perform contrast equalization  
229 -  
230 -  
231 -* **file:** imgproc/contrasteq.cpp  
232 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
233 -* **author(s):** [Josh Klontz][jklontz]  
234 -* **read:**  
235 -  
236 - 1. *Xiaoyang Tan; Triggs, B.;*  
237 - **"Enhanced Local Texture Feature Sets for Face Recognition Under Difficult Lighting Conditions,"**  
238 - Image Processing, IEEE Transactions on , vol.19, no.6, pp.1635-1650, June 2010  
239 -  
240 -* **properties:** None  
241 -  
242 -  
243 ----  
244 -  
245 -# CropBlackTransform  
246 -  
247 -Crop out black borders  
248 -  
249 -  
250 -* **file:** imgproc/cropblack.cpp  
251 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
252 -* **author(s):** [Josh Klontz][jklontz]  
253 -* **properties:** None  
254 -  
255 -  
256 ----  
257 -  
258 -# CropFromMaskTransform  
259 -  
260 -Crops image based on mask metadata  
261 -  
262 -  
263 -* **file:** imgproc/cropfrommask.cpp  
264 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
265 -* **author(s):** [Brendan Klare][bklare]  
266 -* **properties:** None  
267 -  
268 -  
269 ----  
270 -  
271 -# CropSquareTransform  
272 -  
273 -Trim the image so the width and the height are the same size.  
274 -  
275 -  
276 -* **file:** imgproc/cropsquare.cpp  
277 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
278 -* **author(s):** [Josh Klontz][jklontz]  
279 -* **properties:** None  
280 -  
281 -  
282 ----  
283 -  
284 -# CropTransform  
285 -  
286 -Crops about the specified region of interest.  
287 -  
288 -  
289 -* **file:** imgproc/crop.cpp  
290 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
291 -* **author(s):** [Josh Klontz][jklontz]  
292 -* **properties:** None  
293 -  
294 -  
295 ----  
296 -  
297 -# CryptographicHashTransform  
298 -  
299 -Wraps QCryptographicHash  
300 -  
301 -  
302 -* **file:** imgproc/cryptographichash.cpp  
303 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
304 -* **author(s):** [Josh Klontz][jklontz]  
305 -* **see:** [http://doc.qt.io/qt-5/qcryptographichash.html](http://doc.qt.io/qt-5/qcryptographichash.html)  
306 -* **properties:** None  
307 -  
308 -  
309 ----  
310 -  
311 -# CvtFloatTransform  
312 -  
313 -Convert to floating point format.  
314 -  
315 -  
316 -* **file:** imgproc/cvtfloat.cpp  
317 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
318 -* **author(s):** [Josh Klontz][jklontz]  
319 -* **properties:** None  
320 -  
321 -  
322 ----  
323 -  
324 -# CvtTransform  
325 -  
326 -Colorspace conversion.  
327 -  
328 -  
329 -* **file:** imgproc/cvt.cpp  
330 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
331 -* **author(s):** [Josh Klontz][jklontz]  
332 -* **properties:** None  
333 -  
334 -  
335 ----  
336 -  
337 -# CvtUCharTransform  
338 -  
339 -Convert to uchar format  
340 -  
341 -  
342 -* **file:** imgproc/cvtuchar.cpp  
343 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
344 -* **author(s):** [Josh Klontz][jklontz]  
345 -* **properties:** None  
346 -  
347 -  
348 ----  
349 -  
350 -# DiscardAlphaTransform  
351 -  
352 -Drop the alpha channel (if exists).  
353 -  
354 -  
355 -* **file:** imgproc/discardalpha.cpp  
356 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
357 -* **author(s):** [Austin Blanton][imaus10]  
358 -* **properties:** None  
359 -  
360 -  
361 ----  
362 -  
363 -# DivTransform  
364 -  
365 -Enforce a multiple of n columns.  
366 -  
367 -  
368 -* **file:** imgproc/div.cpp  
369 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
370 -* **author(s):** [Josh Klontz][jklontz]  
371 -* **properties:** None  
372 -  
373 -  
374 ----  
375 -  
376 -# DoGTransform  
377 -  
378 -Difference of gaussians  
379 -  
380 -  
381 -* **file:** imgproc/dog.cpp  
382 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
383 -* **author(s):** [Josh Klontz][jklontz]  
384 -* **properties:** None  
385 -  
386 -  
387 ----  
388 -  
389 -# DownsampleTransform  
390 -  
391 -Downsample the rows and columns of a matrix.  
392 -  
393 -  
394 -* **file:** imgproc/downsample.cpp  
395 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
396 -* **author(s):** [Lacey Best-Rowden][lbestrowden]  
397 -* **properties:** None  
398 -  
399 -  
400 ----  
401 -  
402 -# DupTransform  
403 -  
404 -Duplicates the [Template](../cpp_api/template/template.md) data.  
405 -  
406 -  
407 -* **file:** imgproc/dup.cpp  
408 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
409 -* **author(s):** [Josh Klontz][jklontz]  
410 -* **properties:** None  
411 -  
412 -  
413 ----  
414 -  
415 -# EnsureChannelsTransform  
416 -  
417 -Enforce the matrix has a certain number of channels by adding or removing channels.  
418 -  
419 -  
420 -* **file:** imgproc/ensurechannels.cpp  
421 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
422 -* **author(s):** [Josh Klontz][jklontz]  
423 -* **properties:** None  
424 -  
425 -  
426 ----  
427 -  
428 -# EqualizeHistTransform  
429 -  
430 -Histogram equalization  
431 -  
432 -  
433 -* **file:** imgproc/equalizehist.cpp  
434 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
435 -* **author(s):** [Josh Klontz][jklontz]  
436 -* **properties:** None  
437 -  
438 -  
439 ----  
440 -  
441 -# FlipTransform  
442 -  
443 -Flips the image about an axis.  
444 -  
445 -  
446 -* **file:** imgproc/flip.cpp  
447 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
448 -* **author(s):** [Josh Klontz][jklontz]  
449 -* **properties:** None  
450 -  
451 -  
452 ----  
453 -  
454 -# FloodTransform  
455 -  
456 -Fill black pixels with the specified color.  
457 -  
458 -  
459 -* **file:** imgproc/flood.cpp  
460 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
461 -* **author(s):** [Josh Klontz][jklontz]  
462 -* **properties:** None  
463 -  
464 -  
465 ----  
466 -  
467 -# GaborJetTransform  
468 -  
469 -A vector of gabor wavelets applied at a point.  
470 -  
471 -  
472 -* **file:** imgproc/gabor.cpp  
473 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
474 -* **author(s):** [Josh Klontz][jklontz]  
475 -* **properties:** None  
476 -  
477 -  
478 ----  
479 -  
480 -# GaborTransform  
481 -  
482 -Implements a Gabor Filter  
483 -  
484 -  
485 -* **file:** imgproc/gabor.cpp  
486 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
487 -* **author(s):** [Josh Klontz][jklontz]  
488 -* **see:** [http://en.wikipedia.org/wiki/Gabor_filter](http://en.wikipedia.org/wiki/Gabor_filter)  
489 -* **properties:** None  
490 -  
491 -  
492 ----  
493 -  
494 -# GammaTransform  
495 -  
496 -Gamma correction  
497 -  
498 -  
499 -* **file:** imgproc/gamma.cpp  
500 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
501 -* **author(s):** [Josh Klontz][jklontz]  
502 -* **properties:** None  
503 -  
504 -  
505 ----  
506 -  
507 -# GradientMaskTransform  
508 -  
509 -Masks image according to pixel change.  
510 -  
511 -  
512 -* **file:** imgproc/gradientmask.cpp  
513 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
514 -* **author(s):** [Josh Klontz][jklontz]  
515 -* **properties:** None  
516 -  
517 -  
518 ----  
519 -  
520 -# GradientTransform  
521 -  
522 -Computes magnitude and/or angle of image.  
523 -  
524 -  
525 -* **file:** imgproc/gradient.cpp  
526 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
527 -* **author(s):** [Josh Klontz][jklontz]  
528 -* **properties:** None  
529 -  
530 -  
531 ----  
532 -  
533 -# GroupTransform  
534 -  
535 -Group all input matrices into a single matrix.  
536 -  
537 -Similar to CatTransfrom but groups every _size_ adjacent matricies.  
538 -  
539 -  
540 -* **file:** imgproc/group.cpp  
541 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
542 -* **author(s):** [Josh Klontz][jklontz]  
543 -* **properties:** None  
544 -  
545 -  
546 ----  
547 -  
548 -# HeatmapTransform  
549 -  
550 -DOCUMENT ME  
551 -  
552 -  
553 -* **file:** imgproc/heatmap.cpp  
554 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
555 -* **author(s):** [Unknown][unknown]  
556 -* **properties:** None  
557 -  
558 -  
559 ----  
560 -  
561 -# HistBinTransform  
562 -  
563 -Quantizes the values into bins.  
564 -  
565 -  
566 -* **file:** imgproc/histbin.cpp  
567 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
568 -* **author(s):** [Josh Klontz][jklontz]  
569 -* **properties:** None  
570 -  
571 -  
572 ----  
573 -  
574 -# HistEqQuantizationTransform  
575 -  
576 -Approximate floats as uchar with different scalings for each dimension.  
577 -  
578 -  
579 -* **file:** imgproc/histeqquantization.cpp  
580 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
581 -* **author(s):** [Josh Klontz][jklontz]  
582 -* **properties:** None  
583 -  
584 -  
585 ----  
586 -  
587 -# HistTransform  
588 -  
589 -Histograms the matrix  
590 -  
591 -  
592 -* **file:** imgproc/hist.cpp  
593 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
594 -* **author(s):** [Josh Klontz][jklontz]  
595 -* **properties:** None  
596 -  
597 -  
598 ----  
599 -  
600 -# HoGDescriptorTransform  
601 -  
602 -OpenCV HOGDescriptor wrapper  
603 -  
604 -  
605 -* **file:** imgproc/hog.cpp  
606 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
607 -* **author(s):** [Austin Blanton][imaus10]  
608 -* **see:** [http://docs.opencv.org/modules/gpu/doc/object_detection.html](http://docs.opencv.org/modules/gpu/doc/object_detection.html)  
609 -* **properties:** None  
610 -  
611 -  
612 ----  
613 -  
614 -# InpaintTransform  
615 -  
616 -Wraps OpenCV inpainting  
617 -  
618 -  
619 -* **file:** imgproc/inpaint.cpp  
620 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
621 -* **author(s):** [Josh Klontz][jklontz]  
622 -* **see:** [http://docs.opencv.org/modules/photo/doc/inpainting.html](http://docs.opencv.org/modules/photo/doc/inpainting.html)  
623 -* **properties:** None  
624 -  
625 -  
626 ----  
627 -  
628 -# IntegralHistTransform  
629 -  
630 -An integral histogram  
631 -  
632 -  
633 -* **file:** imgproc/integralhist.cpp  
634 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
635 -* **author(s):** [Josh Klontz][jklontz]  
636 -* **properties:** None  
637 -  
638 -  
639 ----  
640 -  
641 -# IntegralSamplerTransform  
642 -  
643 -Sliding window feature extraction from a multi-channel integral image.  
644 -  
645 -  
646 -* **file:** imgproc/integralsampler.cpp  
647 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
648 -* **author(s):** [Josh Klontz][jklontz]  
649 -* **properties:** None  
650 -  
651 -  
652 ----  
653 -  
654 -# IntegralSlidingWindowTransform  
655 -  
656 -Overloads SlidingWindowTransform for integral images that should be  
657 -sampled at multiple scales.  
658 -  
659 -  
660 -* **file:** imgproc/slidingwindow.cpp  
661 -* **inherits:** [SlidingWindowTransform](#slidingwindowtransform)  
662 -* **author(s):** [Josh Klontz][jklontz]  
663 -* **properties:** None  
664 -  
665 -  
666 ----  
667 -  
668 -# IntegralTransform  
669 -  
670 -Computes integral image.  
671 -  
672 -  
673 -* **file:** imgproc/integral.cpp  
674 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
675 -* **author(s):** [Josh Klontz][jklontz]  
676 -* **properties:** None  
677 -  
678 -  
679 ----  
680 -  
681 -# KernelHashTransform  
682 -  
683 -Kernel hash  
684 -  
685 -  
686 -* **file:** imgproc/kernelhash.cpp  
687 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
688 -* **author(s):** [Josh Klontz][jklontz]  
689 -* **properties:** None  
690 -  
691 -  
692 ----  
693 -  
694 -# KeyPointDescriptorTransform  
695 -  
696 -Wraps OpenCV Key Point Descriptor  
697 -  
698 -  
699 -* **file:** imgproc/keypointdescriptor.cpp  
700 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
701 -* **author(s):** [Josh Klontz][jklontz]  
702 -* **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)  
703 -* **properties:** None  
704 -  
705 -  
706 ----  
707 -  
708 -# LBPTransform  
709 -  
710 -Convert the image into a feature vector using Local Binary Patterns  
711 -  
712 -  
713 -* **file:** imgproc/lbp.cpp  
714 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
715 -* **author(s):** [Josh Klontz][jklontz]  
716 -* **read:**  
717 -  
718 - 1. *Ahonen, T.; Hadid, A.; Pietikainen, M.;*  
719 - **"Face Description with Local Binary Patterns: Application to Face Recognition"**  
720 - Pattern Analysis and Machine Intelligence, IEEE Transactions, vol.28, no.12, pp.2037-2041, Dec. 2006  
721 -  
722 -* **properties:** None  
723 -  
724 -  
725 ----  
726 -  
727 -# LTPTransform  
728 -  
729 -DOCUMENT ME  
730 -  
731 -  
732 -* **file:** imgproc/ltp.cpp  
733 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
734 -* **author(s):** [Brendan Klare][bklare], [Josh Klontz][jklontz]  
735 -* **read:**  
736 -  
737 - 1. *Tan, Xiaoyang, and Bill Triggs.*  
738 - **"Enhanced local texture feature sets for face recognition under difficult lighting conditions."**  
739 - Analysis and Modeling of Faces and Gestures. Springer Berlin Heidelberg, 2007. 168-182.  
740 -  
741 -* **properties:** None  
742 -  
743 -  
744 ----  
745 -  
746 -# LargestConvexAreaTransform  
747 -  
748 -Set the template's label to the area of the largest convex hull.  
749 -  
750 -  
751 -* **file:** imgproc/largestconvexarea.cpp  
752 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
753 -* **author(s):** [Josh Klontz][jklontz]  
754 -* **properties:** None  
755 -  
756 -  
757 ----  
758 -  
759 -# LimitSizeTransform  
760 -  
761 -Limit the size of the template  
762 -  
763 -  
764 -* **file:** imgproc/limitsize.cpp  
765 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
766 -* **author(s):** [Josh Klontz][jklontz]  
767 -* **properties:** None  
768 -  
769 -  
770 ----  
771 -  
772 -# MAddTransform  
773 -  
774 -dst = a src+b  
775 -  
776 -  
777 -* **file:** imgproc/madd.cpp  
778 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
779 -* **author(s):** [Josh Klontz][jklontz]  
780 -* **properties:** None  
781 -  
782 -  
783 ----  
784 -  
785 -# MaskTransform  
786 -  
787 -Applies an eliptical mask  
788 -  
789 -  
790 -* **file:** imgproc/mask.cpp  
791 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
792 -* **author(s):** [Josh Klontz][jklontz]  
793 -* **properties:** None  
794 -  
795 -  
796 ----  
797 -  
798 -# MatStatsTransform  
799 -  
800 -Statistics  
801 -  
802 -  
803 -* **file:** imgproc/matstats.cpp  
804 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
805 -* **author(s):** [Josh Klontz][jklontz]  
806 -* **properties:** None  
807 -  
808 -  
809 ----  
810 -  
811 -# MeanFillTransform  
812 -  
813 -Fill 0 pixels with the mean of non-0 pixels.  
814 -  
815 -  
816 -* **file:** imgproc/meanfill.cpp  
817 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
818 -* **author(s):** [Josh Klontz][jklontz]  
819 -* **properties:** None  
820 -  
821 -  
822 ----  
823 -  
824 -# MeanTransform  
825 -  
826 -Computes the mean of a set of templates.  
827 -  
828 -Suitable for visualization only as it sets every projected template to the mean template.  
829 -  
830 -  
831 -* **file:** imgproc/mean.cpp  
832 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
833 -* **author(s):** [Scott Klum][sklum]  
834 -* **properties:** None  
835 -  
836 -  
837 ----  
838 -  
839 -# MergeTransform  
840 -  
841 -Wraps OpenCV merge  
842 -  
843 -  
844 -* **file:** imgproc/merge.cpp  
845 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
846 -* **author(s):** [Josh Klontz][jklontz]  
847 -* **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)  
848 -* **properties:** None  
849 -  
850 -  
851 ----  
852 -  
853 -# MorphTransform  
854 -  
855 -Morphological operator  
856 -  
857 -  
858 -* **file:** imgproc/morph.cpp  
859 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
860 -* **author(s):** [Josh Klontz][jklontz]  
861 -* **properties:** None  
862 -  
863 -  
864 ----  
865 -  
866 -# NLMeansDenoisingTransform  
867 -  
868 -Wraps OpenCV Non-Local Means Denoising  
869 -  
870 -  
871 -* **file:** imgproc/denoising.cpp  
872 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
873 -* **author(s):** [Josh Klontz][jklontz]  
874 -* **see:** [http://docs.opencv.org/modules/photo/doc/denoising.html](http://docs.opencv.org/modules/photo/doc/denoising.html)  
875 -* **properties:** None  
876 -  
877 -  
878 ----  
879 -  
880 -# NormalizeTransform  
881 -  
882 -Normalize matrix to unit length  
883 -  
884 -  
885 -* **file:** imgproc/normalize.cpp  
886 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
887 -* **author(s):** [Josh Klontz][jklontz]  
888 -* **properties:**  
889 -  
890 - Property | Type | Description  
891 - --- | --- | ---  
892 - NormType | enum | Values are:<ul><li>NORM_INF</li><li>NORM_L1</li><li>NORM_L2</li><li>NORM_MINMAX</li></ul>  
893 - ByRow | bool | If true normalize each row independently otherwise normalize the entire matrix.  
894 - alpha | int | Lower bound if using NORM_MINMAX. Value to normalize to otherwise.  
895 - beta | int | Upper bound if using NORM_MINMAX. Not used otherwise.  
896 - squareRoot | bool | If true compute the signed square root of the output after normalization.  
897 -  
898 ----  
899 -  
900 -# OrigLinearRegressionTransform  
901 -  
902 -Prediction with magic numbers from jmp; must get input as blue;green;red  
903 -  
904 -  
905 -* **file:** imgproc/origlinearregression.cpp  
906 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
907 -* **author(s):** [E. Taborsky][mmtaborsky]  
908 -* **properties:** None  
909 -  
910 -  
911 ----  
912 -  
913 -# PackTransform  
914 -  
915 -Compress two uchar into one uchar.  
916 -  
917 -  
918 -* **file:** imgproc/pack.cpp  
919 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
920 -* **author(s):** [Josh Klontz][jklontz]  
921 -* **properties:** None  
922 -  
923 -  
924 ----  
925 -  
926 -# PowTransform  
927 -  
928 -Raise each element to the specified power.  
929 -  
930 -  
931 -* **file:** imgproc/pow.cpp  
932 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
933 -* **author(s):** [Josh Klontz][jklontz]  
934 -* **properties:** None  
935 -  
936 -  
937 ----  
938 -  
939 -# ProductQuantizationDistance  
940 -  
941 -Distance in a product quantized space  
942 -  
943 -  
944 -* **file:** imgproc/productquantization.cpp  
945 -* **inherits:** [UntrainableDistance](../cpp_api/untrainabledistance/untrainabledistance.md)  
946 -* **author(s):** [Josh Klontz][jklontz]  
947 -* **read:**  
948 -  
949 - 1. *Jegou, Herve, Matthijs Douze, and Cordelia Schmid.*  
950 - **"Product quantization for nearest neighbor search."**  
951 - Pattern Analysis and Machine Intelligence, IEEE Transactions on 33.1 (2011): 117-128  
952 -  
953 -* **properties:** None  
954 -  
955 -  
956 ----  
957 -  
958 -# ProductQuantizationTransform  
959 -  
960 -Product quantization  
961 -  
962 -  
963 -* **file:** imgproc/productquantization.cpp  
964 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
965 -* **author(s):** [Josh Klontz][jklontz]  
966 -* **read:**  
967 -  
968 - 1. *Jegou, Herve, Matthijs Douze, and Cordelia Schmid.*  
969 - **"Product quantization for nearest neighbor search."**  
970 - Pattern Analysis and Machine Intelligence, IEEE Transactions on 33.1 (2011): 117-128  
971 -  
972 -* **properties:** None  
973 -  
974 -  
975 ----  
976 -  
977 -# QuantizeTransform  
978 -  
979 -Approximate floats as uchar.  
980 -  
981 -  
982 -* **file:** imgproc/quantize.cpp  
983 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
984 -* **author(s):** [Josh Klontz][jklontz]  
985 -* **properties:** None  
986 -  
987 -  
988 ----  
989 -  
990 -# RGTransform  
991 -  
992 -Normalized RG color space.  
993 -  
994 -  
995 -* **file:** imgproc/rg.cpp  
996 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
997 -* **author(s):** [Josh Klontz][jklontz]  
998 -* **properties:** None  
999 -  
1000 -  
1001 ----  
1002 -  
1003 -# ROIFromPtsTransform  
1004 -  
1005 -Crops the rectangular regions of interest from given points and sizes.  
1006 -  
1007 -  
1008 -* **file:** imgproc/roifrompoints.cpp  
1009 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1010 -* **author(s):** [Austin Blanton][imaus10]  
1011 -* **properties:** None  
1012 -  
1013 -  
1014 ----  
1015 -  
1016 -# ROITransform  
1017 -  
1018 -Crops the rectangular regions of interest.  
1019 -  
1020 -  
1021 -* **file:** imgproc/roi.cpp  
1022 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1023 -* **author(s):** [Josh Klontz][jklontz]  
1024 -* **properties:** None  
1025 -  
1026 -  
1027 ----  
1028 -  
1029 -# RankTransform  
1030 -  
1031 -Converts each element to its rank-ordered value.  
1032 -  
1033 -  
1034 -* **file:** imgproc/rank.cpp  
1035 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1036 -* **author(s):** [Josh Klontz][jklontz]  
1037 -* **properties:** None  
1038 -  
1039 -  
1040 ----  
1041 -  
1042 -# RectRegionsTransform  
1043 -  
1044 -Subdivide matrix into rectangular subregions.  
1045 -  
1046 -  
1047 -* **file:** imgproc/rectregions.cpp  
1048 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1049 -* **author(s):** [Josh Klontz][jklontz]  
1050 -* **properties:** None  
1051 -  
1052 -  
1053 ----  
1054 -  
1055 -# RecursiveIntegralSamplerTransform  
1056 -  
1057 -Construct [Template](../cpp_api/template/template.md) in a recursive decent manner.  
1058 -  
1059 -  
1060 -* **file:** imgproc/recursiveintegralsampler.cpp  
1061 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
1062 -* **author(s):** [Josh Klontz][jklontz]  
1063 -* **properties:** None  
1064 -  
1065 -  
1066 ----  
1067 -  
1068 -# RedLinearRegressionTransform  
1069 -  
1070 -Prediction using only the red wavelength; magic numbers from jmp  
1071 -  
1072 -  
1073 -* **file:** imgproc/redlinearregression.cpp  
1074 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1075 -* **author(s):** [E. Taborsky][mmtaborsky]  
1076 -* **properties:** None  
1077 -  
1078 -  
1079 ----  
1080 -  
1081 -# ReshapeTransform  
1082 -  
1083 -Reshape each matrix to the specified number of rows.  
1084 -  
1085 -  
1086 -* **file:** imgproc/reshape.cpp  
1087 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1088 -* **author(s):** [Josh Klontz][jklontz]  
1089 -* **properties:** None  
1090 -  
1091 -  
1092 ----  
1093 -  
1094 -# ResizeTransform  
1095 -  
1096 -Resize the template  
1097 -  
1098 -  
1099 -* **file:** imgproc/resize.cpp  
1100 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1101 -* **author(s):** [Josh Klontz][jklontz]  
1102 -* **properties:**  
1103 -  
1104 - Property | Type | Description  
1105 - --- | --- | ---  
1106 - 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>  
1107 - preserveAspect | bool | If true, the image will be sized per specification, but a border will be applied to preserve aspect ratio.  
1108 -  
1109 ----  
1110 -  
1111 -# RevertAffineTransform  
1112 -  
1113 -Designed for use after eye detection + Stasm, this will  
1114 -revert the detected landmarks to the original coordinate space  
1115 -before affine alignment to the stasm mean shape. The storeAffine  
1116 -parameter must be set to true when calling AffineTransform before this.  
1117 -  
1118 -  
1119 -* **file:** imgproc/revertaffine.cpp  
1120 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1121 -* **author(s):** [Brendan Klare][bklare]  
1122 -* **properties:** None  
1123 -  
1124 -  
1125 ----  
1126 -  
1127 -# RndPointTransform  
1128 -  
1129 -Generates a random landmark.  
1130 -  
1131 -  
1132 -* **file:** imgproc/rndpoint.cpp  
1133 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
1134 -* **author(s):** [Josh Klontz][jklontz]  
1135 -* **properties:** None  
1136 -  
1137 -  
1138 ----  
1139 -  
1140 -# RndRegionTransform  
1141 -  
1142 -Selects a random region.  
1143 -  
1144 -  
1145 -* **file:** imgproc/rndregion.cpp  
1146 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1147 -* **author(s):** [Josh Klontz][jklontz]  
1148 -* **properties:** None  
1149 -  
1150 -  
1151 ----  
1152 -  
1153 -# RndRotateTransform  
1154 -  
1155 -Randomly rotates an image in a specified range.  
1156 -  
1157 -  
1158 -* **file:** imgproc/rndrotate.cpp  
1159 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1160 -* **author(s):** [Scott Klum][sklum]  
1161 -* **properties:** None  
1162 -  
1163 -  
1164 ----  
1165 -  
1166 -# RndSubspaceTransform  
1167 -  
1168 -Generates a random subspace.  
1169 -  
1170 -  
1171 -* **file:** imgproc/rndsubspace.cpp  
1172 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
1173 -* **author(s):** [Josh Klontz][jklontz]  
1174 -* **properties:** None  
1175 -  
1176 -  
1177 ----  
1178 -  
1179 -# RootNormTransform  
1180 -  
1181 -dst=sqrt(norm_L1(src)) proposed as RootSIFT (see paper)  
1182 -  
1183 -  
1184 -* **file:** imgproc/rootnorm.cpp  
1185 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1186 -* **author(s):** [Josh Klontz][jklontz]  
1187 -* **read:**  
1188 -  
1189 - 1. *Arandjelovic, Relja, and Andrew Zisserman.*  
1190 - **"Three things everyone should know to improve object retrieval."**  
1191 - Computer Vision and Pattern Recognition (CVPR), 2012 IEEE Conference on. IEEE, 2012.  
1192 -  
1193 -* **properties:** None  
1194 -  
1195 -  
1196 ----  
1197 -  
1198 -# RowWiseMeanCenterTransform  
1199 -  
1200 -Remove the row-wise training set average.  
1201 -  
1202 -  
1203 -* **file:** imgproc/rowwisemeancenter.cpp  
1204 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
1205 -* **author(s):** [Josh Klontz][jklontz]  
1206 -* **properties:** None  
1207 -  
1208 -  
1209 ----  
1210 -  
1211 -# SIFTDescriptorTransform  
1212 -  
1213 -Specialize wrapper OpenCV SIFT wrapper  
1214 -  
1215 -  
1216 -* **file:** imgproc/sift.cpp  
1217 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1218 -* **author(s):** [Josh Klontz][jklontz]  
1219 -* **see:** [http://docs.opencv.org/modules/nonfree/doc/feature_detection.html](http://docs.opencv.org/modules/nonfree/doc/feature_detection.html)  
1220 -* **properties:** None  
1221 -  
1222 -  
1223 ----  
1224 -  
1225 -# SampleFromMaskTransform  
1226 -  
1227 -Samples pixels from a mask.  
1228 -  
1229 -  
1230 -* **file:** imgproc/samplefrommask.cpp  
1231 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1232 -* **author(s):** [Scott Klum][sklum]  
1233 -* **properties:** None  
1234 -  
1235 -  
1236 ----  
1237 -  
1238 -# ScaleTransform  
1239 -  
1240 -Scales using the given factor  
1241 -  
1242 -  
1243 -* **file:** imgproc/scale.cpp  
1244 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1245 -* **author(s):** [Scott Klum][sklum]  
1246 -* **properties:** None  
1247 -  
1248 -  
1249 ----  
1250 -  
1251 -# SkinMaskTransform  
1252 -  
1253 -Make a mask over skin in an image  
1254 -  
1255 -  
1256 -* **file:** imgproc/skinmask.cpp  
1257 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1258 -* **author(s):** [Josh Klontz][jklontz]  
1259 -* **see:** [http://worldofcameras.wordpress.com/tag/skin-detection-opencv/](http://worldofcameras.wordpress.com/tag/skin-detection-opencv/)  
1260 -* **properties:** None  
1261 -  
1262 -  
1263 ----  
1264 -  
1265 -# SlidingWindowTransform  
1266 -  
1267 -Applies a transform to a sliding window.  
1268 -Discards negative detections.  
1269 -  
1270 -  
1271 -* **file:** imgproc/slidingwindow.cpp  
1272 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
1273 -* **author(s):** [Austin Blanton][imaus10]  
1274 -* **properties:** None  
1275 -  
1276 -  
1277 ----  
1278 -  
1279 -# SplitChannelsTransform  
1280 -  
1281 -Split a multi-channel matrix into several single-channel matrices.  
1282 -  
1283 -  
1284 -* **file:** imgproc/splitchannels.cpp  
1285 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1286 -* **author(s):** [Josh Klontz][jklontz]  
1287 -* **properties:** None  
1288 -  
1289 -  
1290 ----  
1291 -  
1292 -# SubdivideTransform  
1293 -  
1294 -Divide the matrix into 4 smaller matricies of equal size.  
1295 -  
1296 -  
1297 -* **file:** imgproc/subdivide.cpp  
1298 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1299 -* **author(s):** [Josh Klontz][jklontz]  
1300 -* **properties:** None  
1301 -  
1302 -  
1303 ----  
1304 -  
1305 -# SubtractTransform  
1306 -  
1307 -Subtract two matrices.  
1308 -  
1309 -  
1310 -* **file:** imgproc/subtract.cpp  
1311 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
1312 -* **author(s):** [Josh Klontz][jklontz]  
1313 -* **properties:** None  
1314 -  
1315 -  
1316 ----  
1317 -  
1318 -# ThresholdTransform  
1319 -  
1320 -Wraps OpenCV's adaptive thresholding.  
1321 -  
1322 -  
1323 -* **file:** imgproc/threshold.cpp  
1324 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1325 -* **author(s):** [Scott Klum][sklum]  
1326 -* **see:** [http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html](http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html)  
1327 -* **properties:** None  
1328 -  
1329 -  
1330 ----  
1331 -  
1332 -# TransposeTransform  
1333 -  
1334 -Get the transpose of the [Template](../cpp_api/template/template.md) matrix  
1335 -  
1336 -  
1337 -* **file:** imgproc/transpose.cpp  
1338 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1339 -* **author(s):** [Unknown][unknown]  
1340 -* **properties:** None  
1341 -  
1342 -  
1343 ----  
1344 -  
1345 -# WatershedSegmentationTransform  
1346 -  
1347 -Applies watershed segmentation.  
1348 -  
1349 -  
1350 -* **file:** imgproc/watershedsegmentation.cpp  
1351 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
1352 -* **author(s):** [Austin Blanton][imaus10]  
1353 -* **properties:** None  
1354 -  
1355 -  
1356 ----  
1357 -  
docs/docs/api_docs/plugins/io.md deleted
1 -# DecodeTransform  
2 -  
3 -Decodes images  
4 -  
5 -  
6 -* **file:** io/decode.cpp  
7 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
8 -* **author(s):** [Josh Klontz][jklontz]  
9 -* **properties:** None  
10 -  
11 -  
12 ----  
13 -  
14 -# DownloadTransform  
15 -  
16 -Downloads an image from a URL  
17 -  
18 -  
19 -* **file:** io/download.cpp  
20 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
21 -* **author(s):** [Josh Klontz][jklontz]  
22 -* **properties:** None  
23 -  
24 -  
25 ----  
26 -  
27 -# GalleryOutputTransform  
28 -  
29 -DOCUMENT ME  
30 -  
31 -  
32 -* **file:** io/galleryoutput.cpp  
33 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
34 -* **author(s):** [Unknown][unknown]  
35 -* **properties:** None  
36 -  
37 -  
38 ----  
39 -  
40 -# IncrementalOutputTransform  
41 -  
42 -Incrementally output templates received to a gallery, based on the current filename  
43 -  
44 -When a template is received in projectUpdate for the first time since a finalize, open a new gallery based on the  
45 -template's filename, and the galleryFormat property.  
46 -  
47 -[Template](../cpp_api/template/template.md) received in projectUpdate will be output to the gallery with a filename combining their original filename and  
48 -their FrameNumber property, with the file extension specified by the fileFormat property.  
49 -  
50 -  
51 -* **file:** io/incrementaloutput.cpp  
52 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
53 -* **author(s):** [Charles Otto][caotto]  
54 -* **properties:** None  
55 -  
56 -  
57 ----  
58 -  
59 -# OpenTransform  
60 -  
61 -Applies [Format](../cpp_api/format/format.md) to [Template](../cpp_api/template/template.md) filename and appends results.  
62 -  
63 -  
64 -* **file:** io/open.cpp  
65 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
66 -* **author(s):** [Josh Klontz][jklontz]  
67 -* **properties:** None  
68 -  
69 -  
70 ----  
71 -  
72 -# OutputTransform  
73 -  
74 -DOCUMENT ME  
75 -  
76 -  
77 -* **file:** io/out.cpp  
78 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
79 -* **author(s):** [Unknown][Unknown]  
80 -* **properties:** None  
81 -  
82 -  
83 ----  
84 -  
85 -# PrintTransform  
86 -  
87 -Prints the file of the input [Template](../cpp_api/template/template.md) to stdout or stderr.  
88 -  
89 -  
90 -* **file:** io/print.cpp  
91 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
92 -* **author(s):** [Josh Klontz][jklontz]  
93 -* **properties:** None  
94 -  
95 -  
96 ----  
97 -  
98 -# ReadLandmarksTransform  
99 -  
100 -Read landmarks from a file and associate them with the correct [Template](../cpp_api/template/template.md).  
101 -  
102 -  
103 -* **file:** io/readlandmarks.cpp  
104 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
105 -* **author(s):** [Scott Klum][sklum]  
106 -* **format:** Example of the format: <pre><code>image_001.jpg:146.000000,190.000000,227.000000,186.000000,202.000000,256.000000  
107 -image_002.jpg:75.000000,235.000000,140.000000,225.000000,91.000000,300.000000  
108 -image_003.jpg:158.000000,186.000000,246.000000,188.000000,208.000000,233.000000  
109 -</code></pre>  
110 -* **properties:** None  
111 -  
112 -  
113 ----  
114 -  
115 -# ReadTransform  
116 -  
117 -Read images  
118 -  
119 -  
120 -* **file:** io/read.cpp  
121 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
122 -* **author(s):** [Josh Klontz][jklontz]  
123 -* **properties:** None  
124 -  
125 -  
126 ----  
127 -  
128 -# WriteTransform  
129 -  
130 -Write all mats to disk as images.  
131 -  
132 -  
133 -* **file:** io/write.cpp  
134 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
135 -* **author(s):** [Brendan Klare][bklare]  
136 -* **properties:** None  
137 -  
138 -  
139 ----  
140 -  
141 -# YouTubeFacesDBTransform  
142 -  
143 -Implements the YouTubesFaceDB  
144 -  
145 -  
146 -* **file:** io/youtubefacesdb.cpp  
147 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
148 -* **author(s):** [Josh Klontz][jklontz]  
149 -* **read:**  
150 -  
151 - 1. *Wolf, Lior, Tal Hassner, and Itay Maoz.*  
152 - **"Face recognition in unconstrained videos with matched background similarity."**  
153 - Computer Vision and Pattern Recognition (CVPR), 2011 IEEE Conference on. IEEE, 2011.  
154 -  
155 -* **properties:** None  
156 -  
157 -  
158 ----  
159 -  
docs/docs/api_docs/plugins/metadata.md deleted
1 -# ASEFEyesTransform  
2 -  
3 -Find eye locations using an ASEF filter  
4 -  
5 -  
6 -* **file:** metadata/eyes.cpp  
7 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
8 -* **author(s):** [Josh Klontz][jklontz]  
9 -* **read:**  
10 -  
11 - 1. *Bolme, D.S.; Draper, B.A.; Beveridge, J.R.;*  
12 - **"Average of Synthetic Exact Filters,"**  
13 - Computer Vision and Pattern Recognition, 2009. CVPR 2009. IEEE Conference on , vol., no., pp.2105-2112, 20-25 June 2009  
14 -  
15 -* **properties:** None  
16 -  
17 -  
18 ----  
19 -  
20 -# AnonymizeLandmarksTransform  
21 -  
22 -Remove a name from a point/rect  
23 -  
24 -  
25 -* **file:** metadata/anonymizelandmarks.cpp  
26 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
27 -* **author(s):** [Scott Klum][sklum]  
28 -* **properties:** None  
29 -  
30 -  
31 ----  
32 -  
33 -# AsTransform  
34 -  
35 -Change the [Template](../cpp_api/template/template.md) file extension  
36 -  
37 -  
38 -* **file:** metadata/as.cpp  
39 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
40 -* **author(s):** [Josh Klontz][jklontz]  
41 -* **properties:** None  
42 -  
43 -  
44 ----  
45 -  
46 -# AveragePointsTransform  
47 -  
48 -Averages a set of landmarks into a new landmark  
49 -  
50 -  
51 -* **file:** metadata/averagepoints.cpp  
52 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
53 -* **author(s):** [Brendan Klare][bklare]  
54 -* **properties:** None  
55 -  
56 -  
57 ----  
58 -  
59 -# CascadeTransform  
60 -  
61 -Wraps OpenCV cascade classifier  
62 -  
63 -  
64 -* **file:** metadata/cascade.cpp  
65 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
66 -* **author(s):** [Josh Klontz][jklontz], [David Crouse][dgcrouse]  
67 -* **see:** [http://docs.opencv.org/modules/objdetect/doc/cascade_classification.html](http://docs.opencv.org/modules/objdetect/doc/cascade_classification.html)  
68 -* **properties:** None  
69 -  
70 -  
71 ----  
72 -  
73 -# CheckTransform  
74 -  
75 -Checks the [Template](../cpp_api/template/template.md) for NaN values.  
76 -  
77 -  
78 -* **file:** metadata/check.cpp  
79 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
80 -* **author(s):** [Josh Klontz][jklontz]  
81 -* **properties:** None  
82 -  
83 -  
84 ----  
85 -  
86 -# ClearPointsTransform  
87 -  
88 -Clears the points from a [Template](../cpp_api/template/template.md)  
89 -  
90 -  
91 -* **file:** metadata/clearpoints.cpp  
92 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
93 -* **author(s):** [Brendan Klare][bklare]  
94 -* **properties:** None  
95 -  
96 -  
97 ----  
98 -  
99 -# ConsolidateDetectionsTransform  
100 -  
101 -Consolidate redundant/overlapping detections.  
102 -  
103 -  
104 -* **file:** metadata/consolidatedetections.cpp  
105 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
106 -* **author(s):** [Brendan Klare][bklare]  
107 -* **properties:** None  
108 -  
109 -  
110 ----  
111 -  
112 -# CropRectTransform  
113 -  
114 -Crops the width and height of a [Template](../cpp_api/template/template.md) rects by input width and height factors.  
115 -  
116 -  
117 -* **file:** metadata/croprect.cpp  
118 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
119 -* **author(s):** [Scott Klum][sklum]  
120 -* **properties:** None  
121 -  
122 -  
123 ----  
124 -  
125 -# DelaunayTransform  
126 -  
127 -Creates a Delaunay triangulation based on a set of points  
128 -  
129 -  
130 -* **file:** metadata/delaunay.cpp  
131 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
132 -* **author(s):** [Scott Klum][sklum]  
133 -* **properties:** None  
134 -  
135 -  
136 ----  
137 -  
138 -# ExpandRectTransform  
139 -  
140 -Expand the width and height of a [Template](../cpp_api/template/template.md) rects by input width and height factors.  
141 -  
142 -  
143 -* **file:** metadata/expandrect.cpp  
144 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
145 -* **author(s):** [Charles Otto][caotto]  
146 -* **properties:** None  
147 -  
148 -  
149 ----  
150 -  
151 -# ExtractMetadataTransform  
152 -  
153 -Create matrix from metadata values.  
154 -  
155 -  
156 -* **file:** metadata/extractmetadata.cpp  
157 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
158 -* **author(s):** [Josh Klontz][jklontz]  
159 -* **properties:** None  
160 -  
161 -  
162 ----  
163 -  
164 -# FaceFromEyesTransform  
165 -  
166 -Create face bounding box from two eye locations.  
167 -  
168 -  
169 -* **file:** metadata/facefromeyes.cpp  
170 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
171 -* **author(s):** [Brendan Klare][bklare]  
172 -* **properties:**  
173 -  
174 - Property | Type | Description  
175 - --- | --- | ---  
176 - widthPadding | double | Specifies what percentage of the interpupliary distance (ipd) will be padded in both horizontal directions.  
177 - verticalLocation | double | specifies where vertically the eyes are within the bounding box (0.5 would be the center).  
178 -  
179 ----  
180 -  
181 -# FileExclusionTransform  
182 -  
183 -DOCUMENT ME  
184 -  
185 -  
186 -* **file:** metadata/fileexclusion.cpp  
187 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
188 -* **author(s):** [Unknown][Unknown]  
189 -* **properties:** None  
190 -  
191 -  
192 ----  
193 -  
194 -# FilterDupeMetadataTransform  
195 -  
196 -Removes duplicate [Template](../cpp_api/template/template.md) based on a unique metadata key  
197 -  
198 -  
199 -* **file:** metadata/filterdupemetadata.cpp  
200 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
201 -* **author(s):** [Austin Blanton][imaus10]  
202 -* **properties:** None  
203 -  
204 -  
205 ----  
206 -  
207 -# GridTransform  
208 -  
209 -Add landmarks to the [Template](../cpp_api/template/template.md) in a grid layout  
210 -  
211 -  
212 -* **file:** metadata/grid.cpp  
213 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
214 -* **author(s):** [Josh Klontz][jklontz]  
215 -* **properties:** None  
216 -  
217 -  
218 ----  
219 -  
220 -# GroundTruthTransform  
221 -  
222 -Add any ground truth to the [Template](../cpp_api/template/template.md) using the file's base name.  
223 -  
224 -  
225 -* **file:** metadata/groundtruth.cpp  
226 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
227 -* **author(s):** [Josh Klontz][jklontz]  
228 -* **properties:** None  
229 -  
230 -  
231 ----  
232 -  
233 -# HOGPersonDetectorTransform  
234 -  
235 -Detects objects with OpenCV's built-in HOG detection.  
236 -  
237 -  
238 -* **file:** metadata/hogpersondetector.cpp  
239 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
240 -* **author(s):** [Austin Blanton][imaus10]  
241 -* **see:** [http://docs.opencv.org/modules/gpu/doc/object_detection.html](http://docs.opencv.org/modules/gpu/doc/object_detection.html)  
242 -* **properties:** None  
243 -  
244 -  
245 ----  
246 -  
247 -# IfMetadataTransform  
248 -  
249 -Clear [Template](../cpp_api/template/template.md) without the required metadata.  
250 -  
251 -  
252 -* **file:** metadata/ifmetadata.cpp  
253 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
254 -* **author(s):** [Josh Klontz][jklontz]  
255 -* **properties:** None  
256 -  
257 -  
258 ----  
259 -  
260 -# ImpostorUniquenessMeasureTransform  
261 -  
262 -Impostor Uniqueness Measure  
263 -  
264 -  
265 -* **file:** metadata/imposteruniquenessmeasure.cpp  
266 -* **inherits:** [Transform](../cpp_api/transform/transform.md)  
267 -* **author(s):** [Josh Klontz][jklontz]  
268 -* **properties:** None  
269 -  
270 -  
271 ----  
272 -  
273 -# JSONTransform  
274 -  
275 -Represent the metadata as JSON template data.  
276 -  
277 -  
278 -* **file:** metadata/json.cpp  
279 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
280 -* **author(s):** [Josh Klontz][jklontz]  
281 -* **properties:** None  
282 -  
283 -  
284 ----  
285 -  
286 -# KeepMetadataTransform  
287 -  
288 -Retains only the values for the keys listed, to reduce template size  
289 -  
290 -  
291 -* **file:** metadata/keepmetadata.cpp  
292 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
293 -* **author(s):** [Scott Klum][sklum]  
294 -* **properties:** None  
295 -  
296 -  
297 ----  
298 -  
299 -# KeyPointDetectorTransform  
300 -  
301 -Wraps OpenCV Key Point Detector  
302 -  
303 -  
304 -* **file:** metadata/keypointdetector.cpp  
305 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
306 -* **author(s):** [Josh Klontz][jklontz]  
307 -* **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)  
308 -* **properties:** None  
309 -  
310 -  
311 ----  
312 -  
313 -# KeyToRectTransform  
314 -  
315 -Convert values of key_X, key_Y, key_Width, key_Height to a rect.  
316 -  
317 -  
318 -* **file:** metadata/keytorect.cpp  
319 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
320 -* **author(s):** [Jordan Cheney][JordanCheney]  
321 -* **properties:** None  
322 -  
323 -  
324 ----  
325 -  
326 -# NameLandmarksTransform  
327 -  
328 -Name a point/rect  
329 -  
330 -  
331 -* **file:** metadata/namelandmarks.cpp  
332 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
333 -* **author(s):** [Scott Klum][sklum]  
334 -* **properties:** None  
335 -  
336 -  
337 ----  
338 -  
339 -# NameTransform  
340 -  
341 -Sets the [Template](../cpp_api/template/template.md) matrix data to the br::File::name.  
342 -  
343 -  
344 -* **file:** metadata/name.cpp  
345 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
346 -* **author(s):** [Josh Klontz][jklontz]  
347 -* **properties:** None  
348 -  
349 -  
350 ----  
351 -  
352 -# NormalizePointsTransform  
353 -  
354 -Normalize points to be relative to a single point  
355 -  
356 -  
357 -* **file:** metadata/normalizepoints.cpp  
358 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
359 -* **author(s):** [Scott Klum][sklum]  
360 -* **properties:** None  
361 -  
362 -  
363 ----  
364 -  
365 -# PointDisplacementTransform  
366 -  
367 -Normalize points to be relative to a single point  
368 -  
369 -  
370 -* **file:** metadata/pointdisplacement.cpp  
371 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
372 -* **author(s):** [Scott Klum][sklum]  
373 -* **properties:** None  
374 -  
375 -  
376 ----  
377 -  
378 -# PointsToMatrixTransform  
379 -  
380 -Converts either the file::points() list or a QList<QPointF> metadata item to be the template's matrix  
381 -  
382 -  
383 -* **file:** metadata/pointstomatrix.cpp  
384 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
385 -* **author(s):** [Scott Klum][sklum]  
386 -* **properties:** None  
387 -  
388 -  
389 ----  
390 -  
391 -# ProcrustesTransform  
392 -  
393 -Procrustes alignment of points  
394 -  
395 -  
396 -* **file:** metadata/procrustes.cpp  
397 -* **inherits:** [MetadataTransform](../cpp_api/metadatatransform/metadatatransform.md)  
398 -* **author(s):** [Scott Klum][sklum]  
399 -* **properties:** None  
400 -  
401 -  
402 ----  
403 -  
404 -# RectsToTemplatesTransform  
405 -  
406 -For each rectangle bounding box in src, a new [Template](../cpp_api/template/template.md) is created.  
407 -  
408 -  
409 -* **file:** metadata/rectstotemplates.cpp  
410 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
411 -* **author(s):** [Brendan Klare][bklare]  
412 -* **properties:** None  
413 -  
414 -  
415 ----  
416 -  
417 -# RegexPropertyTransform  
418 -  
419 -Apply the input regular expression to the value of inputProperty, store the matched portion in outputProperty.  
420 -  
421 -  
422 -* **file:** metadata/regexproperty.cpp  
423 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
424 -* **author(s):** [Charles Otto][caotto]  
425 -* **properties:** None  
426 -  
427 -  
428 ----  
429 -  
430 -# RemoveMetadataTransform  
431 -  
432 -Removes a metadata field from all [Template](../cpp_api/template/template.md)  
433 -  
434 -  
435 -* **file:** metadata/removemetadata.cpp  
436 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
437 -* **author(s):** [Brendan Klare][bklare]  
438 -* **properties:** None  
439 -  
440 -  
441 ----  
442 -  
443 -# RemoveTemplatesTransform  
444 -  
445 -Remove [Template](../cpp_api/template/template.md) with the specified file extension or metadata value.  
446 -  
447 -  
448 -* **file:** metadata/removetemplates.cpp  
449 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
450 -* **author(s):** [Josh Klontz][jklontz]  
451 -* **properties:** None  
452 -  
453 -  
454 ----  
455 -  
456 -# RenameFirstTransform  
457 -  
458 -Rename first found metadata key  
459 -  
460 -  
461 -* **file:** metadata/renamefirst.cpp  
462 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
463 -* **author(s):** [Josh Klontz][jklontz]  
464 -* **properties:** None  
465 -  
466 -  
467 ----  
468 -  
469 -# RenameTransform  
470 -  
471 -Rename metadata key  
472 -  
473 -  
474 -* **file:** metadata/rename.cpp  
475 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
476 -* **author(s):** [Josh Klontz][jklontz]  
477 -* **properties:** None  
478 -  
479 -  
480 ----  
481 -  
482 -# ReorderPointsTransform  
483 -  
484 -Reorder the points such that points[from[i]] becomes points[to[i]] and  
485 -vice versa  
486 -  
487 -  
488 -* **file:** metadata/reorderpoints.cpp  
489 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
490 -* **author(s):** [Scott Klum][sklum]  
491 -* **properties:** None  
492 -  
493 -  
494 ----  
495 -  
496 -# RestoreMatTransform  
497 -  
498 -Set the last matrix of the input [Template](../cpp_api/template/template.md) to a matrix stored as metadata with input propName.  
499 -  
500 -Also removes the property from the [Template](../cpp_api/template/template.md)s metadata after restoring it.  
501 -  
502 -  
503 -* **file:** metadata/restoremat.cpp  
504 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
505 -* **author(s):** [Charles Otto][caotto]  
506 -* **properties:** None  
507 -  
508 -  
509 ----  
510 -  
511 -# SaveMatTransform  
512 -  
513 -Store the last matrix of the input [Template](../cpp_api/template/template.md) as a metadata key with input property name.  
514 -  
515 -  
516 -* **file:** metadata/savemat.cpp  
517 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
518 -* **author(s):** [Charles Otto][caotto]  
519 -* **properties:** None  
520 -  
521 -  
522 ----  
523 -  
524 -# SelectPointsTransform  
525 -  
526 -Retains only landmarks/points at the provided indices  
527 -  
528 -  
529 -* **file:** metadata/selectpoints.cpp  
530 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
531 -* **author(s):** [Brendan Klare][bklare]  
532 -* **properties:** None  
533 -  
534 -  
535 ----  
536 -  
537 -# SetMetadataTransform  
538 -  
539 -Sets the metadata key/value pair.  
540 -  
541 -  
542 -* **file:** metadata/setmetadata.cpp  
543 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
544 -* **author(s):** [Josh Klontz][jklontz]  
545 -* **properties:** None  
546 -  
547 -  
548 ----  
549 -  
550 -# SetPointsInRectTransform  
551 -  
552 -Set points relative to a rect  
553 -  
554 -  
555 -* **file:** metadata/setpointsinrect.cpp  
556 -* **inherits:** [UntrainableMetadataTransform](../cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md)  
557 -* **author(s):** [Jordan Cheney][JordanCheney]  
558 -* **properties:** None  
559 -  
560 -  
561 ----  
562 -  
563 -# StasmTransform  
564 -  
565 -Wraps STASM key point detector  
566 -  
567 -  
568 -* **file:** metadata/stasm4.cpp  
569 -* **inherits:** [UntrainableTransform](../cpp_api/untrainabletransform/untrainabletransform.md)  
570 -* **author(s):** [Scott Klum][sklum]  
571 -* **properties:** None  
572 -  
573 -  
574 ----  
575 -  
576 -# StopWatchTransform  
577 -  
578 -Gives time elapsed over a specified [Transform](../cpp_api/transform/transform.md) as a function of both images (or frames) and pixels.  
579 -  
580 -  
581 -* **file:** metadata/stopwatch.cpp  
582 -* **inherits:** [MetaTransform](../cpp_api/metatransform/metatransform.md)  
583 -* **author(s):** [Jordan Cheney][JordanCheney], [Josh Klontz][jklontz]  
584 -* **properties:** None  
585 -  
586 -  
587 ----  
588 -  
docs/docs/api_docs/plugins/output.md deleted
1 -# DefaultOutput  
2 -  
3 -Adaptor class -- write a matrix output using [Format](../cpp_api/format/format.md) classes.  
4 -  
5 -  
6 -* **file:** output/default.cpp  
7 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
8 -* **author(s):** [Charles Otto][caotto]  
9 -* **properties:** None  
10 -  
11 -  
12 ----  
13 -  
14 -# EmptyOutput  
15 -  
16 -Output to the terminal.  
17 -  
18 -  
19 -* **file:** output/empty.cpp  
20 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
21 -* **author(s):** [Josh Klontz][jklontz]  
22 -* **properties:** None  
23 -  
24 -  
25 ----  
26 -  
27 -# bestOutput  
28 -  
29 -The highest scoring matches.  
30 -  
31 -  
32 -* **file:** output/best.cpp  
33 -* **inherits:** [Output](../cpp_api/output/output.md)  
34 -* **author(s):** [Josh Klontz][jklontz]  
35 -* **properties:** None  
36 -  
37 -  
38 ----  
39 -  
40 -# csvOutput  
41 -  
42 -Comma separated values output.  
43 -  
44 -  
45 -* **file:** output/csv.cpp  
46 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
47 -* **author(s):** [Josh Klontz][jklontz]  
48 -* **properties:** None  
49 -  
50 -  
51 ----  
52 -  
53 -# evalOutput  
54 -  
55 -Evaluate the output matrix.  
56 -  
57 -  
58 -* **file:** output/eval.cpp  
59 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
60 -* **author(s):** [Josh Klontz][jklontz]  
61 -* **properties:** None  
62 -  
63 -  
64 ----  
65 -  
66 -# heatOutput  
67 -  
68 -Matrix-like output for heat maps.  
69 -  
70 -  
71 -* **file:** output/heat.cpp  
72 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
73 -* **author(s):** [Scott Klum][sklum]  
74 -* **properties:** None  
75 -  
76 -  
77 ----  
78 -  
79 -# histOutput  
80 -  
81 -Score histogram.  
82 -  
83 -  
84 -* **file:** output/hist.cpp  
85 -* **inherits:** [Output](../cpp_api/output/output.md)  
86 -* **author(s):** [Josh Klontz][jklontz]  
87 -* **properties:** None  
88 -  
89 -  
90 ----  
91 -  
92 -# meltOutput  
93 -  
94 -One score per row.  
95 -  
96 -  
97 -* **file:** output/melt.cpp  
98 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
99 -* **author(s):** [Josh Klontz][jklontz]  
100 -* **properties:** None  
101 -  
102 -  
103 ----  
104 -  
105 -# mtxOutput  
106 -  
107 -simmat output.  
108 -  
109 -  
110 -* **file:** output/mtx.cpp  
111 -* **inherits:** [Output](../cpp_api/output/output.md)  
112 -* **author(s):** [Josh Klontz][jklontz]  
113 -* **properties:** None  
114 -  
115 -  
116 ----  
117 -  
118 -# nullOutput  
119 -  
120 -Discards the scores.  
121 -  
122 -  
123 -* **file:** output/null.cpp  
124 -* **inherits:** [Output](../cpp_api/output/output.md)  
125 -* **author(s):** [Josh Klontz][jklontz]  
126 -* **properties:** None  
127 -  
128 -  
129 ----  
130 -  
131 -# rankOutput  
132 -  
133 -Outputs highest ranked matches with scores.  
134 -  
135 -  
136 -* **file:** output/rank.cpp  
137 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
138 -* **author(s):** [Scott Klum][sklum]  
139 -* **properties:** None  
140 -  
141 -  
142 ----  
143 -  
144 -# rrOutput  
145 -  
146 -Rank retrieval output.  
147 -  
148 -  
149 -* **file:** output/rr.cpp  
150 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
151 -* **author(s):** [Josh Klontz][jklontz], [Scott Klum][sklum]  
152 -* **properties:** None  
153 -  
154 -  
155 ----  
156 -  
157 -# tailOutput  
158 -  
159 -The highest scoring matches.  
160 -  
161 -  
162 -* **file:** output/tail.cpp  
163 -* **inherits:** [Output](../cpp_api/output/output.md)  
164 -* **author(s):** [Josh Klontz][jklontz]  
165 -* **properties:** None  
166 -  
167 -  
168 ----  
169 -  
170 -# txtOutput  
171 -  
172 -Text file output.  
173 -  
174 -  
175 -* **file:** output/txt.cpp  
176 -* **inherits:** [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)  
177 -* **author(s):** [Josh Klontz][jklontz]  
178 -* **properties:** None  
179 -  
180 -  
181 ----  
182 -  
docs/docs/api_docs/plugins/video.md deleted
1 -# AggregateFrames  
2 -  
3 -Passes along n sequential frames to the next [Transform](../cpp_api/transform/transform.md).  
4 -  
5 -For a video with m frames, AggregateFrames would create a total of m-n+1 sequences ([0,n] ... [m-n+1, m])  
6 -  
7 -  
8 -* **file:** video/aggregate.cpp  
9 -* **inherits:** [TimeVaryingTransform](../cpp_api/timevaryingtransform/timevaryingtransform.md)  
10 -* **author(s):** [Josh Klontz][jklontz]  
11 -* **properties:** None  
12 -  
13 -  
14 ----  
15 -  
16 -# DropFrames  
17 -  
18 -Only use one frame every n frames.  
19 -  
20 -  
21 -* **file:** video/drop.cpp  
22 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
23 -* **author(s):** [Austin Blanton][imaus10  
24 -  
25 - For a video with m frames, DropFrames will pass on m/n frames.]  
26 -* **properties:** None  
27 -  
28 -  
29 ----  
30 -  
31 -# OpticalFlowTransform  
32 -  
33 -Gets a one-channel dense optical flow from two images  
34 -  
35 -  
36 -* **file:** video/opticalflow.cpp  
37 -* **inherits:** [UntrainableMetaTransform](../cpp_api/untrainablemetatransform/untrainablemetatransform.md)  
38 -* **author(s):** [Austin Blanton][imaus10]  
39 -* **properties:** None  
40 -  
41 -  
42 ----  
43 -