Peter M. Groen / openbr

Commit 0bdd44556167678fb3d494d79e5bb21c99ea8925

Authored by Jordan Cheney
1 parent 1a784fc2

Tabs => Spaces. Removed empty file and unused scripts

Inline Side-by-side
Showing 44 changed files with 692 additions and 909 deletions
docs/docs/api_docs/c_api.md
  View file @0bdd445
... ... @@ -25,4 +25,4 @@ To use the API in your project use-
25 25  
26 26 share/openbr/cmake/OpenBRConfig.cmake
27 27  
28   -Please see the [tutorials](../tutorials.md) section for examples.
29 28 \ No newline at end of file
  29 +Please see the [tutorials](../tutorials.md) section for examples.
... ...
docs/docs/api_docs/c_api/functions.md
  View file @0bdd445
... ... @@ -4,7 +4,7 @@ Calls [Context](../cpp_api/context/context.md)::[about](../cpp_api/context/stati
4 4  
5 5 * **function definition:**
6 6  
7   - const char *br_about()
  7 + const char *br_about()
8 8  
9 9 * **parameters:** None
10 10 * **output:** (const char *) Returns a string describing OpenBR
... ... @@ -18,15 +18,15 @@ Concatenates a list of galleries into 1 gallery.
18 18  
19 19 * **function definition:**
20 20  
21   - void br_cat(int num_input_galleries, const char *input_galleries[], const char *output_gallery)
  21 + void br_cat(int num_input_galleries, const char *input_galleries[], const char *output_gallery)
22 22  
23 23 * **parameters:**
24 24  
25   - Parameter | Type | Description
26   - --- | --- | ---
27   - num_input_galleries | int | Size of input_galleries
28   - input_galleries[] | const char * | List of galleries
29   - output_gallery | const char * | Pointer to store concatenated gallery
  25 + Parameter | Type | Description
  26 + --- | --- | ---
  27 + num_input_galleries | int | Size of input_galleries
  28 + input_galleries[] | const char * | List of galleries
  29 + output_gallery | const char * | Pointer to store concatenated gallery
30 30  
31 31 * **output:** void
32 32 * **see:** [Cat](../cpp_api/apifunctions.md#cat)
... ... @@ -39,15 +39,15 @@ Removes duplicate [templates](../cpp_api/template/template.md) in a [gallery](..
39 39  
40 40 * **function definition:**
41 41  
42   - void br_deduplicate(const char *input_gallery, const char *output_gallery, const char *threshold)
  42 + void br_deduplicate(const char *input_gallery, const char *output_gallery, const char *threshold)
43 43  
44 44 * **parameters:**
45 45  
46   - Parameter | Type | Description
47   - --- | --- | ---
48   - input_gallery | const char * | Gallery to be deduplicated
49   - output_gallery | const char * | Deduplicated gallery
50   - threshold | const char * | Comparisons with a match score >= this value are designated to be duplicates.
  46 + Parameter | Type | Description
  47 + --- | --- | ---
  48 + input_gallery | const char * | Gallery to be deduplicated
  49 + output_gallery | const char * | Deduplicated gallery
  50 + threshold | const char * | Comparisons with a match score >= this value are designated to be duplicates.
51 51  
52 52 * **output:** (void)
53 53  
... ... @@ -59,16 +59,16 @@ Clusters one or more similarity matrices into a list of subjects. A [similarity
59 59  
60 60 * **function definition:**
61 61  
62   - void br_cluster(int num_simmats, const char *simmats[], float aggressiveness, const char *csv)
  62 + void br_cluster(int num_simmats, const char *simmats[], float aggressiveness, const char *csv)
63 63  
64 64 * **parameters:**
65 65  
66   - Parameter | Type | Description
67   - --- | --- | ---
68   - num_simmats | int | Size of **simmats**
69   - simmats[] | const char * | Array of [simmat](../../tutorials.md#the-evaluation-harness) composing one large self-similarity matrix arranged in row major order.
70   - aggressiveness | float | The higher the aggressiveness the larger the clusters. Suggested range is [0,10]
71   - csv | const char * | The cluster results file to generate. Results are stored one row per cluster and use gallery indices.
  66 + Parameter | Type | Description
  67 + --- | --- | ---
  68 + num_simmats | int | Size of **simmats**
  69 + simmats[] | const char * | Array of [simmat](../../tutorials.md#the-evaluation-harness) composing one large self-similarity matrix arranged in row major order.
  70 + aggressiveness | float | The higher the aggressiveness the larger the clusters. Suggested range is [0,10]
  71 + csv | const char * | The cluster results file to generate. Results are stored one row per cluster and use gallery indices.
72 72  
73 73 * **output:** (void)
74 74  
... ... @@ -80,16 +80,16 @@ Combines several equal-sized mask matrices. A comparison may not be simultaneous
80 80  
81 81 * **function definition:**
82 82  
83   - void br_combine_masks(int num_input_masks, const char *input_masks[], const char *output_mask, const char *method)
  83 + void br_combine_masks(int num_input_masks, const char *input_masks[], const char *output_mask, const char *method)
84 84  
85 85 * **parameters:**
86 86  
87   - Parameter | Type | Description
88   - --- | --- | ---
89   - num_input_masks | int | Size of **input_masks**
90   - input_masks[] | const char * | Array of [mask matrices](../../tutorials.md#the-evaluation-harness) to combine. All matrices must have the same dimensions.
91   - output_mask | const char * | The file to contain the resulting [mask matrix](../../tutorials.md#the-evaluation-harness)
92   - method | const char * | Possible values are: <ul><li>And - Ignore comparison if *any* input masks ignore.</li> <li>Or - Ignore comparison if *all* input masks ignore.</li></ul>
  87 + Parameter | Type | Description
  88 + --- | --- | ---
  89 + num_input_masks | int | Size of **input_masks**
  90 + input_masks[] | const char * | Array of [mask matrices](../../tutorials.md#the-evaluation-harness) to combine. All matrices must have the same dimensions.
  91 + output_mask | const char * | The file to contain the resulting [mask matrix](../../tutorials.md#the-evaluation-harness)
  92 + method | const char * | Possible values are: <ul><li>And - Ignore comparison if *any* input masks ignore.</li> <li>Or - Ignore comparison if *all* input masks ignore.</li></ul>
93 93  
94 94 * **see:** [br_make_mask](#br_make_mask)
95 95  
... ... @@ -101,15 +101,15 @@ Compares each [Template](../cpp_api/template/template.md) in the query [Gallery]
101 101  
102 102 * **function definition:**
103 103  
104   - void br_compare(const char *target_gallery, const char *query_gallery, const char *output = "")
  104 + void br_compare(const char *target_gallery, const char *query_gallery, const char *output = "")
105 105  
106 106 * **parameters:**
107 107  
108   - Parameter | Type | Description
109   - --- | --- | ---
110   - target_gallery | const char * | target_gallery The [Gallery](../cpp_api/gallery/gallery.md) file whose templates make up the columns of the output.
111   - query_gallery | const char * | The [Gallery](../cpp_api/gallery/gallery.md) file whose templates make up the rows of the output. A value of '.' reuses the target gallery as the query gallery.
112   - output | const char * | (Optional) The [Output](../cpp_api/output/output.md) file to contain the results of comparing the templates. The default behavior is to print scores to the terminal.
  108 + Parameter | Type | Description
  109 + --- | --- | ---
  110 + target_gallery | const char * | target_gallery The [Gallery](../cpp_api/gallery/gallery.md) file whose templates make up the columns of the output.
  111 + query_gallery | const char * | The [Gallery](../cpp_api/gallery/gallery.md) file whose templates make up the rows of the output. A value of '.' reuses the target gallery as the query gallery.
  112 + output | const char * | (Optional) The [Output](../cpp_api/output/output.md) file to contain the results of comparing the templates. The default behavior is to print scores to the terminal.
113 113  
114 114 * **output:** (void)
115 115 * **see:** br_enroll
... ... @@ -122,16 +122,16 @@ Convenience function for comparing to multiple targets.
122 122  
123 123 * **function definition:**
124 124  
125   - void br_compare_n(int num_targets, const char *target_galleries[], const char *query_gallery, const char *output)
  125 + void br_compare_n(int num_targets, const char *target_galleries[], const char *query_gallery, const char *output)
126 126  
127 127 * **parameters:**
128 128  
129   - Parameter | Type | Description
130   - --- | --- | ---
131   - num_targets | int | Size of **target_galleries**
132   - target_galleries[] | const char * | Target galleries to compare against
133   - query_gallery | const char * | query gallery for comparison.
134   - output | const char * | (Optional) [Output](../cpp_api/output/output.md) file to contain the results of comparing the templates. The default behavior is to print scores to the terminal.
  129 + Parameter | Type | Description
  130 + --- | --- | ---
  131 + num_targets | int | Size of **target_galleries**
  132 + target_galleries[] | const char * | Target galleries to compare against
  133 + query_gallery | const char * | query gallery for comparison.
  134 + output | const char * | (Optional) [Output](../cpp_api/output/output.md) file to contain the results of comparing the templates. The default behavior is to print scores to the terminal.
135 135  
136 136 * **output:** (void)
137 137 * **see:** br_compare
... ... @@ -144,15 +144,15 @@ DOCUMENT ME!
144 144  
145 145 * **function definition:**
146 146  
147   - void br_pairwise_compare(const char *target_gallery, const char *query_gallery, const char *output = "")
  147 + void br_pairwise_compare(const char *target_gallery, const char *query_gallery, const char *output = "")
148 148  
149 149 * **parameters:**
150 150  
151   - Parameter | Type | Description
152   - --- | --- | ---
153   - target_gallery | const char * | DOCUMENT ME
154   - query_gallery | const char * | DOCUMENT ME
155   - output | const char * | DOCUMENT ME
  151 + Parameter | Type | Description
  152 + --- | --- | ---
  153 + target_gallery | const char * | DOCUMENT ME
  154 + query_gallery | const char * | DOCUMENT ME
  155 + output | const char * | DOCUMENT ME
156 156  
157 157 * **output:** (void)
158 158  
... ... @@ -164,15 +164,15 @@ Convert a file to a different type. Files can only be converted to types within
164 164  
165 165 * **function definition:**
166 166  
167   - void br_convert(const char *file_type, const char *input_file, const char *output_file)
  167 + void br_convert(const char *file_type, const char *input_file, const char *output_file)
168 168  
169 169 * **parameters:**
170 170  
171   - Parameter | Type | Description
172   - --- | --- | ---
173   - file_type | const char * | Type of file to convert. Options are [Format](../cpp_api/format/format.md), [Gallery](../cpp_api/gallery/gallery.md) or [Output](../cpp_api/output/output.md).
174   - input_file | const char * | File to convert.
175   - output_file | const char * | Output file. Type is determined by the file extension.
  171 + Parameter | Type | Description
  172 + --- | --- | ---
  173 + file_type | const char * | Type of file to convert. Options are [Format](../cpp_api/format/format.md), [Gallery](../cpp_api/gallery/gallery.md) or [Output](../cpp_api/output/output.md).
  174 + input_file | const char * | File to convert.
  175 + output_file | const char * | Output file. Type is determined by the file extension.
176 176  
177 177 * **output:** (void)
178 178  
... ... @@ -184,14 +184,14 @@ Constructs [Template(s)](../cpp_api/template/template.md) from an input.
184 184  
185 185 * **function definition:**
186 186  
187   - void br_enroll(const char *input, const char *gallery = "")
  187 + void br_enroll(const char *input, const char *gallery = "")
188 188  
189 189 * **parameters:**
190 190  
191   - Parameter | Type | Description
192   - --- | --- | ---
193   - input | const char * | The [format](../cpp_api/format/format.md) or [gallery](../cpp_api/gallery/gallery.md) to enroll.
194   - gallery | const char * | (Optional) The [Gallery](../cpp_api/gallery/gallery.md) file to contain the enrolled templates. By default the gallery will be held in memory and *input* can used as a gallery in [br_compare](#br_compare)
  191 + Parameter | Type | Description
  192 + --- | --- | ---
  193 + input | const char * | The [format](../cpp_api/format/format.md) or [gallery](../cpp_api/gallery/gallery.md) to enroll.
  194 + gallery | const char * | (Optional) The [Gallery](../cpp_api/gallery/gallery.md) file to contain the enrolled templates. By default the gallery will be held in memory and *input* can used as a gallery in [br_compare](#br_compare)
195 195  
196 196 * **output:** (void)
197 197 * **see:** [br_enroll_n](#br_enroll_n)
... ... @@ -204,15 +204,15 @@ Convenience function for enrolling multiple inputs.
204 204  
205 205 * **function definition:**
206 206  
207   - void br_enroll_n(int num_inputs, const char *inputs[], const char *gallery = "")
  207 + void br_enroll_n(int num_inputs, const char *inputs[], const char *gallery = "")
208 208  
209 209 * **parameters:**
210 210  
211   - Parameter | Type | Description
212   - --- | --- | ---
213   - num_inputs | int | Size of **inputs**.
214   - inputs[] | const char * | Array of inputs to enroll.
215   - gallery | const char * | (Optional) The [Gallery](../cpp_api/gallery/gallery.md) file to contain the enroll templates.
  211 + Parameter | Type | Description
  212 + --- | --- | ---
  213 + num_inputs | int | Size of **inputs**.
  214 + inputs[] | const char * | Array of inputs to enroll.
  215 + gallery | const char * | (Optional) The [Gallery](../cpp_api/gallery/gallery.md) file to contain the enroll templates.
216 216  
217 217 * **output:** (void)
218 218 * **see:** [br_enroll](#br_enroll)
... ... @@ -225,14 +225,14 @@ A naive alternative to [br_enroll](#br_enroll).
225 225  
226 226 * **function definition:**
227 227  
228   - void br_project(const char *input, const char *output)
  228 + void br_project(const char *input, const char *output)
229 229  
230 230 * **parameters:**
231 231  
232   - Parameter | Type | Description
233   - --- | --- | ---
234   - input | const char * | The [format](../cpp_api/format/format.md) or [gallery](../cpp_api/gallery/gallery.md) to enroll.
235   - output | const char * | The [Gallery](../cpp_api/gallery/gallery.md) file to contain the enrolled templates. By default the gallery will be held in memory and *input* can used as a gallery in [br_compare](#br_compare)
  232 + Parameter | Type | Description
  233 + --- | --- | ---
  234 + input | const char * | The [format](../cpp_api/format/format.md) or [gallery](../cpp_api/gallery/gallery.md) to enroll.
  235 + output | const char * | The [Gallery](../cpp_api/gallery/gallery.md) file to contain the enrolled templates. By default the gallery will be held in memory and *input* can used as a gallery in [br_compare](#br_compare)
236 236  
237 237 * **output:** (void)
238 238 * **see:** [br_enroll](#br_enroll)
... ... @@ -245,16 +245,16 @@ Creates a **.csv** file containing performance metrics from evaluating the simil
245 245  
246 246 * **function defintion:**
247 247  
248   - float br_eval(const char *simmat, const char *mask, const char *csv = "", int matches = 0)
  248 + float br_eval(const char *simmat, const char *mask, const char *csv = "", int matches = 0)
249 249  
250 250 * **parameters:**
251 251  
252   - Parameter | Type | Description
253   - --- | --- | ---
254   - simmat | const char * | The [simmat](../../tutorials.md#the-evaluation-harness) to use
255   - mask | const char * | The [mask](../../tutorials.md#the-evaluation-harness) to use.
256   - csv | const char * | (Optional) The **.csv** file to contain performance metrics.
257   - matches | int | (Optional) An integer number of matches to output around the EER. Default is 0.
  252 + Parameter | Type | Description
  253 + --- | --- | ---
  254 + simmat | const char * | The [simmat](../../tutorials.md#the-evaluation-harness) to use
  255 + mask | const char * | The [mask](../../tutorials.md#the-evaluation-harness) to use.
  256 + csv | const char * | (Optional) The **.csv** file to contain performance metrics.
  257 + matches | int | (Optional) An integer number of matches to output around the EER. Default is 0.
258 258  
259 259 * **output:** (float) Returns the true accept rate (TAR) at a false accept rate (FAR) of one in one thousand
260 260 * **see:** [br_plot](#br_plot)
... ... @@ -267,15 +267,15 @@ Evaluates the similarity matrix using the mask matrix. Function aborts if TAR @
267 267  
268 268 * **function definition:**
269 269  
270   - void br_assert_eval(const char *simmat, const char *mask, const float accuracy)
  270 + void br_assert_eval(const char *simmat, const char *mask, const float accuracy)
271 271  
272 272 * **parameters:**
273 273  
274   - Parameter | Type | Description
275   - --- | --- | ---
276   - simmat | const char * | The [simmat](../../tutorials.md#the-evaluation-harness) to use
277   - mask | const char * | The [mask](../../tutorials.md#the-evaluation-harness)
278   - accuracy | const float | Desired true accept rate at false accept rate of one in one thousand.
  274 + Parameter | Type | Description
  275 + --- | --- | ---
  276 + simmat | const char * | The [simmat](../../tutorials.md#the-evaluation-harness) to use
  277 + mask | const char * | The [mask](../../tutorials.md#the-evaluation-harness)
  278 + accuracy | const float | Desired true accept rate at false accept rate of one in one thousand.
279 279  
280 280 * **output:** (void)
281 281  
... ... @@ -287,16 +287,16 @@ Creates a **.csv** file containing performance metrics from evaluating the simil
287 287  
288 288 * **function definition:**
289 289  
290   - float br_inplace_eval(const char * simmat, const char *target, const char *query, const char *csv = "")
  290 + float br_inplace_eval(const char * simmat, const char *target, const char *query, const char *csv = "")
291 291  
292 292 * **parameters:**
293 293  
294   - Parameter | Type | Description
295   - --- | --- | ---
296   - simmat | const char * | The [simmat](../../tutorials.md#the-evaluation-harness)
297   - target | const char * | The name of a gallery containing metadata for the target set.
298   - query | const char * | The name of a gallery containing metadata for the query set.
299   - csv | const char * | (Optional) The **.csv** file to contain performance metrics.
  294 + Parameter | Type | Description
  295 + --- | --- | ---
  296 + simmat | const char * | The [simmat](../../tutorials.md#the-evaluation-harness)
  297 + target | const char * | The name of a gallery containing metadata for the target set.
  298 + query | const char * | The name of a gallery containing metadata for the query set.
  299 + csv | const char * | (Optional) The **.csv** file to contain performance metrics.
300 300  
301 301 * **output:** (float) Returns the true accept rate (TAR) at a false accept rate (FAR) of one in one thousand
302 302 * **see:** [br_plot](#br_plot)
... ... @@ -309,16 +309,16 @@ Evaluates and prints classification accuracy to terminal.
309 309  
310 310 * **function definition:**
311 311  
312   - void br_eval_classification(const char *predicted_gallery, const char *truth_gallery, const char *predicted_property = "", const char *truth_property = "")
  312 + void br_eval_classification(const char *predicted_gallery, const char *truth_gallery, const char *predicted_property = "", const char *truth_property = "")
313 313  
314 314 * **parameters:**
315 315  
316   - Parameter | Type | Description
317   - --- | --- | ---
318   - predicted_gallery | const char * | The predicted [Gallery](../cpp_api/gallery/gallery.md).
319   - truth_gallery | const char * | The ground truth [Gallery](../cpp_api/gallery/gallery.md).
320   - predicted_property | const char * | (Optional) Which metadata key to use from the **predicted_gallery**.
321   - truth_property | const char * | (Optional) Which metadata key to use from the **truth_gallery**.
  316 + Parameter | Type | Description
  317 + --- | --- | ---
  318 + predicted_gallery | const char * | The predicted [Gallery](../cpp_api/gallery/gallery.md).
  319 + truth_gallery | const char * | The ground truth [Gallery](../cpp_api/gallery/gallery.md).
  320 + predicted_property | const char * | (Optional) Which metadata key to use from the **predicted_gallery**.
  321 + truth_property | const char * | (Optional) Which metadata key to use from the **truth_gallery**.
322 322  
323 323 * **output:** (void)
324 324  
... ... @@ -330,7 +330,7 @@ Evaluates and prints clustering accuracy to the terminal.
330 330  
331 331 * **function definition:**
332 332  
333   - void br_eval_clustering(const char *csv, const char *gallery, const char * truth_property)
  333 + void br_eval_clustering(const char *csv, const char *gallery, const char * truth_property)
334 334  
335 335 * **parameters:**
336 336  
... ... @@ -350,18 +350,18 @@ Evaluates and prints detection accuracy to terminal.
350 350  
351 351 * **function definition:**
352 352  
353   - float br_eval_detection(const char *predicted_gallery, const char *truth_gallery, const char *csv = "", bool normalize = false, int minSize = 0, int maxSize = 0)
  353 + float br_eval_detection(const char *predicted_gallery, const char *truth_gallery, const char *csv = "", bool normalize = false, int minSize = 0, int maxSize = 0)
354 354  
355 355 * **parameters:**
356 356  
357   - Parameter | Type | Description
358   - --- | --- | ---
359   - predicted_gallery | const char * | The predicted [Gallery](../cpp_api/gallery/gallery.md).
360   - truth_gallery | const char * | The ground truth [Gallery](../cpp_api/gallery/gallery.md).
361   - csv | const char * | (Optional) The **.csv** file to contain performance metrics.
362   - normalize | bool | (Optional) Flag to normalize predicted bounding boxes for improved detection. Defaults to false.
363   - minSize | int | (Optional) Minimum size of faces to be considered in the evaluation. Size is applied to predicted and ground truth galleries. Defaults to -1 (no minimum size).
364   - maxSize | int | (Optional) Maximum size if faces to be considered in the evaluation. Size is applied to predicted and ground truth galleries. Defaults to -1 (no maximum size).
  357 + Parameter | Type | Description
  358 + --- | --- | ---
  359 + predicted_gallery | const char * | The predicted [Gallery](../cpp_api/gallery/gallery.md).
  360 + truth_gallery | const char * | The ground truth [Gallery](../cpp_api/gallery/gallery.md).
  361 + csv | const char * | (Optional) The **.csv** file to contain performance metrics.
  362 + normalize | bool | (Optional) Flag to normalize predicted bounding boxes for improved detection. Defaults to false.
  363 + minSize | int | (Optional) Minimum size of faces to be considered in the evaluation. Size is applied to predicted and ground truth galleries. Defaults to -1 (no minimum size).
  364 + maxSize | int | (Optional) Maximum size if faces to be considered in the evaluation. Size is applied to predicted and ground truth galleries. Defaults to -1 (no maximum size).
365 365  
366 366 * **output:** (float) Returns the true accept rate (TAR) at a false accept rate (FAR) of one in one thousand
367 367  
... ... @@ -373,19 +373,19 @@ Evaluates and prints landmarking accuracy to terminal.
373 373  
374 374 * **function definition:**
375 375  
376   - float br_eval_landmarking(const char *predicted_gallery, const char *truth_gallery, const char *csv = "", int normalization_index_a = 0, int normalization_index_b = 1, int sample_index = 0, int total_examples = 5)
  376 + float br_eval_landmarking(const char *predicted_gallery, const char *truth_gallery, const char *csv = "", int normalization_index_a = 0, int normalization_index_b = 1, int sample_index = 0, int total_examples = 5)
377 377  
378 378 * **parameters:**
379 379  
380   - Parameter | Type | Description
381   - --- | --- | ---
382   - predicted_gallery | const char * | The predicted [Gallery](../cpp_api/gallery/gallery.md).
383   - truth_gallery | const char * | The ground truth [Gallery](../cpp_api/gallery/gallery.md).
384   - csv | const char * | (Optional) The **.csv** file to contain performance metrics.
385   - normalization_index_a | int | (Optional) The first index in the list of points to use for normalization. Default is 0.
386   - normalization_index_b | int | (Optional) The second index in the list of points to use for normalization. Default is 1.
387   - sample_index | int | (Optional) The index for sample landmark image in ground truth gallery. Default = 0.
388   - total_examples | int | (Optional) The number of accurate and inaccurate examples to display. Default is 5.
  380 + Parameter | Type | Description
  381 + --- | --- | ---
  382 + predicted_gallery | const char * | The predicted [Gallery](../cpp_api/gallery/gallery.md).
  383 + truth_gallery | const char * | The ground truth [Gallery](../cpp_api/gallery/gallery.md).
  384 + csv | const char * | (Optional) The **.csv** file to contain performance metrics.
  385 + normalization_index_a | int | (Optional) The first index in the list of points to use for normalization. Default is 0.
  386 + normalization_index_b | int | (Optional) The second index in the list of points to use for normalization. Default is 1.
  387 + sample_index | int | (Optional) The index for sample landmark image in ground truth gallery. Default = 0.
  388 + total_examples | int | (Optional) The number of accurate and inaccurate examples to display. Default is 5.
389 389  
390 390 * **output:** (float) Returns the true accept rate (TAR) at a false accept rate (FAR) of one in one thousand
391 391  
... ... @@ -397,16 +397,16 @@ Evaluates regression accuracy to disk.
397 397  
398 398 * **function definition:**
399 399  
400   - void br_eval_regression(const char *predicted_gallery, const char *truth_gallery, const char *predicted_property = "", const char *truth_property = "")
  400 + void br_eval_regression(const char *predicted_gallery, const char *truth_gallery, const char *predicted_property = "", const char *truth_property = "")
401 401  
402 402 * **parameters:**
403 403  
404   - Parameter | Type | Description
405   - --- | --- | ---
406   - predicted_gallery | const char * | The predicted [Gallery](../cpp_api/gallery/gallery.md)
407   - truth_gallery | const char * | The ground truth [Gallery](../cpp_api/gallery/gallery.md)
408   - predicted_property | const char * | (Optional) Which metadata key to use from **predicted_gallery**.
409   - truth_property | const char * | (Optional) Which metadata key to use from **truth_gallery**.
  404 + Parameter | Type | Description
  405 + --- | --- | ---
  406 + predicted_gallery | const char * | The predicted [Gallery](../cpp_api/gallery/gallery.md)
  407 + truth_gallery | const char * | The ground truth [Gallery](../cpp_api/gallery/gallery.md)
  408 + predicted_property | const char * | (Optional) Which metadata key to use from **predicted_gallery**.
  409 + truth_property | const char * | (Optional) Which metadata key to use from **truth_gallery**.
410 410  
411 411 * **output:** (void)
412 412  
... ... @@ -418,17 +418,17 @@ Perform score level fusion on similarity matrices.
418 418  
419 419 * **function definition:**
420 420  
421   - void br_fuse(int num_input_simmats, const char *input_simmats[], const char *normalization, const char *fusion, const char *output_simmat)
  421 + void br_fuse(int num_input_simmats, const char *input_simmats[], const char *normalization, const char *fusion, const char *output_simmat)
422 422  
423 423 * **parameters:**
424 424  
425   - Parameter | Type | Description
426   - --- | --- | ---
427   - num_input_simmats | int | Size of **input_simmats**.
428   - input_simmats[] | const char * | Array of [simmats](../../tutorials.md#the-evaluation-harness). All simmats must have the same dimensions.
429   - normalization | const char * | Valid options are: <ul> <li>None - No score normalization.</li> <li>MinMax - Scores normalized to [0,1].</li> <li>ZScore - Scores normalized to a standard normal curve.</li> </ul>
430   - fusion | const char * | Valid options are: <ul> <li>Min - Uses the minimum score.</li> <li>Max - Uses the maximum score.</li> <li>Sum - Sums the scores. Sums can also be weighted: <tt>SumW1:W2:...:Wn</tt>.</li> <li>Replace - Replaces scores in the first matrix with scores in the second matrix when the mask is set.</li> </ul>
431   - output_simmat | const char * | [Simmat](../../tutorials.md#the-evaluation-harness) to contain the fused scores.
  425 + Parameter | Type | Description
  426 + --- | --- | ---
  427 + num_input_simmats | int | Size of **input_simmats**.
  428 + input_simmats[] | const char * | Array of [simmats](../../tutorials.md#the-evaluation-harness). All simmats must have the same dimensions.
  429 + normalization | const char * | Valid options are: <ul> <li>None - No score normalization.</li> <li>MinMax - Scores normalized to [0,1].</li> <li>ZScore - Scores normalized to a standard normal curve.</li> </ul>
  430 + fusion | const char * | Valid options are: <ul> <li>Min - Uses the minimum score.</li> <li>Max - Uses the maximum score.</li> <li>Sum - Sums the scores. Sums can also be weighted: <tt>SumW1:W2:...:Wn</tt>.</li> <li>Replace - Replaces scores in the first matrix with scores in the second matrix when the mask is set.</li> </ul>
  431 + output_simmat | const char * | [Simmat](../../tutorials.md#the-evaluation-harness) to contain the fused scores.
432 432  
433 433 * **output:** (void)
434 434  
... ... @@ -440,16 +440,16 @@ Initializes the [Context](../cpp_api/context/context.md). Required at the beginn
440 440  
441 441 * **function definition:**
442 442  
443   - void br_initialize(int &argc, char *argv[], const char *sdk_path = "", bool use_gui = false)
  443 + void br_initialize(int &argc, char *argv[], const char *sdk_path = "", bool use_gui = false)
444 444  
445 445 * **parameters:**
446 446  
447   - Parameter | Type | Description
448   - --- | --- | ---
449   - argc | int | Number of command line arguments.
450   - argv[] | char * | Array of command line arguments.
451   - sdk_path | const char * | (Optional) Path to the OpenBR sdk. If no path is provided OpenBR will try and find the sdk automatically.
452   - use_gui | bool | (Optional) Enable OpenBR to use make GUI windows. Default is false.
  447 + Parameter | Type | Description
  448 + --- | --- | ---
  449 + argc | int | Number of command line arguments.
  450 + argv[] | char * | Array of command line arguments.
  451 + sdk_path | const char * | (Optional) Path to the OpenBR sdk. If no path is provided OpenBR will try and find the sdk automatically.
  452 + use_gui | bool | (Optional) Enable OpenBR to use make GUI windows. Default is false.
453 453  
454 454 * **output:** (void)
455 455 * **see:** [br_finalize](#br_finalize)
... ... @@ -462,7 +462,7 @@ Initializes the [Context](../cpp_api/context/context.md) with default arguments.
462 462  
463 463 * **function definition:**
464 464  
465   - void br_initialize_default()
  465 + void br_initialize_default()
466 466  
467 467 * **parameters:** None
468 468 * **output:** (void)
... ... @@ -476,7 +476,7 @@ Finalizes the context. Required at the end of any OpenBR program.
476 476  
477 477 * **function definition:**
478 478  
479   - void br_finalize()
  479 + void br_finalize()
480 480  
481 481 * **parameters:** None
482 482 * **output:** (void)
... ... @@ -490,13 +490,13 @@ Checks if the provided algorithm is a classifier. Wrapper of [IsClassifier](../c
490 490  
491 491 * **function definition:**
492 492  
493   - bool br_is_classifier(const char *algorithm)
  493 + bool br_is_classifier(const char *algorithm)
494 494  
495 495 * **parameters:**
496 496  
497   - Parameter | Type | Description
498   - --- | --- | ---
499   - algorithm | const char * | Algorithm to check.
  497 + Parameter | Type | Description
  498 + --- | --- | ---
  499 + algorithm | const char * | Algorithm to check.
500 500  
501 501 * **output:** (bool) Returns true if the algorithm is a classifier (does not have an associated distance)
502 502 * **see:** [IsClassifier](../cpp_api/apifunctions.md#isclassifier)
... ... @@ -509,15 +509,15 @@ Constructs a [mask](../../tutorials.md#the-evaluation-harness) from target and q
509 509  
510 510 * **function definition:**
511 511  
512   - void br_make_mask(const char *target_input, const char *query_input, const char *mask)
  512 + void br_make_mask(const char *target_input, const char *query_input, const char *mask)
513 513  
514 514 * **parameters:**
515 515  
516   - Parameter | Type | Description
517   - --- | --- | ---
518   - target_input | const char * | The target [Gallery](../cpp_api/gallery/gallery.md)
519   - query_input | const char * | The query [Gallery](../cpp_api/gallery/gallery.md)
520   - mask | const char * | The file to contain the resulting [mask](../../tutorials.md#the-evaluation-harness).
  516 + Parameter | Type | Description
  517 + --- | --- | ---
  518 + target_input | const char * | The target [Gallery](../cpp_api/gallery/gallery.md)
  519 + query_input | const char * | The query [Gallery](../cpp_api/gallery/gallery.md)
  520 + mask | const char * | The file to contain the resulting [mask](../../tutorials.md#the-evaluation-harness).
521 521  
522 522 * **output:** (void)
523 523 * **see:** [br_combine_masks](#br_combine_masks)
... ... @@ -530,7 +530,7 @@ Constructs a [mask](../../tutorials.md#the-evaluation-harness) from target and q
530 530  
531 531 * **function definition:**
532 532  
533   - void br_make_pairwise_mask(const char *target_input, const char *query_input, const char *mask)
  533 + void br_make_pairwise_mask(const char *target_input, const char *query_input, const char *mask)
534 534  
535 535 * **parameters:**
536 536  
... ... @@ -551,14 +551,14 @@ Returns the most recent line sent to stderr. For information on input string buf
551 551  
552 552 * **function definition:**
553 553  
554   - int br_most_recent_message(char * buffer, int buffer_length)
  554 + int br_most_recent_message(char * buffer, int buffer_length)
555 555  
556 556 * **parameters:**
557 557  
558   - Parameter | Type | Description
559   - --- | --- | ---
560   - buffer | char * | Buffer to store the last line in.
561   - buffer_length | int | Length of the buffer.
  558 + Parameter | Type | Description
  559 + --- | --- | ---
  560 + buffer | char * | Buffer to store the last line in.
  561 + buffer_length | int | Length of the buffer.
562 562  
563 563 * **output:** (int) Returns the required size of the input buffer for the most recent message to fit completely
564 564 * **see:** [br_progress](#br_progress), [br_time_remaining](#br_time_remaining)
... ... @@ -571,17 +571,17 @@ Returns names and parameters for the requested objects. Each object is newline s
571 571  
572 572 * **function definition:**
573 573  
574   - int br_objects(char * buffer, int buffer_length, const char *abstractions = ".*", const char *implementations = ".*", bool parameters = true)
  574 + int br_objects(char * buffer, int buffer_length, const char *abstractions = ".*", const char *implementations = ".*", bool parameters = true)
575 575  
576 576 * **parameters:**
577 577  
578   - Parameter | Type | Description
579   - --- | --- | ---
580   - buffer | char * | Output buffer for results.
581   - buffer_length | int | Length of output buffer.
582   - abstractions | const char * | (Optional) Regular expression of the abstractions to search. Default is ".\*".
583   - implementations | const char * | (Optional) Regular expression of the implementations to search. Default is ".\*".
584   - parameters | bool | (Optional) Include parameters after object name. Default is true.
  578 + Parameter | Type | Description
  579 + --- | --- | ---
  580 + buffer | char * | Output buffer for results.
  581 + buffer_length | int | Length of output buffer.
  582 + abstractions | const char * | (Optional) Regular expression of the abstractions to search. Default is ".\*".
  583 + implementations | const char * | (Optional) Regular expression of the implementations to search. Default is ".\*".
  584 + parameters | bool | (Optional) Include parameters after object name. Default is true.
585 585  
586 586 * **output:** (int) Returns the required size of the input buffer for the returned objects to fit completely
587 587  
... ... @@ -613,20 +613,20 @@ Matches around the EER will be displayed if the matches parameter is set in [br_
613 613  
614 614 This function requires a current [R][R] installation with the following packages:
615 615  
616   - install.packages(c("ggplot2", "gplots", "reshape", "scales", "jpg", "png"))
  616 + install.packages(c("ggplot2", "gplots", "reshape", "scales", "jpg", "png"))
617 617  
618 618 * **function definiton:**
619 619  
620   - bool br_plot(int num_files, const char *files[], const char *destination, bool show = false)
  620 + bool br_plot(int num_files, const char *files[], const char *destination, bool show = false)
621 621  
622 622 * **parameters:**
623 623  
624   - Parameter | Type | Description
625   - --- | --- | ---
626   - num_files | int | Number of **.csv** files.
627   - files[] | const char * | **.csv** files created using [br_eval](#br_eval).
628   - destination | const char * | Basename for the resulting figures.
629   - show | bool | Open **destination.pdf** using the system's default PDF viewer. Default is false.
  624 + Parameter | Type | Description
  625 + --- | --- | ---
  626 + num_files | int | Number of **.csv** files.
  627 + files[] | const char * | **.csv** files created using [br_eval](#br_eval).
  628 + destination | const char * | Basename for the resulting figures.
  629 + show | bool | Open **destination.pdf** using the system's default PDF viewer. Default is false.
630 630  
631 631 * **output:** (bool) Returns true on success. Returns false on a failure to compile the figures due to a missing, out of date, or incomplete <tt>R</tt> installation.
632 632 * **see:** [br_eval](#br_eval)
... ... @@ -656,16 +656,16 @@ This function requires a current [R](http://www.r-project.org/) installation wit
656 656  
657 657 * **function definition:**
658 658  
659   - bool br_plot_detection(int num_files, const char *files[], const char *destination, bool show = false)
  659 + bool br_plot_detection(int num_files, const char *files[], const char *destination, bool show = false)
660 660  
661 661 * **parameters:**
662 662  
663   - Parameter | Type | Description
664   - --- | --- | ---
665   - num_files | int | Number of **.csv** files.
666   - files[] | const char * | **.csv** files created using [br_eval_detection](#br_eval_detection).
667   - destination | const char * | Basename for the resulting figures.
668   - show | bool | Open **destination.pdf** using the system's default PDF viewer. Default is false.
  663 + Parameter | Type | Description
  664 + --- | --- | ---
  665 + num_files | int | Number of **.csv** files.
  666 + files[] | const char * | **.csv** files created using [br_eval_detection](#br_eval_detection).
  667 + destination | const char * | Basename for the resulting figures.
  668 + show | bool | Open **destination.pdf** using the system's default PDF viewer. Default is false.
669 669  
670 670 * **output:** (bool) Returns true on success. Returns false on a failure to compile the figures due to a missing, out of date, or incomplete <tt>R</tt> installation.
671 671 * **see:** [br_eval_detection](#br_eval_detection), [br_plot](#br_plot)
... ... @@ -685,16 +685,16 @@ Landmarking error is normalized against the distance between two predifined poin
685 685  
686 686 * **function definition:**
687 687  
688   - bool br_plot_landmarking(int num_files, const char *files[], const char *destination, bool show = false)
  688 + bool br_plot_landmarking(int num_files, const char *files[], const char *destination, bool show = false)
689 689  
690 690 * **parameters:**
691 691  
692   - Parameter | Type | Description
693   - --- | --- | ---
694   - num_files | int | Number of **.csv** files.
695   - files[] | const char * | **.csv** files created using [br_eval_landmarking](#br_eval_landmarking).
696   - destination | const char * | Basename for the resulting figures.
697   - show | bool | Open **destination.pdf** using the system's default PDF viewer. Default is false.
  692 + Parameter | Type | Description
  693 + --- | --- | ---
  694 + num_files | int | Number of **.csv** files.
  695 + files[] | const char * | **.csv** files created using [br_eval_landmarking](#br_eval_landmarking).
  696 + destination | const char * | Basename for the resulting figures.
  697 + show | bool | Open **destination.pdf** using the system's default PDF viewer. Default is false.
698 698  
699 699 * **output:** (bool) Returns true on success. Returns false on a failure to compile the figures due to a missing, out of date, or incomplete <tt>R</tt> installation.
700 700 * **see:** [br_eval_landmarking](#br_eval_landmarking), [br_plot](#br_plot)
... ... @@ -707,16 +707,16 @@ Renders metadata figures for a set of **.csv** files with specified columns.
707 707  
708 708 * **function definition:**
709 709  
710   - bool br_plot_metadata(int num_files, const char *files[], const char *columns, bool show = false)
  710 + bool br_plot_metadata(int num_files, const char *files[], const char *columns, bool show = false)
711 711  
712 712 * **parameters:**
713 713  
714   - Parameter | Type | Description
715   - --- | --- | ---
716   - num_files | int | Number of **.csv** files.
717   - files[] | const char * | **.csv** files created by enrolling templates to **.csv** metadata files.
718   - columns | const char * | ';' seperated list of columns to plot.
719   - show | bool | Open **PlotMetadata.pdf** using the system's default PDF viewer.
  714 + Parameter | Type | Description
  715 + --- | --- | ---
  716 + num_files | int | Number of **.csv** files.
  717 + files[] | const char * | **.csv** files created by enrolling templates to **.csv** metadata files.
  718 + columns | const char * | ';' seperated list of columns to plot.
  719 + show | bool | Open **PlotMetadata.pdf** using the system's default PDF viewer.
720 720  
721 721 * **output:** (bool) Returns true on success. Returns false on a failure to compile the figures due to a missing, out of date, or incomplete <tt>R</tt> installation.
722 722 * **see:** [br_plot](#br_plot)
... ... @@ -729,7 +729,7 @@ Returns current progress from [Context](../cpp_api/context/context.md)::[progres
729 729  
730 730 * **function definition:**
731 731  
732   - float br_progress()
  732 + float br_progress()
733 733  
734 734 * **parameters:** None
735 735  
... ... @@ -744,15 +744,15 @@ Read and parse arguments from a named pipe. Used by the [command line api](../cl
744 744  
745 745 * **function defintion:**
746 746  
747   - void br_read_pipe(const char *pipe, int *argc, char ***argv)
  747 + void br_read_pipe(const char *pipe, int *argc, char ***argv)
748 748  
749 749 * **parameters:**
750 750  
751   - Parameter | Type | Description
752   - --- | --- | ---
753   - pipe | const char * | Pipe name
754   - argc | int * | Argument count
755   - argv | char *** | Argument list
  751 + Parameter | Type | Description
  752 + --- | --- | ---
  753 + pipe | const char * | Pipe name
  754 + argc | int * | Argument count
  755 + argv | char *** | Argument list
756 756  
757 757 * **output:** (void)
758 758  
... ... @@ -764,14 +764,14 @@ Fills the buffer with the value of [Context](../cpp_api/context/context.md)::[sc
764 764  
765 765 * **function defintion:**
766 766  
767   - int br_scratch_path(char * buffer, int buffer_length)
  767 + int br_scratch_path(char * buffer, int buffer_length)
768 768  
769 769 * **parameters:**
770 770  
771   - Parameter | Type | Description
772   - --- | --- | ---
773   - buffer | char * | Buffer for scratch path
774   - buffer_length | int | Length of buffer.
  771 + Parameter | Type | Description
  772 + --- | --- | ---
  773 + buffer | char * | Buffer for scratch path
  774 + buffer_length | int | Length of buffer.
775 775  
776 776 * **output:** (int) Returns the required size of the input buffer for the most recent message to fit completely
777 777 * **see:** [br_version](#br_version)
... ... @@ -784,7 +784,7 @@ Returns the full path to the root of the SDK.
784 784  
785 785 * **function definition:**
786 786  
787   - const char *br_sdk_path()
  787 + const char *br_sdk_path()
788 788  
789 789 * **parameters:** None
790 790 * **output:** (const char *) Returns the full path to the root of the SDK
... ... @@ -798,15 +798,15 @@ Retrieve the target and query inputs in the [BEE matrix](../../tutorials.md#the-
798 798  
799 799 * **function definition:**
800 800  
801   - void br_get_header(const char *matrix, const char **target_gallery, const char **query_gallery)
  801 + void br_get_header(const char *matrix, const char **target_gallery, const char **query_gallery)
802 802  
803 803 * **parameters:**
804 804  
805   - Parameter | Type | Description
806   - --- | --- | ---
807   - matrix | const char * | The [BEE matrix](../../tutorials.md#the-evaluation-harness) file to modify
808   - target_gallery | const char ** | The matrix target
809   - query_gallery | const char ** | The matrix query
  805 + Parameter | Type | Description
  806 + --- | --- | ---
  807 + matrix | const char * | The [BEE matrix](../../tutorials.md#the-evaluation-harness) file to modify
  808 + target_gallery | const char ** | The matrix target
  809 + query_gallery | const char ** | The matrix query
810 810  
811 811 * **output:** (void)
812 812 * **set:** [br_set_header](#br_set_header)
... ... @@ -819,15 +819,15 @@ Update the target and query inputs in the [BEE matrix](../../tutorials.md#the-ev
819 819  
820 820 * **function definition:**
821 821  
822   - void br_set_header(const char *matrix, const char *target_gallery, const char *query_gallery)
  822 + void br_set_header(const char *matrix, const char *target_gallery, const char *query_gallery)
823 823  
824 824 * **parameters:**
825 825  
826   - Parameter | Type | Description
827   - --- | --- | ---
828   - matrix | const char * | The [BEE matrix](../../tutorials.md#the-evaluation-harness) file to modify
829   - target_gallery | const char ** | The matrix target
830   - query_gallery | const char ** | The matrix query
  826 + Parameter | Type | Description
  827 + --- | --- | ---
  828 + matrix | const char * | The [BEE matrix](../../tutorials.md#the-evaluation-harness) file to modify
  829 + target_gallery | const char ** | The matrix target
  830 + query_gallery | const char ** | The matrix query
831 831  
832 832 * **output:** (void)
833 833 * **see:** [br_get_header](#br_get_header)
... ... @@ -840,14 +840,14 @@ Appends a provided value to the [global metadata](../cpp_api/context/context.md)
840 840  
841 841 * **function definition:**
842 842  
843   - void br_set_property(const char *key, const char *value)
  843 + void br_set_property(const char *key, const char *value)
844 844  
845 845 * **parameters:**
846 846  
847   - Parameter | Type | Description
848   - --- | --- | ---
849   - key | const char * | Key to append
850   - value | const char * | Value to append
  847 + Parameter | Type | Description
  848 + --- | --- | ---
  849 + key | const char * | Key to append
  850 + value | const char * | Value to append
851 851  
852 852 * **output:** (void)
853 853  
... ... @@ -859,7 +859,7 @@ Returns estimate of time remaining in the current process.
859 859  
860 860 * **function definition:**
861 861  
862   - int br_time_remaining()
  862 + int br_time_remaining()
863 863  
864 864 * **parameters:** None
865 865 * **output:** (int) Returns an estimate of the time remaining
... ... @@ -873,14 +873,14 @@ Trains a provided model&#39;s [Transform](../cpp_api/transform/transform.md) and [Di
873 873  
874 874 * **function definiton:**
875 875  
876   - void br_train(const char *input, const char *model = "")
  876 + void br_train(const char *input, const char *model = "")
877 877  
878 878 * **parameters:**
879 879  
880   - Parameter | Type | Description
881   - --- | --- | ---
882   - input | const char * | The [Gallery](../cpp_api/gallery/gallery.md) to train on.
883   - model | const char * | (Optional) String specifying the binary file to serialize training results to. The trained algorithm can be recovered by using this file as the algorithm. By default the trained algorithm will not be serialized to disk.
  880 + Parameter | Type | Description
  881 + --- | --- | ---
  882 + input | const char * | The [Gallery](../cpp_api/gallery/gallery.md) to train on.
  883 + model | const char * | (Optional) String specifying the binary file to serialize training results to. The trained algorithm can be recovered by using this file as the algorithm. By default the trained algorithm will not be serialized to disk.
884 884  
885 885 * **output:** (void)
886 886 * **see:** [br_train_n](#br_train_n)
... ... @@ -893,15 +893,15 @@ Convenience function for training on multiple inputs
893 893  
894 894 * **function definition:**
895 895  
896   - void br_train_n(int num_inputs, const char *inputs[], const char *model = "")
  896 + void br_train_n(int num_inputs, const char *inputs[], const char *model = "")
897 897  
898 898 * **parameters:**
899 899  
900   - Parameter | Type | Description
901   - --- | --- | ---
902   - num_inputs | int | Size of **inputs**
903   - inputs[] | const char * | An array of [galleries](../cpp_api/gallery/gallery.md) to train on.
904   - model | const char * | (Optional) String specifying the binary file to serialize training results to. The trained algorithm can be recovered by using this file as the algorithm. By default the trained algorithm will not be serialized to disk.
  900 + Parameter | Type | Description
  901 + --- | --- | ---
  902 + num_inputs | int | Size of **inputs**
  903 + inputs[] | const char * | An array of [galleries](../cpp_api/gallery/gallery.md) to train on.
  904 + model | const char * | (Optional) String specifying the binary file to serialize training results to. The trained algorithm can be recovered by using this file as the algorithm. By default the trained algorithm will not be serialized to disk.
905 905  
906 906 * **output:** (void)
907 907 * **see:** [br_train](#br_train)
... ... @@ -914,7 +914,7 @@ Get the current OpenBR version.
914 914  
915 915 * **function definition:**
916 916  
917   - const char *br_version()
  917 + const char *br_version()
918 918  
919 919 * **parameters:** None
920 920 * **output:** (const char *) Returns the current OpenBR version
... ... @@ -928,13 +928,13 @@ For internal use via [ProcessWrapperTransform](../plugins/core.md#processwrapper
928 928  
929 929 * **function definition:**
930 930  
931   - void br_slave_process(const char * baseKey)
  931 + void br_slave_process(const char * baseKey)
932 932  
933 933 * **parameters:**
934 934  
935   - Parameter | Type | Description
936   - --- | --- | ---
937   - baseKey | const char * | base key for the slave process
  935 + Parameter | Type | Description
  936 + --- | --- | ---
  937 + baseKey | const char * | base key for the slave process
938 938  
939 939 * **output:** (void)
940 940  
... ... @@ -946,14 +946,14 @@ Load an image from a string buffer. This is an easy way to pass an image in memo
946 946  
947 947 * **function definition:**
948 948  
949   - br_template br_load_img(const char *data, int len)
  949 + br_template br_load_img(const char *data, int len)
950 950  
951 951 * **parameters:**
952 952  
953   - Parameter | Type | Description
954   - --- | --- | ---
955   - data | const char * | The image buffer.
956   - len | int | The length of the buffer.
  953 + Parameter | Type | Description
  954 + --- | --- | ---
  955 + data | const char * | The image buffer.
  956 + len | int | The length of the buffer.
957 957  
958 958 * **output:** ([br_template](typedefs.md#br_template) Returns a [br_template](typedefs.md#br_template) loaded with the provided image
959 959 * **see:** [br_unload_img](#br_unload_img)
... ... @@ -966,13 +966,13 @@ Unload an image to a string buffer. This is an easy way to pass an image from op
966 966  
967 967 * **function definition:**
968 968  
969   - unsigned char* br_unload_img(br_template tmpl)
  969 + unsigned char* br_unload_img(br_template tmpl)
970 970  
971 971 * **parameters:**
972 972  
973   - Parameter | Type | Description
974   - --- | --- | ---
975   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md)
  973 + Parameter | Type | Description
  974 + --- | --- | ---
  975 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md)
976 976  
977 977 * **output:** (unsigned char*) Returns a buffer loaded with the image data from tmpl
978 978 * **see:** [br_load_img](#br_load_img)
... ... @@ -985,7 +985,7 @@ Deserialize a [TemplateList](../cpp_api/templatelist/templatelist.md) from a buf
985 985  
986 986 * **function definition:**
987 987  
988   - br_template_list br_template_list_from_buffer(const char *buf, int len)
  988 + br_template_list br_template_list_from_buffer(const char *buf, int len)
989 989  
990 990 * **return type:** br_template_list
991 991 * **parameters:**
... ... @@ -1005,13 +1005,13 @@ Free a [Template&#39;s](../cpp_api/template/template.md) memory.
1005 1005  
1006 1006 * **function definition:**
1007 1007  
1008   - void br_free_template(br_template tmpl)
  1008 + void br_free_template(br_template tmpl)
1009 1009  
1010 1010 * **parameters:**
1011 1011  
1012   - Parameter | Type | Description
1013   - --- | --- | ---
1014   - tmpl | br_template | Pointer to the [Template](../cpp_api/template/template.md) to free.
  1012 + Parameter | Type | Description
  1013 + --- | --- | ---
  1014 + tmpl | br_template | Pointer to the [Template](../cpp_api/template/template.md) to free.
1015 1015  
1016 1016 * **output:** (void)
1017 1017  
... ... @@ -1023,13 +1023,13 @@ Free a [TemplateList&#39;s](../cpp_api/templatelist/templatelist.md) memory.
1023 1023  
1024 1024 * **function definition:**
1025 1025  
1026   - void br_free_template_list(br_template_list tl)
  1026 + void br_free_template_list(br_template_list tl)
1027 1027  
1028 1028 * **parameters:**
1029 1029  
1030   - Parameter | Type | Description
1031   - --- | --- | ---
1032   - tl | [br_template_list](typedefs.md#br_template_list) | Pointer to the [TemplateList](../cpp_api/templatelist/templatelist.md) to free.
  1030 + Parameter | Type | Description
  1031 + --- | --- | ---
  1032 + tl | [br_template_list](typedefs.md#br_template_list) | Pointer to the [TemplateList](../cpp_api/templatelist/templatelist.md) to free.
1033 1033  
1034 1034 * **output:** (void)
1035 1035  
... ... @@ -1041,13 +1041,13 @@ Free a [Output&#39;s](../cpp_api/output/output.md) memory.
1041 1041  
1042 1042 * **function definition:**
1043 1043  
1044   - void br_free_output(br_matrix_output output)
  1044 + void br_free_output(br_matrix_output output)
1045 1045  
1046 1046 * **parameters:**
1047 1047  
1048   - Parameter | Type | Description
1049   - --- | --- | ---
1050   - output | [br_matrix_output](typedefs.md#br_matrix_output) | Pointer to the[Output](../cpp_api/output/output.md) to free.
  1048 + Parameter | Type | Description
  1049 + --- | --- | ---
  1050 + output | [br_matrix_output](typedefs.md#br_matrix_output) | Pointer to the[Output](../cpp_api/output/output.md) to free.
1051 1051  
1052 1052 * **output:** (void)
1053 1053  
... ... @@ -1059,13 +1059,13 @@ Returns the number of rows in an image.
1059 1059  
1060 1060 * **function definition:**
1061 1061  
1062   - int br_img_rows(br_template tmpl)
  1062 + int br_img_rows(br_template tmpl)
1063 1063  
1064 1064 * **parameters:**
1065 1065  
1066   - Parameter | Type | Description
1067   - --- | --- | ---
1068   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
  1066 + Parameter | Type | Description
  1067 + --- | --- | ---
  1068 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
1069 1069  
1070 1070 * **output:** (int) Returns the number of rows in an image
1071 1071  
... ... @@ -1077,13 +1077,13 @@ Returns the number of cols in an image.
1077 1077  
1078 1078 * **function definition:**
1079 1079  
1080   - int br_img_cols(br_template tmpl)
  1080 + int br_img_cols(br_template tmpl)
1081 1081  
1082 1082 * **parameters:**
1083 1083  
1084   - Parameter | Type | Description
1085   - --- | --- | ---
1086   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
  1084 + Parameter | Type | Description
  1085 + --- | --- | ---
  1086 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
1087 1087  
1088 1088 * **output:** (int) Returns the number of columns in an image
1089 1089  
... ... @@ -1095,13 +1095,13 @@ Returns the number of channels in an image.
1095 1095  
1096 1096 * **function definition:**
1097 1097  
1098   - int br_img_channels(br_template tmpl)
  1098 + int br_img_channels(br_template tmpl)
1099 1099  
1100 1100 * **parameters:**
1101 1101  
1102   - Parameter | Type | Description
1103   - --- | --- | ---
1104   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
  1102 + Parameter | Type | Description
  1103 + --- | --- | ---
  1104 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
1105 1105  
1106 1106 * **output:** (int) Returns the number of channels in an image
1107 1107  
... ... @@ -1113,13 +1113,13 @@ Checks if the image is empty.
1113 1113  
1114 1114 * **function definition:**
1115 1115  
1116   - bool br_img_is_empty(br_template tmpl)
  1116 + bool br_img_is_empty(br_template tmpl)
1117 1117  
1118 1118 * **parameters:**
1119 1119  
1120   - Parameter | Type | Description
1121   - --- | --- | ---
1122   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
  1120 + Parameter | Type | Description
  1121 + --- | --- | ---
  1122 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
1123 1123  
1124 1124 * **output:** (bool) Returns true if the image is empty, false otherwise.
1125 1125  
... ... @@ -1131,15 +1131,15 @@ Get the name of the [file](../cpp_api/template/members.md#file) of a provided [T
1131 1131  
1132 1132 * **function definition:**
1133 1133  
1134   - int br_get_filename(char * buffer, int buffer_length, br_template tmpl)
  1134 + int br_get_filename(char * buffer, int buffer_length, br_template tmpl)
1135 1135  
1136 1136 * **parameters:**
1137 1137  
1138   - Parameter | Type | Description
1139   - --- | --- | ---
1140   - buffer | char * | Buffer to hold the filename
1141   - buffer_length | int | Length of the buffer
1142   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
  1138 + Parameter | Type | Description
  1139 + --- | --- | ---
  1140 + buffer | char * | Buffer to hold the filename
  1141 + buffer_length | int | Length of the buffer
  1142 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
1143 1143  
1144 1144 * **output:** (int) Returns the size of the buffer required to hold the entire file name.
1145 1145  
... ... @@ -1151,14 +1151,14 @@ Set the name of the [file](../cpp_api/template/members.md#file) for a provided [
1151 1151  
1152 1152 * **function definition:**
1153 1153  
1154   - void br_set_filename(br_template tmpl, const char *filename)
  1154 + void br_set_filename(br_template tmpl, const char *filename)
1155 1155  
1156 1156 * **parameters:**
1157 1157  
1158   - Parameter | Type | Description
1159   - --- | --- | ---
1160   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
1161   - filename | const char * | New filename for the template.
  1158 + Parameter | Type | Description
  1159 + --- | --- | ---
  1160 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
  1161 + filename | const char * | New filename for the template.
1162 1162  
1163 1163 * **output:** (void)
1164 1164  
... ... @@ -1170,16 +1170,16 @@ Get the [metadata](../cpp_api/file/members.md#m_metadata) value as a string for
1170 1170  
1171 1171 * **function definition:**
1172 1172  
1173   - int br_get_metadata_string(char * buffer, int buffer_length, br_template tmpl, const char *key)
  1173 + int br_get_metadata_string(char * buffer, int buffer_length, br_template tmpl, const char *key)
1174 1174  
1175 1175 * **parameters:**
1176 1176  
1177   - Parameter | Type | Description
1178   - --- | --- | ---
1179   - buffer | char * | Buffer to hold the metadata string.
1180   - buffer_length | int | length of the buffer.
1181   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
1182   - key | const char * | Key for the metadata lookup
  1177 + Parameter | Type | Description
  1178 + --- | --- | ---
  1179 + buffer | char * | Buffer to hold the metadata string.
  1180 + buffer_length | int | length of the buffer.
  1181 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md).
  1182 + key | const char * | Key for the metadata lookup
1183 1183  
1184 1184 * **output:** (int) Returns the size of the buffer required to hold the entire metadata string
1185 1185  
... ... @@ -1191,13 +1191,13 @@ Enroll a [Template](../cpp_api/template/template.md) from the C API!
1191 1191  
1192 1192 * **function definition:**
1193 1193  
1194   - br_template_list br_enroll_template(br_template tmpl)
  1194 + br_template_list br_enroll_template(br_template tmpl)
1195 1195  
1196 1196 * **parameters:**
1197 1197  
1198   - Parameter | Type | Description
1199   - --- | --- | ---
1200   - tmpl | br_template | Pointer to a [Template](../cpp_api/template/template.md).
  1198 + Parameter | Type | Description
  1199 + --- | --- | ---
  1200 + tmpl | br_template | Pointer to a [Template](../cpp_api/template/template.md).
1201 1201  
1202 1202 * **output:** ([br_template_list](typedefs.md#br_template_list)) Returns a pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
1203 1203  
... ... @@ -1209,13 +1209,13 @@ Enroll a [TemplateList](../cpp_api/templatelist/templatelist.md) from the C API!
1209 1209  
1210 1210 * **function definition:**
1211 1211  
1212   - void br_enroll_template_list(br_template_list tl)
  1212 + void br_enroll_template_list(br_template_list tl)
1213 1213  
1214 1214 * **parameters:**
1215 1215  
1216   - Parameter | Type | Description
1217   - --- | --- | ---
1218   - tl | [br_template_list](typedefs.md#br_template_list) | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
  1216 + Parameter | Type | Description
  1217 + --- | --- | ---
  1218 + tl | [br_template_list](typedefs.md#br_template_list) | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
1219 1219  
1220 1220 * **output:** (void)
1221 1221  
... ... @@ -1227,14 +1227,14 @@ Compare [TemplateLists](../cpp_api/templatelist/templatelist.md) from the C API!
1227 1227  
1228 1228 * **function definition:**
1229 1229  
1230   - br_matrix_output br_compare_template_lists(br_template_list target, br_template_list query)
  1230 + br_matrix_output br_compare_template_lists(br_template_list target, br_template_list query)
1231 1231  
1232 1232 * **parameters:**
1233 1233  
1234   - Parameter | Type | Description
1235   - --- | --- | ---
1236   - target | br_template_list | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
1237   - query | br_template_list | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
  1234 + Parameter | Type | Description
  1235 + --- | --- | ---
  1236 + target | br_template_list | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
  1237 + query | br_template_list | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
1238 1238  
1239 1239  
1240 1240 * **output:** ([br_matrix_output](typedefs.md#br_matrix_output)) Returns a pointer to a [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
... ... @@ -1247,15 +1247,15 @@ Get a value in a provided [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md
1247 1247  
1248 1248 * **function definition:**
1249 1249  
1250   - float br_get_matrix_output_at(br_matrix_output output, int row, int col)
  1250 + float br_get_matrix_output_at(br_matrix_output output, int row, int col)
1251 1251  
1252 1252 * **parameters:**
1253 1253  
1254   - Parameter | Type | Description
1255   - --- | --- | ---
1256   - output | br_matrix_output | Pointer to [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
1257   - row | int | Row index for lookup
1258   - col | int | Column index for lookup
  1254 + Parameter | Type | Description
  1255 + --- | --- | ---
  1256 + output | br_matrix_output | Pointer to [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md)
  1257 + row | int | Row index for lookup
  1258 + col | int | Column index for lookup
1259 1259  
1260 1260 * **output:** (float) Returns the value of the [MatrixOutput](../cpp_api/matrixoutput/matrixoutput.md) at the provided indexes.
1261 1261  
... ... @@ -1267,14 +1267,14 @@ Get a [Template](../cpp_api/template/template.md) from a [TemplateList](../cpp_a
1267 1267  
1268 1268 * **function definition:**
1269 1269  
1270   - br_template br_get_template(br_template_list tl, int index)
  1270 + br_template br_get_template(br_template_list tl, int index)
1271 1271  
1272 1272 * **parameters:**
1273 1273  
1274   - Parameter | Type | Description
1275   - --- | --- | ---
1276   - tl | [br_template_list](typedefs.md#br_template_list) | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
1277   - index | int | Index into the template list. Should be in the range [0,len(tl) - 1].
  1274 + Parameter | Type | Description
  1275 + --- | --- | ---
  1276 + tl | [br_template_list](typedefs.md#br_template_list) | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
  1277 + index | int | Index into the template list. Should be in the range [0,len(tl) - 1].
1278 1278  
1279 1279 * **output:** ([br_template](typedefs.md#br_template)) Returns a pointer to a [Template](../cpp_api/template/template.md)
1280 1280  
... ... @@ -1286,13 +1286,13 @@ Get the number of [Templates](../cpp_api/template/template.md) in a [TemplateLis
1286 1286  
1287 1287 * **function definition:**
1288 1288  
1289   - int br_num_templates(br_template_list tl)
  1289 + int br_num_templates(br_template_list tl)
1290 1290  
1291 1291 * **parameters:**
1292 1292  
1293   - Parameter | Type | Description
1294   - --- | --- | ---
1295   - tl | [br_template_list](typedefs.md#br_template_list) | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
  1293 + Parameter | Type | Description
  1294 + --- | --- | ---
  1295 + tl | [br_template_list](typedefs.md#br_template_list) | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
1296 1296  
1297 1297 * **output:** (int) Returns the size of the provided [TemplateList](../cpp_api/templatelist/templatelist.md)
1298 1298  
... ... @@ -1304,13 +1304,13 @@ Initialize a [Gallery](../cpp_api/gallery/gallery.md) from a file.
1304 1304  
1305 1305 * **function definition:**
1306 1306  
1307   - br_gallery br_make_gallery(const char *gallery)
  1307 + br_gallery br_make_gallery(const char *gallery)
1308 1308  
1309 1309 * **parameters:**
1310 1310  
1311   - Parameter | Type | Description
1312   - --- | --- | ---
1313   - gallery | const char * | String location of gallery on disk.
  1311 + Parameter | Type | Description
  1312 + --- | --- | ---
  1313 + gallery | const char * | String location of gallery on disk.
1314 1314  
1315 1315 * **output:** ([br_gallery](typedefs.md#br_gallery)) Returns a pointer to a [Gallery](../cpp_api/gallery/gallery.md) that has been created from the provided file
1316 1316  
... ... @@ -1322,13 +1322,13 @@ Read a [TemplateList](../cpp_api/templatelist/templatelist.md) from a [Gallery](
1322 1322  
1323 1323 * **function definition:**
1324 1324  
1325   - br_template_list br_load_from_gallery(br_gallery gallery)
  1325 + br_template_list br_load_from_gallery(br_gallery gallery)
1326 1326  
1327 1327 * **parameters:**
1328 1328  
1329   - Parameter | Type | Description
1330   - --- | --- | ---
1331   - gallery | [br_gallery](typedefs.md#br_gallery) | Pointer to a [Gallery](../cpp_api/gallery/gallery.md)
  1329 + Parameter | Type | Description
  1330 + --- | --- | ---
  1331 + gallery | [br_gallery](typedefs.md#br_gallery) | Pointer to a [Gallery](../cpp_api/gallery/gallery.md)
1332 1332  
1333 1333 * **output:** ([br_template_list](typedefs.md#br_template_list)) Returns a pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md) containing the data from the provided [Gallery](../cpp_api/gallery/gallery.md)
1334 1334  
... ... @@ -1340,14 +1340,14 @@ Write a [Template](../cpp_api/template/template.md) to a [Gallery](../cpp_api/ga
1340 1340  
1341 1341 * **function definition:**
1342 1342  
1343   - void br_add_template_to_gallery(br_gallery gallery, br_template tmpl)
  1343 + void br_add_template_to_gallery(br_gallery gallery, br_template tmpl)
1344 1344  
1345 1345 * **parameters:**
1346 1346  
1347   - Parameter | Type | Description
1348   - --- | --- | ---
1349   - gallery | [br_gallery](typedefs.md#br_gallery) | Pointer to a [Gallery](../cpp_api/gallery/gallery.md)
1350   - tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md)
  1347 + Parameter | Type | Description
  1348 + --- | --- | ---
  1349 + gallery | [br_gallery](typedefs.md#br_gallery) | Pointer to a [Gallery](../cpp_api/gallery/gallery.md)
  1350 + tmpl | [br_template](typedefs.md#br_template) | Pointer to a [Template](../cpp_api/template/template.md)
1351 1351  
1352 1352 * **output:** (void)
1353 1353  
... ... @@ -1359,14 +1359,14 @@ Write a [TemplateList](../cpp_api/templatelist/templatelist.md) to the [Gallery]
1359 1359  
1360 1360 * **function definition:**
1361 1361  
1362   - void br_add_template_list_to_gallery(br_gallery gallery, br_template_list tl)
  1362 + void br_add_template_list_to_gallery(br_gallery gallery, br_template_list tl)
1363 1363  
1364 1364 * **parameters:**
1365 1365  
1366   - Parameter | Type | Description
1367   - --- | --- | ---
1368   - gallery | [br_gallery](typedefs.md#br_gallery) | Pointer to a [Gallery](../cpp_api/gallery/gallery.md)
1369   - tl | [br_template_list](typedefs.md#br_template_list) | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
  1366 + Parameter | Type | Description
  1367 + --- | --- | ---
  1368 + gallery | [br_gallery](typedefs.md#br_gallery) | Pointer to a [Gallery](../cpp_api/gallery/gallery.md)
  1369 + tl | [br_template_list](typedefs.md#br_template_list) | Pointer to a [TemplateList](../cpp_api/templatelist/templatelist.md)
1370 1370  
1371 1371 * **output:** (void)
1372 1372  
... ... @@ -1378,16 +1378,16 @@ Close a provided [Gallery](../cpp_api/gallery/gallery.md).
1378 1378  
1379 1379 * **function definition:**
1380 1380  
1381   - void br_close_gallery(br_gallery gallery)
  1381 + void br_close_gallery(br_gallery gallery)
1382 1382  
1383 1383 * **parameters:**
1384 1384  
1385   - Parameter | Type | Description
1386   - --- | --- | ---
1387   - gallery | [br_gallery](typedefs.md#br_gallery) | Pointer to a [Gallery](../cpp_api/gallery/gallery.md)
  1385 + Parameter | Type | Description
  1386 + --- | --- | ---
  1387 + gallery | [br_gallery](typedefs.md#br_gallery) | Pointer to a [Gallery](../cpp_api/gallery/gallery.md)
1388 1388  
1389 1389 * **output:** (void)
1390 1390  
1391 1391 [^1]: *Zhu et al.*
1392   - **A Rank-Order Distance based Clustering Algorithm for Face Tagging**,
1393   - CVPR 2011
  1392 + **A Rank-Order Distance based Clustering Algorithm for Face Tagging**,
  1393 + CVPR 2011
... ...
docs/docs/api_docs/cl_api.md
  View file @0bdd445
... ... @@ -13,7 +13,7 @@ Shortcut | Definition
13 13  
14 14 Almost every command line process needs to specify an algorithm to work properly. Algorithms in OpenBR are described in detail [here](../tutorials.md#algorithms-in-openbr). To specify algorithms to the command line use the <tt>-algorithm</tt> flag like so:
15 15  
16   - -algorithm "AlgorithmString"
  16 + -algorithm "AlgorithmString"
17 17  
18 18 Make sure you use the quotes if your algorithm is longer than one plugin because special characters in OpenBR are also special characters (with very different meanings!) in Bash.
19 19  
... ... @@ -25,7 +25,7 @@ Train a model
25 25  
26 26 * **arguments:**
27 27  
28   - -train <gallery> ... <gallery> [{model}]
  28 + -train <gallery> ... <gallery> [{model}]
29 29  
30 30 * **wraps:** [br_train_n](c_api/functions.md#br_train_n)
31 31  
... ... @@ -35,7 +35,7 @@ Enroll a [Gallery](cpp_api/gallery/gallery.md) through an algorithm
35 35  
36 36 * **arguments:**
37 37  
38   - -enroll <input_gallery> ... <input_gallery> {output_gallery}
  38 + -enroll <input_gallery> ... <input_gallery> {output_gallery}
39 39  
40 40 * **wraps:** [br_enroll](c_api/functions.md#br_enroll) or [br_enroll_n](c_api/functions.md#br_enroll_n) depending on the input size
41 41  
... ... @@ -45,7 +45,7 @@ Compare query [Templates](cpp_api/template/template.md) against a target [Galler
45 45  
46 46 * **arguments:**
47 47  
48   - -compare <target_gallery> <query_gallery> [{output}]
  48 + -compare <target_gallery> <query_gallery> [{output}]
49 49  
50 50 * **wraps:** [br_compare](c_api/functions.md#br_compare)
51 51  
... ... @@ -55,7 +55,7 @@ DOCUMENT ME
55 55  
56 56 * **arguments:**
57 57  
58   - -pairwiseCompare <target_gallery> <query_gallery> [{output}]
  58 + -pairwiseCompare <target_gallery> <query_gallery> [{output}]
59 59  
60 60 * **wraps:** [br_pairwise_compare](c_api/functions.md#br_pairwise_compare)
61 61  
... ... @@ -65,7 +65,7 @@ Evaluate a similarity matrix
65 65  
66 66 * **arguments:**
67 67  
68   - -eval <simmat> [<mask>] [{csv}] [{matches}]
  68 + -eval <simmat> [<mask>] [{csv}] [{matches}]
69 69  
70 70 * **wraps:** [br_eval](c_api/functions.md#br_eval)
71 71  
... ... @@ -75,7 +75,7 @@ DOCUMENT ME
75 75  
76 76 * **arguments:**
77 77  
78   - -inplaceEval <simmat> <target> <query> [{output}]
  78 + -inplaceEval <simmat> <target> <query> [{output}]
79 79  
80 80 * **wraps:** [br_inplace_eval](c_api/functions.md#br_inplace_eval)
81 81  
... ... @@ -98,7 +98,7 @@ Perform score level fusion on similarity matrices.
98 98  
99 99 * **arguments:**
100 100  
101   - -fuse <simmat> ... <simmat> (None|MinMax|ZScore|WScore) (Min|Max|Sum[W1:W2:...:Wn]|Replace|Difference|None) {simmat}
  101 + -fuse <simmat> ... <simmat> (None|MinMax|ZScore|WScore) (Min|Max|Sum[W1:W2:...:Wn]|Replace|Difference|None) {simmat}
102 102  
103 103 * **wraps:** [br_fuse](c_api/functions.md#br_fuse)
104 104  
... ... @@ -108,7 +108,7 @@ Clusters one or more similarity matrices into a list of subjects
108 108  
109 109 * **arguments:**
110 110  
111   - -cluster <simmat> ... <simmat> <aggressiveness> {csv}
  111 + -cluster <simmat> ... <simmat> <aggressiveness> {csv}
112 112  
113 113 * **wraps:** [br_cluster](c_api/functions.md#br_cluster)
114 114  
... ... @@ -118,7 +118,7 @@ Constructs a mask from target and query inputs
118 118  
119 119 * **arguments:**
120 120  
121   - -makeMask <target_gallery> <query_gallery> {mask}
  121 + -makeMask <target_gallery> <query_gallery> {mask}
122 122  
123 123 * **wraps:** [br_make_mask](c_api/functions.md#br_make_mask)
124 124  
... ... @@ -128,7 +128,7 @@ Constructs a mask from target and query inputs considering the target and input
128 128  
129 129 * **arguments:**
130 130  
131   - -makePairwiseMask <target_gallery> <query_gallery> {mask}
  131 + -makePairwiseMask <target_gallery> <query_gallery> {mask}
132 132  
133 133 * **wraps:** [br_make_pairwise_mask](c_api/functions.md#br_make_pairwise_mask)
134 134  
... ... @@ -138,7 +138,7 @@ Combines several equal-sized mask matrices. A comparison may not be simultaneous
138 138  
139 139 * **arguments:**
140 140  
141   - -combineMasks <mask> ... <mask> {mask} (And|Or)
  141 + -combineMasks <mask> ... <mask> {mask} (And|Or)
142 142  
143 143 * **wraps:** [br_combine_masks](c_api/functions.md#br_combine_masks)
144 144  
... ... @@ -148,7 +148,7 @@ Concatenates a list of galleries into 1 gallery
148 148  
149 149 * **arguments:**
150 150  
151   - -cat <gallery> ... <gallery> {gallery}
  151 + -cat <gallery> ... <gallery> {gallery}
152 152  
153 153 * **wraps:** [br_cat](c_api/functions.md#br_cat)
154 154  
... ... @@ -158,7 +158,7 @@ Convert a file to a different type. Files can only be converted to types within
158 158  
159 159 * **arguments:**
160 160  
161   - -convert (Format|Gallery|Output) <input_file> {output_file}
  161 + -convert (Format|Gallery|Output) <input_file> {output_file}
162 162  
163 163 * **wraps:** [br_convert](c_api/functions.md#br_convert)
164 164  
... ... @@ -168,7 +168,7 @@ Evaluates and prints classification accuracy to terminal
168 168  
169 169 * **arguments:**
170 170  
171   - -evalClassification <predicted_gallery> <truth_gallery> <predicted property name> <ground truth property name>
  171 + -evalClassification <predicted_gallery> <truth_gallery> <predicted property name> <ground truth property name>
172 172  
173 173 * **wraps:** [br_eval_classification](c_api/functions.md#br_eval_classification)
174 174  
... ... @@ -178,7 +178,7 @@ Evaluates and prints clustering accuracy to the terminal
178 178  
179 179 * **arguments:**
180 180  
181   - -evalClustering <clusters> <gallery>
  181 + -evalClustering <clusters> <gallery>
182 182  
183 183 * **wraps:** [br_eval_clustering](c_api/functions.md#br_eval_clustering)
184 184  
... ... @@ -188,7 +188,7 @@ Evaluates and prints detection accuracy to terminal
188 188  
189 189 * **arguments:**
190 190  
191   - -evalDetection <predicted_gallery> <truth_gallery> [{csv}] [{normalize}] [{minSize}] [{maxSize}]
  191 + -evalDetection <predicted_gallery> <truth_gallery> [{csv}] [{normalize}] [{minSize}] [{maxSize}]
192 192  
193 193 * **wraps:** [br_eval_detection](c_api/functions.md#br_eval_detection)
194 194  
... ... @@ -198,7 +198,7 @@ Evaluates and prints landmarking accuracy to terminal
198 198  
199 199 * **arguments:**
200 200  
201   - -evalLandmarking <predicted_gallery> <truth_gallery> [{csv} [<normalization_index_a> <normalization_index_b>] [sample_index] [total_examples]]
  201 + -evalLandmarking <predicted_gallery> <truth_gallery> [{csv} [<normalization_index_a> <normalization_index_b>] [sample_index] [total_examples]]
202 202  
203 203 * **wraps:** [br_eval_landmarking](c_api/functions.md#br_eval_landmarking)
204 204  
... ... @@ -209,7 +209,7 @@ Evaluates regression accuracy to disk
209 209  
210 210 * **arguments:**
211 211  
212   - -evalRegression <predicted_gallery> <truth_gallery> <predicted property name> <ground truth property name>
  212 + -evalRegression <predicted_gallery> <truth_gallery> <predicted property name> <ground truth property name>
213 213  
214 214 * **wraps:** [br_eval_regression](c_api/functions.md#br_eval_regression)
215 215  
... ... @@ -219,7 +219,7 @@ Evaluates the similarity matrix using the mask matrix. Function aborts if TAR @
219 219  
220 220 * **arguments:**
221 221  
222   - -assertEval <simmat> <mask> <accuracy>
  222 + -assertEval <simmat> <mask> <accuracy>
223 223  
224 224 * **wraps:** [br_assert_eval](c_api/functions.md#br_assert_eval)
225 225  
... ... @@ -229,7 +229,7 @@ Renders detection performance figures for a set of .csv files created by [-evalD
229 229  
230 230 * **arguments:**
231 231  
232   - -plotDetection <file> ... <file> {destination}
  232 + -plotDetection <file> ... <file> {destination}
233 233  
234 234 * **wraps:** [br_plot_detection](c_api/functions.md#br_plot_detection)
235 235  
... ... @@ -239,7 +239,7 @@ Renders landmarking performance figures for a set of .csv files created by [-eva
239 239  
240 240 * **arguments:**
241 241  
242   - -plotLandmarking <file> ... <file> {destination}
  242 + -plotLandmarking <file> ... <file> {destination}
243 243  
244 244 * **wraps:** [br_plot_landmarking](c_api/functions.md#br_plot_landmarking)
245 245  
... ... @@ -249,7 +249,7 @@ Renders metadata figures for a set of .csv files with specified columns
249 249  
250 250 * **arguments:**
251 251  
252   - -plotMetadata <file> ... <file> <columns>
  252 + -plotMetadata <file> ... <file> <columns>
253 253  
254 254 * **wraps:** [br_plot_metadata](c_api/functions.md#br_plot_metadata)
255 255  
... ... @@ -259,7 +259,7 @@ A naive alternative to [-enroll](#enroll)
259 259  
260 260 * **arguments:**
261 261  
262   - -project <input_gallery> {output_gallery}
  262 + -project <input_gallery> {output_gallery}
263 263  
264 264 * **wraps:** [br_project](c_api/functions.md#br_project)
265 265  
... ... @@ -269,7 +269,7 @@ Retrieve the target and query inputs in the [BEE matrix](../tutorials.md#the-eva
269 269  
270 270 * **arguments:**
271 271  
272   - -getHeader <matrix>
  272 + -getHeader <matrix>
273 273  
274 274 * **wraps:** [br_get_header](c_api/functions.md#br_get_header)
275 275  
... ... @@ -279,7 +279,7 @@ Update the target and query inputs in the [BEE matrix](../tutorials.md#the-evalu
279 279  
280 280 * **arguments:**
281 281  
282   - -setHeader {<matrix>} <target_gallery> <query_gallery>
  282 + -setHeader {<matrix>} <target_gallery> <query_gallery>
283 283  
284 284 * **wraps:** [br_set_header](c_api/functions.md#br_set_header)
285 285  
... ... @@ -289,7 +289,7 @@ Appends a provided value to the [global metadata](cpp_api/context/context.md) us
289 289  
290 290 * **arguments:**
291 291  
292   - -<key> <value>
  292 + -<key> <value>
293 293  
294 294 * **wraps:** [br_set_property](c_api/functions.md#br_set_property)
295 295  
... ... @@ -302,7 +302,7 @@ Print command line API documentation to the terminal
302 302  
303 303 * **arguments:**
304 304  
305   - -help
  305 + -help
306 306  
307 307 * **wraps:** N/A
308 308  
... ... @@ -312,7 +312,7 @@ If this flag is set OpenBR will enable GUI windows to be launched. It must be th
312 312  
313 313 * **arguments:**
314 314  
315   - br -gui
  315 + br -gui
316 316  
317 317 * **wraps:** N/A
318 318  
... ... @@ -322,7 +322,7 @@ Returns names and parameters for the requested objects. Each object is newline s
322 322  
323 323 * **arguments:**
324 324  
325   - -objects [abstraction [implementation]]
  325 + -objects [abstraction [implementation]]
326 326  
327 327 * **wraps:** [br_objects](c_api/functions.md#br_objects)
328 328  
... ... @@ -332,7 +332,7 @@ Get a string with the name, version, and copyright of the project. This string i
332 332  
333 333 * **arguments:**
334 334  
335   - -about
  335 + -about
336 336  
337 337 * **wraps:** [br_about](c_api/functions.md#br_about)
338 338  
... ... @@ -342,7 +342,7 @@ Get the current OpenBR version
342 342  
343 343 * **arguments:**
344 344  
345   - -version
  345 + -version
346 346  
347 347 * **wraps:** [br_version](c_api/functions.md#br_version)
348 348  
... ... @@ -352,7 +352,7 @@ For internal use via [ProcessWrapperTransform](plugins/core.md#processwrappertra
352 352  
353 353 * **arguments:**
354 354  
355   - -slave <baseKey>
  355 + -slave <baseKey>
356 356  
357 357 * **wraps:** [br_slave_process](c_api/functions.md#br_slave_process)
358 358  
... ... @@ -362,7 +362,7 @@ DOCUMENT ME
362 362  
363 363 * **arguments:**
364 364  
365   - -daemon <daemon_pipe>
  365 + -daemon <daemon_pipe>
366 366  
367 367 * **wraps:** N/A
368 368  
... ... @@ -372,6 +372,6 @@ Exit the application
372 372  
373 373 * **arguments:**
374 374  
375   - -exit
  375 + -exit
376 376  
377 377 * **wraps:** N/A
... ...
docs/docs/api_docs/cpp_api/classifier/constructors.md
  View file @0bdd445
1 1 Constructor / Destructor | Description
2 2 --- | ---
3   -virtual ~Classifier() | Default destructor. It doesn' do anything.
4 3 \ No newline at end of file
  4 +virtual ~Classifier() | Default destructor. It doesn' do anything.
... ...
docs/docs/api_docs/cpp_api/classifier/functions.md
  View file @0bdd445
1 1 ## void train(const [QList][QList]&lt;[Mat][Mat]&gt; &images, const [QList][QList]&lt;float&gt; &labels) {: #train }
2 2  
3   -This is a pure, virtual function. Train the classifier using the provided images and labels.
  3 +This is a pure, virtual function. Train the classifier using the provided images and labels.
4 4  
5 5 * **function definition:**
6 6  
7   - virtual void train(const QList<Mat> &images, const QList<float> &labels) = 0
8   -
  7 + virtual void train(const QList<Mat> &images, const QList<float> &labels) = 0
  8 +
9 9 * **parameters:**
10 10  
11   - Parameter | Type | Descriptions
12   - --- | --- | ---
13   - images | const [QList][QList]&lt;[Mat][Mat]&gt; & | Training images
14   - labels | const [QList][QList]&lt;float&gt; & | Training labels
15   -
  11 + Parameter | Type | Descriptions
  12 + --- | --- | ---
  13 + images | const [QList][QList]&lt;[Mat][Mat]&gt; & | Training images
  14 + labels | const [QList][QList]&lt;float&gt; & | Training labels
  15 +
16 16 * **output:** (void)
17 17 * **example:**
18 18  
19   - // Create data for a 2-class classification problem
  19 + // Create data for a 2-class classification problem
20 20 QList<Mat> images = QList<Mat>() << Template("training_pic1.jpg").m()
21 21 << Template("training_pic2.jpg").m()
22 22 << Template("training_pic3.jpg").m()
... ... @@ -29,24 +29,24 @@ This is a pure, virtual function. Train the classifier using the provided images
29 29  
30 30 ## float classify(const [Mat][Mat] &image) const {: #classify }
31 31  
32   -This is a pure virtual function. Classify a provided input image.
  32 +This is a pure virtual function. Classify a provided input image.
33 33  
34 34 * **function description:**
35 35  
36   - virtual float classify(const Mat &image) const = 0
37   -
  36 + virtual float classify(const Mat &image) const = 0
  37 +
38 38 * **parameters:**
39   -
40   - Parameter | Type | Description
41   - --- | --- | ---
42   - image | const [Mat][Mat] & | Input image to be classified
43   -
44   -* **output:** (float) Returns the classification value of the image. The value can be a confidence, a regression, or a class. In 2-class classification is it often a confidence which has been normalized such that 0 is the inflection point. Values below zero represent a negative classification and values above represent a positive classification.
  39 +
  40 + Parameter | Type | Description
  41 + --- | --- | ---
  42 + image | const [Mat][Mat] & | Input image to be classified
  43 +
  44 +* **output:** (float) Returns the classification value of the image. The value can be a confidence, a regression, or a class. In 2-class classification is it often a confidence which has been normalized such that 0 is the inflection point. Values below zero represent a negative classification and values above represent a positive classification.
45 45 * **example:**
46   - Classifier *classifier = Classifier::make("2ClassClassifier"); // assume classifier is already trained
47   -
48   - Template p1("pos_image1.jpg"); // positive sample
49   - Template n1("neg_image1.jpg"); // negative sample
50   -
51   - classifier->classify(p1); // returns confidence > 0
52   - classifier->classify(n1); // returns confidence < 0
  46 + Classifier *classifier = Classifier::make("2ClassClassifier"); // assume classifier is already trained
  47 +
  48 + Template p1("pos_image1.jpg"); // positive sample
  49 + Template n1("neg_image1.jpg"); // negative sample
  50 +
  51 + classifier->classify(p1); // returns confidence > 0
  52 + classifier->classify(n1); // returns confidence < 0
... ...
docs/docs/api_docs/cpp_api/classifier/statics.md
  View file @0bdd445
... ... @@ -18,4 +18,4 @@ Make a [Classifier](classifier.md) from a string. The string is passed to [Facto
18 18 * **example:**
19 19  
20 20 Classifier *classifier = Classifier::make("Classifier(representation=Representation(property1=value1)");
21   - classifier->description(); // Returns "Classifier(representation=Representation(property1=value1))"
22 21 \ No newline at end of file
  22 + classifier->description(); // Returns "Classifier(representation=Representation(property1=value1))"
... ...
docs/docs/api_docs/cpp_api/compositetransform/constructors.md
  View file @0bdd445
1 1 Constructor | Description
2 2 --- | ---
3   -CompositeTransform() | Default constructor. Calls the [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md) [constructor](../timevaryingtransform/constructors.md) with [independent](../transform/members.md#independent) set to false.
4 3 \ No newline at end of file
  4 +CompositeTransform() | Default constructor. Calls the [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md) [constructor](../timevaryingtransform/constructors.md) with [independent](../transform/members.md#independent) set to false.
... ...
docs/docs/api_docs/cpp_api/compositetransform/functions.md
  View file @0bdd445
... ... @@ -27,7 +27,7 @@ If the transform is time varying call [timeInvariantAlias](../timevaryingtransfo
27 27 * **function definition:**
28 28  
29 29 virtual void project(const Template &src, Template &dst) const
30   -
  30 +
31 31 * **parameters:**
32 32  
33 33 Parameter | Type | Description
... ... @@ -44,7 +44,7 @@ If the transform is time varying call [timeInvariantAlias](../timevaryingtransfo
44 44 * **function definition:**
45 45  
46 46 virtual void project(const TemplateList &src, TemplateList &dst) const
47   -
  47 +
48 48 * **parameters:**
49 49  
50 50 Parameter | Type | Description
... ... @@ -118,4 +118,4 @@ Get a smart copy, meaning a copy only if one is required, of this transform
118 118 --- | --- | ---
119 119 newTransform | bool & | True if a new, simplified, transform was allocated inside this call, false otherwise
120 120  
121   -* **output:** ([Transform](../transform/transform.md) \*) Returns itself if [isTimeVarying](members.md#istimevarying) is false (no copy needed). newTransform is set to false in this case. If [isTimeVarying](members.md#istimevarying) is true, a new [CompositeTransform](compositetransform.md) is allocated and its children are set to the result of calling smartCopy on each of the old children. newTransform is true in this case.
122 121 \ No newline at end of file
  122 +* **output:** ([Transform](../transform/transform.md) \*) Returns itself if [isTimeVarying](members.md#istimevarying) is false (no copy needed). newTransform is set to false in this case. If [isTimeVarying](members.md#istimevarying) is true, a new [CompositeTransform](compositetransform.md) is allocated and its children are set to the result of calling smartCopy on each of the old children. newTransform is true in this case.
... ...
docs/docs/api_docs/cpp_api/compositetransform/members.md
  View file @0bdd445
1 1 Member | Type | Description
2 2 --- | --- | ---
3   -<a class="table-anchor" id="istimevarying"></a>isTimeVarying | bool | True if any child transform is time varying, false otherwise
4 3 \ No newline at end of file
  4 +<a class="table-anchor" id="istimevarying"></a>isTimeVarying | bool | True if any child transform is time varying, false otherwise
... ...
docs/docs/api_docs/cpp_api/distance/constructors.md
  View file @0bdd445
1 1 Constructor / Destructor | Description
2 2 --- | ---
3   -virtual ~Distance() | The default destructor. It doesn't do anything.
4 3 \ No newline at end of file
  4 +virtual ~Distance() | The default destructor. It doesn't do anything.
... ...
docs/docs/api_docs/cpp_api/factory/macros.md
  View file @0bdd445
... ... @@ -23,5 +23,3 @@ A special macro to register plugins in the [Factory](factory.md)::[registry](mem
23 23 };
24 24  
25 25 BR_REGISTER(Abstraction, Implementation)
26   -
27   -
... ...
docs/docs/api_docs/cpp_api/file/constructors.md
  View file @0bdd445
... ... @@ -7,4 +7,3 @@ File(const [QString][QString] &amp;file) | Initializes the file by calling the priva
7 7 File(const [QString][QString] &file, const [QVariant][QVariant] &label) | Initializes the file by calling the private function init. Append label to the [metadata](members.md#m_metadata) using the key "Label".
8 8 File(const char \*file) | Initializes the file with a c-style string.
9 9 File(const [QVariantMap][QVariantMap] &metadata) | Sets [name](members.md#name) to false and sets the [file metadata](members.md#m_metadata) to metadata.
10   -
... ...
docs/docs/api_docs/cpp_api/file/file.md
  View file @0bdd445
... ... @@ -62,4 +62,4 @@ Rects | QList&amp;lt;Rect&amp;gt; | List of unnamed rects
62 62 Age | float | Age used for demographic filtering
63 63 Gender | QString | Subject gender
64 64 Train | bool | The data is for training, as opposed to enrollment
65   -_\* | \* | Reserved for internal use
66 65 \ No newline at end of file
  66 +_\* | \* | Reserved for internal use
... ...
docs/docs/api_docs/cpp_api/filegallery/functions.md
  View file @0bdd445
... ... @@ -3,8 +3,8 @@
3 3 Initialize the [FileGallery](filegallery.md). This sets [f](members.md#f) using the file name from [file](../object/members.md#file). It also calls [Gallery](../gallery/gallery.md)::[init](../object/functions.md#init).
4 4  
5 5 * **function definition:**
6   -
7   - void init()
  6 +
  7 + void init()
8 8  
9 9 * **parameters:** NONE
10 10 * **output:** (void)
... ... @@ -14,8 +14,8 @@ Initialize the [FileGallery](filegallery.md). This sets [f](members.md#f) using
14 14 Get the total size of the file. This is useful for estimating progress.
15 15  
16 16 * **function definition:**
17   -
18   - qint64 totalSize()
  17 +
  18 + qint64 totalSize()
19 19  
20 20 * **parameters:** NONE
21 21 * **output:** (qint64) Returns the total size of the file in bytes
... ... @@ -26,7 +26,7 @@ Get the current index in the file. This is useful for reading and writing blocks
26 26  
27 27 * **function definition:**
28 28  
29   - qint64 position()
  29 + qint64 position()
30 30  
31 31 * **parameters:** NONE
32 32 * **output:** (qint64) Returns the current position in the file
... ... @@ -37,8 +37,8 @@ Open [f](members.md#f) in read-only mode
37 37  
38 38 * **function definition:**
39 39  
40   - bool readOpen()
41   -
  40 + bool readOpen()
  41 +
42 42 * **parameters:** NONE
43 43 * **output:** (bool) Returns true if the file was opened successfully, false otherwise
44 44  
... ... @@ -48,7 +48,7 @@ Open [f](members.md#f) in write-only mode
48 48  
49 49 * **function definition:**
50 50  
51   - void writeOpen()
  51 + void writeOpen()
52 52  
53 53 * **parameters:** NONE
54   -* **output:** (void)
55 54 \ No newline at end of file
  55 +* **output:** (void)
... ...
docs/docs/api_docs/cpp_api/format/statics.md
  View file @0bdd445
... ... @@ -39,4 +39,3 @@ Write a template to disk at the provided file location.
39 39 Template t("picture.jpg");
40 40  
41 41 Format::write("new_pic_location.jpg", t); // Write t to "new_pic_location.jpg"
42   -
... ...
docs/docs/api_docs/cpp_api/initializer/functions.md
  View file @0bdd445
... ... @@ -15,7 +15,7 @@ This is a virtual function. It is called once at the beginning of [finalize](../
15 15  
16 16 * **function definition**:
17 17  
18   - virtual void finalize() const
  18 + virtual void finalize() const
19 19  
20 20 * **parameters:** NONE
21   -* **output:** (void)
22 21 \ No newline at end of file
  22 +* **output:** (void)
... ...
docs/docs/api_docs/cpp_api/matrixoutput/functions.md
  View file @0bdd445
... ... @@ -4,25 +4,25 @@ Get a value in [data](members.md#data) as a string using a provided row and colu
4 4  
5 5 * **function definition:**
6 6  
7   - QString toString(int row, int column) const
  7 + QString toString(int row, int column) const
8 8  
9 9 * **parameters:**
10 10  
11   - Parameter | Type | Description
12   - --- | --- | ---
13   - row | int | Row index of value
14   - column | int | Column index of value
  11 + Parameter | Type | Description
  12 + --- | --- | ---
  13 + row | int | Row index of value
  14 + column | int | Column index of value
15 15  
16 16 * **output:** ([QString][QString]) Returns the value stored at (row, column) as a string
17 17 * **example:**
18 18  
19   - TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
20   - TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
  19 + TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
  20 + TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
21 21  
22   - MatrixOutput *output = MatrixOutput::make(targets, queries);
23   - output->set(10.0, 1, 2);
24   - output->toString(1, 2); // Returns "10"
25   - output->toString(2, 2); // ERROR: row index is out of range
  22 + MatrixOutput *output = MatrixOutput::make(targets, queries);
  23 + output->set(10.0, 1, 2);
  24 + output->toString(1, 2); // Returns "10"
  25 + output->toString(2, 2); // ERROR: row index is out of range
26 26  
27 27 ## void initialize(const [FileList](../filelist/filelist.md) &targetFiles, const [FileList](../filelist/filelist.md) &queryFiles) {: #initialize}
28 28  
... ... @@ -30,14 +30,14 @@ Initialize the output. This function calls [initialize](../output/functions.md#i
30 30  
31 31 * **function definition:**
32 32  
33   - void initialize(const FileList &targetFiles, const FileList &queryFiles)
  33 + void initialize(const FileList &targetFiles, const FileList &queryFiles)
34 34  
35 35 * **parameters:**
36 36  
37   - Parameter | Type | Description
38   - --- | --- | ---
39   - targetFiles | const [FileList](../filelist/filelist.md) & | List of target files for initialization
40   - queryFiles | const [FileList](../filelist/filelist.md) & | List of query files for initialization
  37 + Parameter | Type | Description
  38 + --- | --- | ---
  39 + targetFiles | const [FileList](../filelist/filelist.md) & | List of target files for initialization
  40 + queryFiles | const [FileList](../filelist/filelist.md) & | List of query files for initialization
41 41  
42 42 * **output:** (void)
43 43  
... ... @@ -48,25 +48,25 @@ Set a value in [data](members.md#data) at the provided row and column indices.
48 48  
49 49 * **function definition:**
50 50  
51   - void set(float value, int i, int j)
  51 + void set(float value, int i, int j)
52 52  
53 53 * **parameters:**
54 54  
55   - Parameter | Type | Description
56   - --- | --- | ---
57   - value | float | Value to be set
58   - i | int | Row index into [data](members.md#data)
59   - j | int | Column index into [data](members.md#data)
  55 + Parameter | Type | Description
  56 + --- | --- | ---
  57 + value | float | Value to be set
  58 + i | int | Row index into [data](members.md#data)
  59 + j | int | Column index into [data](members.md#data)
60 60  
61 61 * **output:** (void)
62 62 * **example:**
63 63  
64   - TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
65   - TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
  64 + TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
  65 + TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
66 66  
67   - MatrixOutput *output = MatrixOutput::make(targets, queries);
68   - output->set(6.0, 0, 1);
69   - output->toString(0, 1); // Returns "6.0"
  67 + MatrixOutput *output = MatrixOutput::make(targets, queries);
  68 + output->set(6.0, 0, 1);
  69 + output->toString(0, 1); // Returns "6.0"
70 70  
71   - output->set(10.0, 1, 2);
72   - output->toString(1, 2); // Returns "10.0"
  71 + output->set(10.0, 1, 2);
  72 + output->toString(1, 2); // Returns "10.0"
... ...
docs/docs/api_docs/cpp_api/matrixoutput/statics.md
  View file @0bdd445
... ... @@ -4,19 +4,19 @@ Make an [MatrixOutput](matrixoutput.md) from lists of target and query files. Th
4 4  
5 5 * **function definition:**
6 6  
7   - static MatrixOutput *make(const FileList &targetFiles, const FileList &queryFiles)
  7 + static MatrixOutput *make(const FileList &targetFiles, const FileList &queryFiles)
8 8  
9 9 * **parameters:**
10 10  
11   - Parameter | Type | Description
12   - --- | --- | ---
13   - targetFiles | const [FileList](../filelist/filelist.md) & | List of files representing the target templates
14   - queryFiles | const [FileList](../filelist/filelist.md) & | List of files representing the query templates
  11 + Parameter | Type | Description
  12 + --- | --- | ---
  13 + targetFiles | const [FileList](../filelist/filelist.md) & | List of files representing the target templates
  14 + queryFiles | const [FileList](../filelist/filelist.md) & | List of files representing the query templates
15 15  
16 16 * **output:** ([MatrixOutput](matrixoutput.md) \*) Returns a pointer to the first output in the linked list
17 17 * **example:**
18 18  
19   - TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
20   - TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
  19 + TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
  20 + TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
21 21  
22   - MatrixOutput *output = MatrixOutput::make(targets, queries); // returns a pointer to a MatrixOutput
  22 + MatrixOutput *output = MatrixOutput::make(targets, queries); // returns a pointer to a MatrixOutput
... ...
docs/docs/api_docs/cpp_api/metadatatransform/functions.md
  View file @0bdd445
... ... @@ -16,37 +16,37 @@ This is a pure virtual function. It must be overloaded by all derived classes. P
16 16 * **output:** (void)
17 17 * **example:**
18 18  
19   - class IncrementPropertyTransform : public MetadataTransform
20   - {
21   - Q_OBJECT
22   - Q_PROPERTY(QString key READ get_key WRITE set_key RESET reset_key STORED false)
23   - BR_PROPERTY(QString, key, "")
  19 + class IncrementPropertyTransform : public MetadataTransform
  20 + {
  21 + Q_OBJECT
  22 + Q_PROPERTY(QString key READ get_key WRITE set_key RESET reset_key STORED false)
  23 + BR_PROPERTY(QString, key, "")
24 24  
25   - void projectMetadata(const File &src, File &dst) const
26   - {
27   - dst = src;
28   - dst.set(key, src.get<int>(key, 0) + 1);
29   - }
30   - };
31   -
32   - BR_REGISTER(Transform, IncrementPropertyTransform)
  25 + void projectMetadata(const File &src, File &dst) const
  26 + {
  27 + dst = src;
  28 + dst.set(key, src.get<int>(key, 0) + 1);
  29 + }
  30 + };
33 31  
34   - MetadataTransform *m_transform = (MetadataTransform *)Transform::make("IncrementProperty(property1)", NULL);
  32 + BR_REGISTER(Transform, IncrementPropertyTransform)
35 33  
36   - File in("picture.jpg"), out;
37   - in.set("property1", 10);
  34 + MetadataTransform *m_transform = (MetadataTransform *)Transform::make("IncrementProperty(property1)", NULL);
38 35  
39   - m_transform->projectMetadata(in, out);
40   - out.flat(); // Returns "picture.jpg[property1=11]"
  36 + File in("picture.jpg"), out;
  37 + in.set("property1", 10);
  38 +
  39 + m_transform->projectMetadata(in, out);
  40 + out.flat(); // Returns "picture.jpg[property1=11]"
41 41  
42 42  
43 43 ## void project(const [Template](../template/template.md) &src, [Template](../template/template.md) &dst) {: #project }
44 44  
45   -Project a [Template](../template/template.md) through the transform by passing its [metadata](../template/members.md#file) through [projectMetadata](#projectmetadata) and storing the result in dst. All matrices in src are passed unchanged to dst.
  45 +Project a [Template](../template/template.md) through the transform by passing its [metadata](../template/members.md#file) through [projectMetadata](#projectmetadata) and storing the result in dst. All matrices in src are passed unchanged to dst.
46 46  
47 47 * **function definition:**
48 48  
49   - void project(const Template &src, Template &dst) const
  49 + void project(const Template &src, Template &dst) const
50 50  
51 51 * **parameters:**
52 52  
... ... @@ -55,4 +55,4 @@ Project a [Template](../template/template.md) through the transform by passing i
55 55 src | const [Template](../template/template.md) & | Input Template. It is immutable
56 56 dst | [Template](../template/template.md) & | Output Template. Should contain the modified data from the input template.
57 57  
58   -* **output:** (void)
59 58 \ No newline at end of file
  59 +* **output:** (void)
... ...
docs/docs/api_docs/cpp_api/metatransform/constructors.md
  View file @0bdd445
1 1 Constructor / Destructor | Description
2 2 --- | ---
3   -MetaTransform() | Construct a [MetaTransform](metatransform.md). This constructor calls the [Transform](../transform/transform.md) [constructor](../transform/constructors.md) with [independent](../transform/members.md#independent) set to false.
4 3 \ No newline at end of file
  4 +MetaTransform() | Construct a [MetaTransform](metatransform.md). This constructor calls the [Transform](../transform/transform.md) [constructor](../transform/constructors.md) with [independent](../transform/members.md#independent) set to false.
... ...
docs/docs/api_docs/cpp_api/object/macros.md
  View file @0bdd445
... ... @@ -29,4 +29,3 @@ This macro provides an extension to the [Qt Property System][Qt Property System]
29 29  
30 30 ...
31 31 };
32   -
... ...
docs/docs/api_docs/cpp_api/object/statics.md
  View file @0bdd445
... ... @@ -17,4 +17,3 @@ Split the provided string using the provided split character. Lexical scoping of
17 17 * **example:**
18 18  
19 19 Object::parse("Transform1(p1=v1,p2=v2),Transform2(p1=v3,p2=v4)"); // returns ["Transform1(p1=v1,p2=v2)", "Transform2(p1=v3,p2=v4)"]
20   -
... ...
docs/docs/api_docs/cpp_api/output/functions.md
  View file @0bdd445
... ... @@ -4,23 +4,23 @@ This is a virtual function. Initialize the output with provided target and query
4 4  
5 5 * **function definition:**
6 6  
7   - virtual void initialize(const [FileList](../filelist/filelist.md) &targetFiles, const [FileList](../filelist/filelist.md) &queryFiles)
  7 + virtual void initialize(const [FileList](../filelist/filelist.md) &targetFiles, const [FileList](../filelist/filelist.md) &queryFiles)
8 8  
9 9 * **parameters:**
10 10  
11   - Parameter | Type | Description
12   - --- | --- | ---
13   - targetFiles | const [FileList](../filelist/filelist.md) & | Target files to initialize the Output with
14   - queryFiles | const [FileList](../filelist/filelist.md) & | Query files to initialize the Output with
  11 + Parameter | Type | Description
  12 + --- | --- | ---
  13 + targetFiles | const [FileList](../filelist/filelist.md) & | Target files to initialize the Output with
  14 + queryFiles | const [FileList](../filelist/filelist.md) & | Query files to initialize the Output with
15 15  
16 16 * **output:** (void)
17 17 * **example:**
18 18  
19   - TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
20   - TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
  19 + TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
  20 + TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
21 21  
22   - Output *output = Factory::make<Output>("output.mtx");
23   - output->initialize(targets, queries); // This is the same as calling Output::make("output.mtx", targets, queries)
  22 + Output *output = Factory::make<Output>("output.mtx");
  23 + output->initialize(targets, queries); // This is the same as calling Output::make("output.mtx", targets, queries)
24 24  
25 25 ## void setBlock(int rowBlock, int columnBlock) {: #setblock }
26 26  
... ... @@ -28,14 +28,14 @@ This is a virtual function. Set the read offset of the Output.
28 28  
29 29 * **function definition:**
30 30  
31   - virtual void setBlock(int rowBlock, int columnBlock)
  31 + virtual void setBlock(int rowBlock, int columnBlock)
32 32  
33 33 * **parameters:**
34 34  
35   - Parameter | Type | Description
36   - --- | --- | ---
37   - rowBlock | int | Row position of the offset
38   - columnBlock | int | Column position of the offset
  35 + Parameter | Type | Description
  36 + --- | --- | ---
  37 + rowBlock | int | Row position of the offset
  38 + columnBlock | int | Column position of the offset
39 39  
40 40 * **output:** (void)
41 41  
... ... @@ -45,15 +45,15 @@ This is a virtual function. Set a value in the Output. **i** and **j** are *rela
45 45  
46 46 * **function definition:**
47 47  
48   - virtual void setRelative(float value, int i, int j)
  48 + virtual void setRelative(float value, int i, int j)
49 49  
50 50 * **parameters:**
51 51  
52   - Parameter | Type | Description
53   - --- | --- | ---
54   - value | float | Value to set in the output
55   - i | int | Row value relative to the current block
56   - j | int | Column value relative to the current block
  52 + Parameter | Type | Description
  53 + --- | --- | ---
  54 + value | float | Value to set in the output
  55 + i | int | Row value relative to the current block
  56 + j | int | Column value relative to the current block
57 57  
58 58 * **output:** (void)
59 59  
... ... @@ -64,14 +64,14 @@ This is a pure virtual function. Set a value in the output.
64 64  
65 65 * **function definition:**
66 66  
67   - virtual void set(float value, int i, int j) = 0
  67 + virtual void set(float value, int i, int j) = 0
68 68  
69 69 * **parameters:**
70 70  
71   - Parameter | Type | Description
72   - --- | --- | ---
73   - value | float | Value to be inserted into the output
74   - i | int | Row index to insert at
75   - j | int | Column index to insert at
  71 + Parameter | Type | Description
  72 + --- | --- | ---
  73 + value | float | Value to be inserted into the output
  74 + i | int | Row index to insert at
  75 + j | int | Column index to insert at
76 76  
77 77 * **output:** (void)
... ...
docs/docs/api_docs/cpp_api/output/members.md
  View file @0bdd445
... ... @@ -2,4 +2,4 @@ Member | Type | Description
2 2 --- | --- | ---
3 3 <a class="table-anchor" id=targetfiles></a>targetFiles | [FileList][../filelist/filelist.md] | List of files representing the target templates
4 4 <a class="table-anchor" id=queryfiles></a>queryFiles | [FileList](../filelist/filelist.md) | List of files representing the query templates
5   -<a class="table-anchor" id=selfsimilar></a>selfSimilar | bool | True if targetFiles == queryFiles, false otherwise
6 5 \ No newline at end of file
  6 +<a class="table-anchor" id=selfsimilar></a>selfSimilar | bool | True if targetFiles == queryFiles, false otherwise
... ...
docs/docs/api_docs/cpp_api/output/statics.md
  View file @0bdd445
... ... @@ -4,21 +4,21 @@ Make an [Output](output.md) from a string and lists of target and query files. T
4 4  
5 5 * **function definition:**
6 6  
7   - static Output *make(const File &file, const FileList &targetFiles, const FileList &queryFiles)
  7 + static Output *make(const File &file, const FileList &targetFiles, const FileList &queryFiles)
8 8  
9 9 * **parameters:**
10 10  
11   - Parameter | Type | Description
12   - --- | --- | ---
13   - file | const [File](../file/file.md) & | File describing the output or outputs to construct
14   - targetFiles | const [FileList](../filelist/filelist.md) & | List of files representing the target templates
15   - queryFiles | const [FileList](../filelist/filelist.md) & | List of files representing the query templates
  11 + Parameter | Type | Description
  12 + --- | --- | ---
  13 + file | const [File](../file/file.md) & | File describing the output or outputs to construct
  14 + targetFiles | const [FileList](../filelist/filelist.md) & | List of files representing the target templates
  15 + queryFiles | const [FileList](../filelist/filelist.md) & | List of files representing the query templates
16 16  
17 17 * **output:** ([Output](output.md) \*) Returns a pointer to the first output in the linked list
18 18 * **example:**
19 19  
20   - TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
21   - TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
  20 + TemplateList targets = TemplateList() << Template("target1.jpg") << Template("target2.jpg") << Template("target3.jpg");
  21 + TemplateList queries = TemplateList() << Template("query1.jpg") << Template("query2.jpg");
22 22  
23   - Output *output1 = Output::make("output.mtx", targets, queries); // returns a pointer to an Output at "output.mtx"
24   - Output *output2 = Output::make("output1.mtx;output2.mtx", targets, queries); // returns a pointer to the output created with "output1.mtx" with a pointer to the output created with "output2.mtx"
  23 + Output *output1 = Output::make("output.mtx", targets, queries); // returns a pointer to an Output at "output.mtx"
  24 + Output *output2 = Output::make("output1.mtx;output2.mtx", targets, queries); // returns a pointer to the output created with "output1.mtx" with a pointer to the output created with "output2.mtx"
... ...
docs/docs/api_docs/cpp_api/template/statics.md
  View file @0bdd445
... ... @@ -54,4 +54,4 @@ Deserialize a template
54 54  
55 55 out.file; // returns "picture.jpg"
56 56 out; // returns ["1"]
57   - }
58 57 \ No newline at end of file
  58 + }
... ...
docs/docs/api_docs/cpp_api/template/template.md
  View file @0bdd445
... ... @@ -19,4 +19,4 @@ in most cases templates have exactly one matrix in their list representing a sin
19 19 In the cases where exactly one image is expected, the template provides the function m() as an idiom for treating it as a single matrix.
20 20 Casting operators are also provided to pass the template into image processing functions expecting matrices.
21 21  
22   -Metadata related to the template that is computed during enrollment (ex. bounding boxes, eye locations, quality metrics, ...) should be assigned to the template's [File](members.md#file) member.
23 22 \ No newline at end of file
  23 +Metadata related to the template that is computed during enrollment (ex. bounding boxes, eye locations, quality metrics, ...) should be assigned to the template's [File](members.md#file) member.
... ...
docs/docs/api_docs/cpp_api/templatelist/statics.md
  View file @0bdd445
... ... @@ -63,4 +63,3 @@ Relabel the values associated with a given key in the [metadata](../file/members
63 63  
64 64 relabeled = TemplateList::relabel(tList, "Class", false);
65 65 relabeled.files(); // returns [[Class=1, Label=0], [Class=10, Label=1], [Class=100, Label=2]]
66   -
... ...
docs/docs/api_docs/cpp_api/timevaryingtransform/constructors.md
  View file @0bdd445
1 1 Constructor | Description
2 2 --- | ---
3   -TimeVaryingTransform(bool independent = true, bool trainable = true) | Default constructor. Calls [Transform](../transform/transform.md) [constructor](../transform/constructors.md) with the given value of [independent](../transform/members.md#independent) and [trainable](../transform/members.md#trainable). It also initializes [timeInvariantAlias](members.md#timeinvariantalias).
4 3 \ No newline at end of file
  4 +TimeVaryingTransform(bool independent = true, bool trainable = true) | Default constructor. Calls [Transform](../transform/transform.md) [constructor](../transform/constructors.md) with the given value of [independent](../transform/members.md#independent) and [trainable](../transform/members.md#trainable). It also initializes [timeInvariantAlias](members.md#timeinvariantalias).
... ...
docs/docs/api_docs/cpp_api/timevaryingtransform/functions.md
  View file @0bdd445
... ... @@ -4,7 +4,7 @@ This is a virtual function. Check if the transform is time varying. This always
4 4  
5 5 * **function definition:**
6 6  
7   - virtual bool timeVarying() const
  7 + virtual bool timeVarying() const
8 8  
9 9 * **parameters:** NONE
10 10 * **output:** (bool) Returns true (the transform is always time varying)
... ... @@ -15,14 +15,14 @@ This is a virtual function. For [TimeVaryingTransforms](timevaryingtransform.md)
15 15  
16 16 * **function definition:**
17 17  
18   - virtual void project(const Template &src, Template &dst) const
  18 + virtual void project(const Template &src, Template &dst) const
19 19  
20 20 * **parameters:**
21   -
22   - Parameter | Type | Description
23   - --- | --- | ---
24   - src | const [Template](../template/template.md) & | The input template
25   - dst | [Template](../template/template.md) & | The output template
  21 +
  22 + Parameter | Type | Description
  23 + --- | --- | ---
  24 + src | const [Template](../template/template.md) & | The input template
  25 + dst | [Template](../template/template.md) & | The output template
26 26  
27 27 * **output:** (void)
28 28  
... ... @@ -32,14 +32,14 @@ This is a virtual function. For [TimeVaryingTransforms](timevaryingtransform.md)
32 32  
33 33 * **function definition:**
34 34  
35   - virtual void project(const TemplateList &src, TemplateList &dst) const
  35 + virtual void project(const TemplateList &src, TemplateList &dst) const
36 36  
37 37 * **parameters:**
38   -
39   - Parameter | Type | Description
40   - --- | --- | ---
41   - src | const [TemplateList](../templatelist/templatelist.md) & | The input template list
42   - dst | [TemplateList](../templatelist/templatelist.md) & | The output template list
  38 +
  39 + Parameter | Type | Description
  40 + --- | --- | ---
  41 + src | const [TemplateList](../templatelist/templatelist.md) & | The input template list
  42 + dst | [TemplateList](../templatelist/templatelist.md) & | The output template list
43 43  
44 44 * **output:** (void)
45 45  
... ... @@ -49,15 +49,15 @@ This is a virtual function. This function should never be called because it is u
49 49  
50 50 * **function definition:**
51 51  
52   - virtual void projectUpdate(const Template &src, Template &dst)
  52 + virtual void projectUpdate(const Template &src, Template &dst)
53 53  
54 54 * **parameters:**
55 55  
56   - Parameter | Type | Description
57   - --- | --- | ---
58   - src | const [Template](../template/template.md) & | The input template
59   - dst | [Template](../template/template.md) & | The output template
60   -
  56 + Parameter | Type | Description
  57 + --- | --- | ---
  58 + src | const [Template](../template/template.md) & | The input template
  59 + dst | [Template](../template/template.md) & | The output template
  60 +
61 61 * **output:** (void)
62 62  
63 63 ## void projectUpdate(const [Template](../template/template.md) &src, [Template](../template/template.md) &dst) {: #projectupdate-1 }
... ... @@ -66,15 +66,15 @@ This is a virtual function. This function should never be called because it is u
66 66  
67 67 * **function definition:**
68 68  
69   - virtual void projectUpdate(const Template &src, Template &dst)
  69 + virtual void projectUpdate(const Template &src, Template &dst)
70 70  
71 71 * **parameters:**
72 72  
73   - Parameter | Type | Description
74   - --- | --- | ---
75   - src | const [Template](../template/template.md) & | The input template
76   - dst | [Template](../template/template.md) & | The output template
77   -
  73 + Parameter | Type | Description
  74 + --- | --- | ---
  75 + src | const [Template](../template/template.md) & | The input template
  76 + dst | [Template](../template/template.md) & | The output template
  77 +
78 78 * **output:** (void)
79 79  
80 80 ## void projectUpdate(const [Template](../template/template.md) &src, [Template](../template/template.md) &dst) {: #projectupdate-1 }
... ... @@ -83,15 +83,15 @@ This is a virtual function. This function should never be called because it is u
83 83  
84 84 * **function definition:**
85 85  
86   - virtual void projectUpdate(const Template &src, Template &dst)
  86 + virtual void projectUpdate(const Template &src, Template &dst)
87 87  
88 88 * **parameters:**
89 89  
90   - Parameter | Type | Description
91   - --- | --- | ---
92   - src | const [Template](../template/template.md) & | The input template
93   - dst | [Template](../template/template.md) & | The output template
94   -
  90 + Parameter | Type | Description
  91 + --- | --- | ---
  92 + src | const [Template](../template/template.md) & | The input template
  93 + dst | [Template](../template/template.md) & | The output template
  94 +
95 95 * **output:** (void)
96 96  
97 97 ## void projectUpdate(const [TemplateList](../templatelist/templatelist.md) &src, [TemplateList](../templatelist/templatelist.md) &dst) {: #projectupdate-2 }
... ... @@ -100,15 +100,15 @@ This is a virtual function. This is the non-const alternative to [project](../tr
100 100  
101 101 * **function definition:**
102 102  
103   - virtual void projectUpdate(const TemplateList &src, TemplateList &dst)
  103 + virtual void projectUpdate(const TemplateList &src, TemplateList &dst)
104 104  
105 105 * **parameters:**
106 106  
107   - Parameter | Type | Description
108   - --- | --- | ---
109   - src | const [TemplateList](../templatelist/templatelist.md) & | The input template list
110   - dst | [TemplateList](../templatelist/templatelist.md) & | The output template list
111   -
  107 + Parameter | Type | Description
  108 + --- | --- | ---
  109 + src | const [TemplateList](../templatelist/templatelist.md) & | The input template list
  110 + dst | [TemplateList](../templatelist/templatelist.md) & | The output template list
  111 +
112 112 * **output:** (void)
113 113  
114 114 ## [Transform](../transform/transform.md) \*smartCopy(bool &newTransform) {: #smartcopy }
... ... @@ -117,12 +117,12 @@ This is a virtual function. Make a smart copy of the transform.
117 117  
118 118 * **function definition:**
119 119  
120   - virtual Transform *smartCopy(bool &newTransform)
  120 + virtual Transform *smartCopy(bool &newTransform)
121 121  
122 122 * **parameters:**
123 123  
124   - Parameter | Type | Description
125   - --- | --- | ---
126   - newTransform | bool & | True if a new, simplified, transform was allocated inside this call, false otherwise
  124 + Parameter | Type | Description
  125 + --- | --- | ---
  126 + newTransform | bool & | True if a new, simplified, transform was allocated inside this call, false otherwise
127 127  
128   -* **output:** ([Transform](../transform/transform.md) \*) Returns a copy of itself by default. newTransform is set to true in this case.
129 128 \ No newline at end of file
  129 +* **output:** ([Transform](../transform/transform.md) \*) Returns a copy of itself by default. newTransform is set to true in this case.
... ...
docs/docs/api_docs/cpp_api/timevaryingtransform/members.md
  View file @0bdd445
1 1 Members | Type | Description
2 2 --- | --- | ---
3   -<a class="table-anchor" id="timeinvariantalias"></a> timeInvariantAlias | TimeInvariantWrapperTransform | A special case helper class that ensures usually thread safe calls like [project](../transform/functions.md#project-1) can be called non-thread safe objects. In a very simplified description, this calls [projectUpdate](functions.md#projectupdate-1) instead of [project](functions.md#project-1)
4 3 \ No newline at end of file
  4 +<a class="table-anchor" id="timeinvariantalias"></a> timeInvariantAlias | TimeInvariantWrapperTransform | A special case helper class that ensures usually thread safe calls like [project](../transform/functions.md#project-1) can be called non-thread safe objects. In a very simplified description, this calls [projectUpdate](functions.md#projectupdate-1) instead of [project](functions.md#project-1)
... ...
docs/docs/api_docs/cpp_api/transform/transform.md
  View file @0bdd445
... ... @@ -11,4 +11,4 @@ See:
11 11 * [Static Functions](statics.md)
12 12 * [Functions](functions.md)
13 13  
14   -Transforms support the idea of *training* and *projecting*, whereby they are (optionally) given example images and are expected learn how to transform new instances into an alternative, hopefully more useful, basis for the recognition task at hand. Transforms can be chained together to support the declaration and use of arbitrary algorithms at run time.
15 14 \ No newline at end of file
  15 +Transforms support the idea of *training* and *projecting*, whereby they are (optionally) given example images and are expected learn how to transform new instances into an alternative, hopefully more useful, basis for the recognition task at hand. Transforms can be chained together to support the declaration and use of arbitrary algorithms at run time.
... ...
docs/docs/api_docs/cpp_api/untrainablemetadatatransform/constructors.md
  View file @0bdd445
1 1 Constructor / Destructor | Description
2 2 --- | ---
3   -UntrainableMetadataTransform() | Construct an [UntrainableMetadataTransform](untrainablemetadatatransform.md). This constructor calls the [MetadataTransform](../metadatatransform/metadatatransform.md) [constructor](../metadatatransform/constructors.md) with [trainable](../transform/members.md#trainable) set to false.
4 3 \ No newline at end of file
  4 +UntrainableMetadataTransform() | Construct an [UntrainableMetadataTransform](untrainablemetadatatransform.md). This constructor calls the [MetadataTransform](../metadatatransform/metadatatransform.md) [constructor](../metadatatransform/constructors.md) with [trainable](../transform/members.md#trainable) set to false.
... ...
docs/docs/api_docs/cpp_api/untrainablemetatransform/constructors.md
  View file @0bdd445
1 1 Constructor / Destructor | Description
2 2 --- | ---
3   -UntrainableMetaTransform() | Construct an [UntrainableMetaTransform](untrainablemetatransform.md). This constructor calls the [UntrainableTransform](../untrainabletransform/untrainabletransform.md) [constructor](../untrainabletransform/constructors.md) with [independent](../transform/members.md#independent) set to false.
4 3 \ No newline at end of file
  4 +UntrainableMetaTransform() | Construct an [UntrainableMetaTransform](untrainablemetatransform.md). This constructor calls the [UntrainableTransform](../untrainabletransform/untrainabletransform.md) [constructor](../untrainabletransform/constructors.md) with [independent](../transform/members.md#independent) set to false.
... ...
docs/docs/api_docs/cpp_api/untrainabletransform/constructors.md
  View file @0bdd445
1 1 Constructor / Destructor | Description
2 2 --- | ---
3   -UntrainableTransform(bool independent = true) | Construct an [UntrainableTransform](untrainabletransform.md). This constructor calls the [Transform](../transform/transform.md) [constructor](../transform/constructors.md) with the provided value for [independent](../transform/members.md#independent) and [trainable](../transform/members.md#trainable) set to false.
4 3 \ No newline at end of file
  4 +UntrainableTransform(bool independent = true) | Construct an [UntrainableTransform](untrainabletransform.md). This constructor calls the [Transform](../transform/transform.md) [constructor](../transform/constructors.md) with the provided value for [independent](../transform/members.md#independent) and [trainable](../transform/members.md#trainable) set to false.
... ...
docs/docs/api_docs/cpp_api/wrappertransform/constructors.md
  View file @0bdd445
1 1 Constructor | Description
2 2 --- | ---
3   -WrapperTransform(bool independent = true) | Default constructor. Calls [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md) [constructor](../timevaryingtransform/constructors.md) with the given value for independent.
4 3 \ No newline at end of file
  4 +WrapperTransform(bool independent = true) | Default constructor. Calls [TimeVaryingTransform](../timevaryingtransform/timevaryingtransform.md) [constructor](../timevaryingtransform/constructors.md) with the given value for independent.
... ...
docs/docs/api_docs/cpp_api/wrappertransform/functions.md
  View file @0bdd445
... ... @@ -4,8 +4,8 @@ Check whether the transform is timeVarying.
4 4  
5 5 * **function definition:**
6 6  
7   - bool timeVarying() const
8   -
  7 + bool timeVarying() const
  8 +
9 9 * **parameters:** NONE
10 10 * **output:** (bool) Returns true if the [child transform](properties.md) is time varying, false otherwise
11 11  
... ... @@ -15,13 +15,13 @@ Call train on the child transform
15 15  
16 16 * **function defintion:**
17 17  
18   - void train(const QList<TemplateList> &data)
  18 + void train(const QList<TemplateList> &data)
19 19  
20 20 * **parameters:**
21 21  
22   - Parameter | Type | Description
23   - --- | --- | ---
24   - data | const [QList][QList]&lt;[TemplateList](../templatelist/templatelist.md)&gt; & | The training data
  22 + Parameter | Type | Description
  23 + --- | --- | ---
  24 + data | const [QList][QList]&lt;[TemplateList](../templatelist/templatelist.md)&gt; & | The training data
25 25  
26 26 * **output:** (void)
27 27  
... ... @@ -31,14 +31,14 @@ Call project on the child transform
31 31  
32 32 * **function definition:**
33 33  
34   - void project(const Template &src, Template &dst) const
  34 + void project(const Template &src, Template &dst) const
35 35  
36 36 * **parameters:**
37 37  
38   - Parameter | Type | Description
39   - --- | --- | ---
40   - src | const [Template](../template/template.md) & | The input template
41   - dst | [Template](../template/template.md) & | The output template
  38 + Parameter | Type | Description
  39 + --- | --- | ---
  40 + src | const [Template](../template/template.md) & | The input template
  41 + dst | [Template](../template/template.md) & | The output template
42 42  
43 43 * **output:** (void)
44 44  
... ... @@ -48,14 +48,14 @@ Call project on the child transform
48 48  
49 49 * **function definition:**
50 50  
51   - void project(const TemplateList &src, TemplateList &dst) const
  51 + void project(const TemplateList &src, TemplateList &dst) const
52 52  
53 53 * **parameters:**
54 54  
55   - Parameter | Type | Description
56   - --- | --- | ---
57   - src | const [TemplateList](../templatelist/templatelist.md) & | The input template list
58   - dst | [TemplateList](../templatelist/templatelist.md) & | The output template list
  55 + Parameter | Type | Description
  56 + --- | --- | ---
  57 + src | const [TemplateList](../templatelist/templatelist.md) & | The input template list
  58 + dst | [TemplateList](../templatelist/templatelist.md) & | The output template list
59 59  
60 60 * **output:** (void)
61 61  
... ... @@ -65,14 +65,14 @@ Call projectUpdate on the child transform
65 65  
66 66 * **function definition:**
67 67  
68   - void projectUpdate(const Template &src, Template &dst)
  68 + void projectUpdate(const Template &src, Template &dst)
69 69  
70 70 * **parameters:**
71 71  
72   - Parameter | Type | Description
73   - --- | --- | ---
74   - src | const [Template](../template/template.md) & | The input template
75   - dst | [Template](../template/template.md) & | The output template
  72 + Parameter | Type | Description
  73 + --- | --- | ---
  74 + src | const [Template](../template/template.md) & | The input template
  75 + dst | [Template](../template/template.md) & | The output template
76 76  
77 77 * **output:** (void)
78 78  
... ... @@ -82,24 +82,24 @@ Call projectUpdate on the child transform
82 82  
83 83 * **function definition:**
84 84  
85   - void projectUpdate(const TemplateList &src, TemplateList &dst)
  85 + void projectUpdate(const TemplateList &src, TemplateList &dst)
86 86  
87 87 * **parameters:**
88 88  
89   - Parameter | Type | Description
90   - --- | --- | ---
91   - src | const [TemplateList](../templatelist/templatelist.md) & | The input template list
92   - dst | [TemplateList](../templatelist/templatelist.md) & | The output template list
  89 + Parameter | Type | Description
  90 + --- | --- | ---
  91 + src | const [TemplateList](../templatelist/templatelist.md) & | The input template list
  92 + dst | [TemplateList](../templatelist/templatelist.md) & | The output template list
93 93  
94 94 * **output:** (void)
95 95  
96   -## void init() {: #init }
  96 +## void init() {: #init }
97 97  
98 98 Initialize the transform. Sets [trainable](../transform/members.md#trainable) to match the child transform (if the child is trainable so is the wrapper)
99 99  
100 100 * **function definition:**
101 101  
102   - void init()
  102 + void init()
103 103  
104 104 * **parameters:** NONE
105 105 * **output:** (void)
... ... @@ -110,13 +110,13 @@ This is a virtual function. Call finalize on the child transform
110 110  
111 111 * **function definition:**
112 112  
113   - virtual void finalize(TemplateList &output)
114   -
  113 + virtual void finalize(TemplateList &output)
  114 +
115 115 * **parameters:**
116 116  
117   - Parameter | Type | Description
118   - --- | --- | ---
119   - output | const [TemplateList](../templatelist/templatelist.md) & | The output to finalize
  117 + Parameter | Type | Description
  118 + --- | --- | ---
  119 + output | const [TemplateList](../templatelist/templatelist.md) & | The output to finalize
120 120  
121 121 * **output:** (void)
122 122  
... ... @@ -126,13 +126,13 @@ This is a virtual function. Calls simplify on the child transform.
126 126  
127 127 * **function definition:**
128 128  
129   - virtual Transform *simplify(bool &newTransform)
130   -
  129 + virtual Transform *simplify(bool &newTransform)
  130 +
131 131 * **parameters:**
132 132  
133   - Parameter | Type | Description
134   - --- | --- | ---
135   - newTransform | bool & | True if a new, simplified, transform was allocated inside this call, false otherwise
  133 + Parameter | Type | Description
  134 + --- | --- | ---
  135 + newTransform | bool & | True if a new, simplified, transform was allocated inside this call, false otherwise
136 136  
137 137 * **output:** ([Transform](../transform/transform.md) \*) Returns itself if the child transform cannot be simplified. newTransform is set to false in this case. If the child can be simplified, a new WrapperTransform is allocated with the child transform set as the simplified version of the old child transform. newTransform is set to true in this case
138 138  
... ... @@ -142,12 +142,12 @@ Get a smart copy, meaning a copy only if one is required, of this transform
142 142  
143 143 * **function definition:**
144 144  
145   - Transform *smartCopy(bool &newTransform)
  145 + Transform *smartCopy(bool &newTransform)
146 146  
147 147 * **parameters:**
148 148  
149   - Parameter | Type | Description
150   - --- | --- | ---
151   - newTransform | bool & | True if a new, simplified, transform was allocated inside this call, false otherwise
  149 + Parameter | Type | Description
  150 + --- | --- | ---
  151 + newTransform | bool & | True if a new, simplified, transform was allocated inside this call, false otherwise
152 152  
153   -* **output:** ([Transform](../transform/transform.md) \*) Returns itself if the child transform is not time varying (no copy needed). newTransform is set to false in this case. If the child is time varying make a copy by calling [smartCopy](../timevaryingtransform/functions.md#smartcopy) on the child. newTransform is set to true in this case.
154 153 \ No newline at end of file
  154 +* **output:** ([Transform](../transform/transform.md) \*) Returns itself if the child transform is not time varying (no copy needed). newTransform is set to false in this case. If the child is time varying make a copy by calling [smartCopy](../timevaryingtransform/functions.md#smartcopy) on the child. newTransform is set to true in this case.
... ...
docs/docs/api_docs/cpp_api/wrappertransform/properties.md
  View file @0bdd445
1 1 Property | Type | Description
2 2 --- | --- | ---
3   -transform | [Transform](../transform/transform.md) * | The child transform
4 3 \ No newline at end of file
  4 +transform | [Transform](../transform/transform.md) * | The child transform
... ...
docs/docs/contribute.md
  View file @0bdd445
... ... @@ -21,11 +21,11 @@ Some common mistakes that will stop your plugin from working!
21 21  
22 22 ### Documenting
23 23  
24   -Documenting your plugin is very important. OpenBR supports custom, doxygen-style, in-code comments to make documentation simple, clear, and easy. Comments should appear like
  24 +Documenting your plugin is very important. OpenBR supports custom, doxygen-style, in-code comments to make documentation simple, clear, and easy. Comments should appear like
25 25  
26   - /*!
27   - * ...
28   - */
  26 + /*!
  27 + * ...
  28 + */
29 29  
30 30 Comments are organized using tags, which are of the form <tt>\tag</tt>. There are a few **required** tags that all OpenBR transforms must have.
31 31  
... ... @@ -39,14 +39,14 @@ Tag | Description
39 39  
40 40 The mimimum comment would look like this
41 41  
42   - /*!
43   - * \ingroup abstraction group
44   - * \brief A description of the plugin
45   - * \author Your Name \cite Your Citation
46   - * \br_property percentage float The percentage of something
47   - * \br_property enum choice A choice with possible values: [choice1, choice2, choice3]
48   - */
49   -
  42 + /*!
  43 + * \ingroup abstraction group
  44 + * \brief A description of the plugin
  45 + * \author Your Name \cite Your Citation
  46 + * \br_property percentage float The percentage of something
  47 + * \br_property enum choice A choice with possible values: [choice1, choice2, choice3]
  48 + */
  49 +
50 50 There are also a few **optional** tags to provide more information.
51 51  
52 52 Tag | Description
... ... @@ -58,18 +58,18 @@ Tag | Description
58 58  
59 59 Optional tags could look like this
60 60  
61   - /*!
62   - * \br_link http://openbiometrics.org
63   - * \br_paper Author1, Author2, Author3
64   - * Paper Title
65   - * Conference. Year
66   - * \br_related_plugin ExampleTransform ExampleDistance ExampleGallery
67   - */
  61 + /*!
  62 + * \br_link http://openbiometrics.org
  63 + * \br_paper Author1, Author2, Author3
  64 + * Paper Title
  65 + * Conference. Year
  66 + * \br_related_plugin ExampleTransform ExampleDistance ExampleGallery
  67 + */
68 68  
69   -Finally, OpenBR supports automatic linking for abstractions found in comments. For example, Transform will automatically become [Transform](api_docs/cpp_api/transform/transform.md). Plural words like Transforms will also be linked but possesives like Tranform's will not.
  69 +Finally, OpenBR supports automatic linking for abstractions found in comments. For example, Transform will automatically become [Transform](api_docs/cpp_api/transform/transform.md). Plural words like Transforms will also be linked but possesives like Tranform's will not.
70 70  
71 71 ---
72   -
  72 +
73 73 ## Contributing to the API
74 74  
75 75 You should contribute to the API if you want to add a new abstraction or extend an existing abstraction with new functionality. Please note, this occurs *very* *very* rarely. Our goal is to leave the core API as stable and consistent as possible and change only the surrounding plugins. If you believe your idea offers exciting new functionality or greatly increases efficiency please [open an issue](https://github.com/biometrics/openbr/issues) so that it can be discussed as a community.
... ... @@ -125,4 +125,4 @@ Use `static` function declarations whenever possible but `static` variables spar
125 125 }
126 126  
127 127 ### Indentation
128   -4 spaces, no tabs.
129 128 \ No newline at end of file
  129 +4 spaces, no tabs.
... ...
docs/docs/papers.md deleted
View file @1a784fc
1   -# Related Publications
2   -
3   -Please consider adding your OpenBR-related publication to this list by [submitting a pull request!](https://github.com/biometrics/openbr/pulls).
4   -
5   ----
6   -
7   -## 2015
8   -
9   ----
10   -
11   -## 2014
12   -
13   ----
14   -
15   -## 2013
16   -
17   ----
18   -
19   -## 2012
20   -
21   ----
22   -
23   -## 2011
docs/docs/tutorials.md
  View file @0bdd445
... ... @@ -82,23 +82,23 @@ One of the first steps when converting the template enrollment description into
82 82  
83 83 After operator expansion, the template enrollment description forms a tree, and the transform is constructed from this description starting recursively starting at the root of the tree:
84 84  
85   - Transform *transform = Factory<Transform>::make("." + str);
  85 + Transform *transform = Factory<Transform>::make("." + str);
86 86  
87 87 Let's use the algorithm in ```scripts/helloWorld.sh``` as an example. The algorithm is:
88 88  
89   - Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(128,128,0.33,0.45)+CvtFloat+PCA(0.95):Dist(L2)
  89 + Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(128,128,0.33,0.45)+CvtFloat+PCA(0.95):Dist(L2)
90 90  
91 91 So what is happening here? Let's expand this using our new knowledge of OpenBR's algorithm syntax. First, the algorithm will be split into enrollment and comparison portions at the **:**. So enrollment becomes-
92 92  
93   - Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(128,128,0.33,0.45)+CvtFloat+PCA(0.95)
  93 + Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(128,128,0.33,0.45)+CvtFloat+PCA(0.95)
94 94  
95 95 and comparison is-
96 96  
97   - Dist(L2)
  97 + Dist(L2)
98 98  
99 99 On the enrollment side the **+'s** are converted into a [PipeTransform](api_docs/plugins/core.md#pipetransform) with the other plugins as children. Enrollment is transformed to
100 100  
101   - Pipe(transforms=[Open,Cvt(Gray),Cascade(FrontalFace),ASEFEyes,Affine(128,128,0.33,0.45,CvtFloat,PCA(0.95)])
  101 + Pipe(transforms=[Open,Cvt(Gray),Cascade(FrontalFace),ASEFEyes,Affine(128,128,0.33,0.45,CvtFloat,PCA(0.95)])
102 102  
103 103 If you want all the tedious details about what exactly this algoritm does, then you should read the [project](api_docs/cpp_api/transform/functions.md#project-1) function implemented by each of these plugins.
104 104 The brief explanation is that it *reads the image from disk, converts it to grayscale, runs the face detector, runs the eye detector on any detected faces, uses the eye locations to normalize the face for rotation and scale, converts to floating point format, and then embeds it in a PCA subspaced trained on face images*.
... ... @@ -133,48 +133,48 @@ This tutorial gives an example on how to perform face recognition in OpenBR. Ope
133 133  
134 134 To start, lets run face recognition from the command line. Open the terminal and enter
135 135  
136   - $ br -algorithm FaceRecognition \
137   - -compare ../data/MEDS/img/S354-01-t10_01.jpg ../data/MEDS/img/S354-02-t10_01.jpg \
138   - -compare ../data/MEDS/img/S354-01-t10_01.jpg ../data/MEDS/img/S386-04-t10_01.jpg
  136 + $ br -algorithm FaceRecognition \
  137 + -compare ../data/MEDS/img/S354-01-t10_01.jpg ../data/MEDS/img/S354-02-t10_01.jpg \
  138 + -compare ../data/MEDS/img/S354-01-t10_01.jpg ../data/MEDS/img/S386-04-t10_01.jpg
139 139  
140 140 Easy enough? You should see results printed to terminal that look like
141 141  
142   - $ Set algorithm to FaceRecognition
143   - $ Loading /usr/local/share/openbr/models/algorithms/FaceRecognition
144   - $ Loading /usr/local/share/openbr/models/transforms//FaceRecognitionExtraction
145   - $ Loading /usr/local/share/openbr/models/transforms//FaceRecognitionEmbedding
146   - $ Loading /usr/local/share/openbr/models/transforms//FaceRecognitionQuantization
147   - $Comparing ../data/MEDS/img/S354-01-t10_01.jpg and ../data/MEDS/img/S354-02-t10_01.jpg
148   - $ Enrolling ../data/MEDS/img/S354-01-t10_01.jpg to S354-01-t10_01r7Rv4W.mem
149   - $ 100.00% ELAPSED=00:00:00 REMAINING=00:00:00 COUNT=1
150   - $ 100.00% ELAPSED=00:00:00 REMAINING=00:00:00 COUNT=1
151   - $ 1.8812
152   - $ Comparing ../data/MEDS/img/S354-01-t10_01.jpg and ../data/MEDS/img/S386-04-t10_01.jpg
153   - $ Enrolling ../data/MEDS/img/S354-01-t10_01.jpg to S354-01-t10_01r7Rv4W.mem
154   - $ 100.00% ELAPSED=00:00:00 REMAINING=00:00:00 COUNT=1
155   - $ 100.00% ELAPSED=00:00:00 REMAINING=00:00:00 COUNT=1
156   - $ 0.571219
  142 + $ Set algorithm to FaceRecognition
  143 + $ Loading /usr/local/share/openbr/models/algorithms/FaceRecognition
  144 + $ Loading /usr/local/share/openbr/models/transforms//FaceRecognitionExtraction
  145 + $ Loading /usr/local/share/openbr/models/transforms//FaceRecognitionEmbedding
  146 + $ Loading /usr/local/share/openbr/models/transforms//FaceRecognitionQuantization
  147 + $Comparing ../data/MEDS/img/S354-01-t10_01.jpg and ../data/MEDS/img/S354-02-t10_01.jpg
  148 + $ Enrolling ../data/MEDS/img/S354-01-t10_01.jpg to S354-01-t10_01r7Rv4W.mem
  149 + $ 100.00% ELAPSED=00:00:00 REMAINING=00:00:00 COUNT=1
  150 + $ 100.00% ELAPSED=00:00:00 REMAINING=00:00:00 COUNT=1
  151 + $ 1.8812
  152 + $ Comparing ../data/MEDS/img/S354-01-t10_01.jpg and ../data/MEDS/img/S386-04-t10_01.jpg
  153 + $ Enrolling ../data/MEDS/img/S354-01-t10_01.jpg to S354-01-t10_01r7Rv4W.mem
  154 + $ 100.00% ELAPSED=00:00:00 REMAINING=00:00:00 COUNT=1
  155 + $ 100.00% ELAPSED=00:00:00 REMAINING=00:00:00 COUNT=1
  156 + $ 0.571219
157 157  
158 158 So what is 'FaceRecognition'? It's an abbrieviation to make running the algorithm easier. All of the algorithm abbreviations are located in ```openbr/plugins/core/algorithms.cpp```, please see the previous tutorial for an introduction to OpenBR's algorithm grammar.
159 159  
160 160 It also possible to perform face recognition evaluation (**note:** this requires [R][R] to be installed)-
161 161  
162   - $ br -algorithm FaceRecognition -path ../data/MEDS/img/ \
163   - -enroll ../data/MEDS/sigset/MEDS_frontal_target.xml target.gal \
164   - -enroll ../data/MEDS/sigset/MEDS_frontal_query.xml query.gal \
165   - -compare target.gal query.gal scores.mtx \
166   - -makeMask ../data/MEDS/sigset/MEDS_frontal_target.xml ../data/MEDS/sigset/MEDS_frontal_query.xml MEDS.mask \
167   - -eval scores.mtx MEDS.mask Algorithm_Dataset/FaceRecognition_MEDS.csv \
168   - -plot Algorithm_Dataset/FaceRecognition_MEDS.csv MEDS
  162 + $ br -algorithm FaceRecognition -path ../data/MEDS/img/ \
  163 + -enroll ../data/MEDS/sigset/MEDS_frontal_target.xml target.gal \
  164 + -enroll ../data/MEDS/sigset/MEDS_frontal_query.xml query.gal \
  165 + -compare target.gal query.gal scores.mtx \
  166 + -makeMask ../data/MEDS/sigset/MEDS_frontal_target.xml ../data/MEDS/sigset/MEDS_frontal_query.xml MEDS.mask \
  167 + -eval scores.mtx MEDS.mask Algorithm_Dataset/FaceRecognition_MEDS.csv \
  168 + -plot Algorithm_Dataset/FaceRecognition_MEDS.csv MEDS
169 169  
170 170 face recognition search-
171 171  
172   - $ br -algorithm FaceRecognition -enrollAll -enroll ../data/MEDS/img 'meds.gal;meds.csv[separator=;]'
173   - $ br -algorithm FaceRecognition -compare meds.gal ../data/MEDS/img/S001-01-t10_01.jpg match_scores.csv
  172 + $ br -algorithm FaceRecognition -enrollAll -enroll ../data/MEDS/img 'meds.gal;meds.csv[separator=;]'
  173 + $ br -algorithm FaceRecognition -compare meds.gal ../data/MEDS/img/S001-01-t10_01.jpg match_scores.csv
174 174  
175 175 and face recognition training-
176 176  
177   - $ br -algorithm 'Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(128,128,0.33,0.45)+(Grid(10,10)+SIFTDescriptor(12)+ByRow)/(Blur(1.1)+Gamma(0.2)+DoG(1,2)+ContrastEq(0.1,10)+LBP(1,2)+RectRegions(8,8,6,6)+Hist(59))+PCA(0.95)+Normalize(L2)+Dup(12)+RndSubspace(0.05,1)+LDA(0.98)+Cat+PCA(0.95)+Normalize(L1)+Quantize:NegativeLogPlusOne(ByteL1)' -train ../data/ATT/img FaceRecognitionATT
  177 + $ br -algorithm 'Open+Cvt(Gray)+Cascade(FrontalFace)+ASEFEyes+Affine(128,128,0.33,0.45)+(Grid(10,10)+SIFTDescriptor(12)+ByRow)/(Blur(1.1)+Gamma(0.2)+DoG(1,2)+ContrastEq(0.1,10)+LBP(1,2)+RectRegions(8,8,6,6)+Hist(59))+PCA(0.95)+Normalize(L2)+Dup(12)+RndSubspace(0.05,1)+LDA(0.98)+Cat+PCA(0.95)+Normalize(L1)+Quantize:NegativeLogPlusOne(ByteL1)' -train ../data/ATT/img FaceRecognitionATT
178 178  
179 179 all right from the command line! The entire command line API is documented [here](api_docs/cl_api.md). It is a powerful tool for creating and testing new algorithms.
180 180  
... ... @@ -182,38 +182,38 @@ The command line isn&#39;t perfect for all situations however. So OpenBR exposes a [
182 182  
183 183 Our main function starts with-
184 184  
185   - br::Context::initialize(argc, argv)
  185 + br::Context::initialize(argc, argv)
186 186  
187 187 This is the first step in any OpenBR application, it initializes the global context.
188 188  
189   - QSharedPointer<br::Transform> transform = br::Transform::fromAlgorithm("FaceRecognition");
  189 + QSharedPointer<br::Transform> transform = br::Transform::fromAlgorithm("FaceRecognition");
190 190 QSharedPointer<br::Distance> distance = br::Distance::fromAlgorithm("FaceRecognition");
191 191  
192 192 Here, we split our algorithm into *enrollment* ([Transform](api_docs/cpp_api/transform/transform.md)::[fromAlgorithm](api_docs/cpp_api/transform/statics.md#fromalgorithm)) and *comparison* ([Distance](api_docs/cpp_api/distance/distance.md)::[fromAlgorithm](api_docs/cpp_api/distance/statics.md#fromalgorithm))
193 193  
194   - br::Template queryA("../data/MEDS/img/S354-01-t10_01.jpg");
  194 + br::Template queryA("../data/MEDS/img/S354-01-t10_01.jpg");
195 195 br::Template queryB("../data/MEDS/img/S382-08-t10_01.jpg");
196 196 br::Template target("../data/MEDS/img/S354-02-t10_01.jpg");
197 197  
198 198 These lines create our [Templates](api_docs/cpp_api/template/template.md) for enrollment. They are just images loaded from disk. For this example queryA is the same person (different picture) as target and queryB is a different person.
199 199  
200   - queryA >> *transform;
  200 + queryA >> *transform;
201 201 queryB >> *transform;
202 202 target >> *transform;
203 203  
204 204 And now we enroll them! **>>** is a convienience operator for enrolling [Templates](api_docs/cpp_api/template/template.md) in [Transforms](api_docs/cpp_api/transform/transform.md). The enrollment is done in-place, which means the output overwrites the input. Our [Templates](api_docs/cpp_api/template/template.md) now store the results of enrollment.
205 205  
206   - float comparisonA = distance->compare(target, queryA);
  206 + float comparisonA = distance->compare(target, queryA);
207 207 float comparisonB = distance->compare(target, queryB);
208 208  
209 209 Compare our query [Templates](api_docs/cpp_api/template/template.md) against the target [Template](api_docs/cpp_api/template/template.md). The result is a float.
210 210  
211   - printf("Genuine match score: %.3f\n", comparisonA);
  211 + printf("Genuine match score: %.3f\n", comparisonA);
212 212 printf("Impostor match score: %.3f\n", comparisonB);
213 213  
214 214 Print out our results. You can see that comparisonA (between queryA and target) has a higher score then comparisonB, which is exactly what we expect!
215 215  
216   - br::Context::finalize();
  216 + br::Context::finalize();
217 217  
218 218 The last line in any OpenBR application has to be call to finalize. This shuts down OpenBR.
219 219  
... ... @@ -251,8 +251,8 @@ The source code to run gender estimation as an application is in ```app/examples
251 251  
252 252  
253 253 [^1]: *Matthew Turk and Alex Pentland.*
254   - **Eigenfaces for recognition.**
255   - Journal of Cognitive Neuroscience, 71&#45;86, 1991 <!-- Don't know why I have to use the &#45; code instead of '-' -->
  254 + **Eigenfaces for recognition.**
  255 + Journal of Cognitive Neuroscience, 71&#45;86, 1991 <!-- Don't know why I have to use the &#45; code instead of '-' -->
256 256 [^2]: *B. Klare.*
257   - **Spectrally sampled structural subspace features (4SF).**
258   - In Michigan State University Technical Report, MSUCSE-11-16, 2011
  257 + **Spectrally sampled structural subspace features (4SF).**
  258 + In Michigan State University Technical Report, MSUCSE-11-16, 2011
... ...
docs/scripts/check_format_cpp.py deleted
View file @1a784fc
docs/scripts/generate_api_class_doc.py deleted
View file @1a784fc
1   -# This script is intended to take an API-style class from OpenBR and output
2   -# structured Markdown text in the OpenBR documentation format. The class details
3   -# should then be filled in.
4   -
5   -import sys
6   -import re
7   -
8   -def find_name_parent(content):
9   - name_re = re.compile('class(.*?):')
10   - name = name_re.search(content).group()[:-1].strip().split(' ')[-1]
11   -
12   - parent_re = re.compile('public.*')
13   - parent = parent_re.search(content).group().strip().split(' ')[-1]
14   -
15   - return name, parent
16   -
17   -def find_properties(content):
18   - properties = []
19   -
20   - property_re = re.compile('Q_PROPERTY\((.*?)\)')
21   - it = property_re.finditer(content)
22   - for prop in it:
23   - prop_type = prop.group()[11:-1].split(' ')[0]
24   - prop_name = prop.group()[11:-1].split(' ')[1]
25   - properties.append((prop_name, prop_type))
26   -
27   - return properties
28   -
29   -def find_members(content):
30   - members = []
31   -
32   - member_re = re.compile('(\w+(<\w+>)*)\s(\w+);')
33   - it = member_re.finditer(content)
34   - for member in it:
35   - member_type = member.group()[:-1].strip().split(' ')[0]
36   - member_name = member.group()[:-1].strip().split(' ')[1]
37   - members.append((member_name, member_type))
38   -
39   - return members
40   -
41   -def find_constructors(name, content):
42   - constructors = []
43   -
44   - constructor_re = re.compile('(.*)' + name + '\(\)')
45   - it = constructor_re.finditer(content)
46   - for constructor in it:
47   - constructors.append(constructor.group().strip())
48   -
49   - return constructors
50   -
51   -def find_functions(content):
52   - functions = []
53   -
54   - function_re = re.compile('(.*)[^PROPERTY]\(.*\).*;')
55   - it = function_re.finditer(content)
56   - for func in it:
57   - function = {}
58   -
59   - function['Full'] = func.group()[:-1].strip() #don't include semi colon
60   -
61   - func_split = func.group().strip().split(' ')
62   - if func_split[0] == "static":
63   - function['Type'] = 'static'
64   - function['Return'] = func_split[1]
65   - function['Name'] = func_split[2].split('(')[0]
66   - elif func_split[0] == "virtual":
67   - function['Type'] = 'virtual'
68   - function['Return'] = func_split[1]
69   - function['Name'] = func_split[2].split('(')[0]
70   - else:
71   - function['Type'] = 'normal'
72   - function['Return'] = func_split[0]
73   - function['Name'] = func_split[1].split('(')[0]
74   -
75   - args = []
76   -
77   - args_list = func.group()[func.group().find('(')+1:func.group().find(')')].split(',')
78   - for arg in args_list:
79   - arg = arg.strip()
80   - split_idx = arg.rfind(' ')
81   - if arg[split_idx:].strip()[0] == '*' or arg[split_idx:].strip()[0] == '&':
82   - split_idx += 2
83   -
84   - args.append((arg[split_idx:].strip(), arg[:split_idx].strip()))
85   -
86   - function['Args'] = args
87   -
88   - functions.append(function)
89   -
90   - return functions
91   -
92   -def parse(content):
93   - name, parent = find_name_parent(content)
94   - properties = find_properties(content)
95   - members = find_members(content)
96   - constructors = find_constructors(name, content)
97   - functions = find_functions(content)
98   -
99   - return name, parent, properties, members, constructors, functions
100   -
101   -def function_builder(name, function):
102   - markdown = ""
103   -
104   - markdown += "### " + function["Full"] + " {: #" + name.lower() + "-function-" + function['Name'].lower() + "}\n\n"
105   - markdown += "DOCUMENT ME\n\n"
106   -
107   - markdown += "* **function definition:**\n\n"
108   - markdown += "\t\t" + function['Full'] + "\n\n"
109   -
110   - markdown += "* **parameters:**"
111   - if len(function['Args']) == 0:
112   - markdown += " NONE\n"
113   - else:
114   - markdown += "\n\n"
115   - markdown += "\tParameter | Type | Description\n"
116   - markdown += "\t--- | --- | ---\n"
117   - for arg in function['Args']:
118   - markdown += "\t" + arg[0] + " | " + arg[1] + " | DOCUMENT ME\n"
119   - markdown += "\n"
120   -
121   - markdown += "* **output:** (" + function['Return'] + ") DOCUMENT ME\n\n\n"
122   -
123   - return markdown
124   -
125   -def format_md(name, parent, properties, members, constructors, functions):
126   - markdown = ""
127   -
128   - markdown += "# " + name + "\n\n"
129   - markdown += "Inherits from [" + parent + "](#" + parent.lower() + ")\n\n"
130   -
131   - markdown += "## Properties {: #" + name.lower() + "-properties }\n\n"
132   - if len(properties) == 0:
133   - markdown += "NONE\n\n"
134   - else:
135   - markdown += "Property | Type | Description\n"
136   - markdown += "--- | --- | ---\n"
137   - for prop in properties:
138   - markdown += '<a class="table-anchor" id=' + name.lower() + '-properties-' + prop[0].lower() + '></a>'
139   - markdown += prop[0] + " | " + prop[1] + " | DOCUMENT ME\n"
140   - markdown += "\n"
141   -
142   - markdown += "## Members {: #" + name.lower() + "-members }\n\n"
143   - if len(members) == 0:
144   - markdown += "NONE\n\n"
145   - else:
146   - markdown += "Member | Type | Description\n"
147   - markdown += "--- | --- | ---\n"
148   - for member in members:
149   - markdown += '<a class="table-anchor" id=' + name.lower() + '-members-' + member[0].lower() + '></a>'
150   - markdown += member[0] + " | " + member[1] + " | DOCUMENT ME\n"
151   - markdown += "\n"
152   -
153   - markdown += "## Constructors {: #" + name.lower() + "-constructors }\n\n"
154   - if len(constructors) == 0:
155   - markdown += "NONE\n\n"
156   - else:
157   - markdown += "Constructor \| Destructor | Description\n"
158   - markdown += "--- | ---\n"
159   - for constructor in constructors:
160   - markdown += constructor + " | DOCUMENT ME\n"
161   - markdown += "\n"
162   -
163   - markdown += "## Static Functions {: #" + name.lower() + "-static-functions }\n\n"
164   - for function in functions:
165   - if function['Type'] == 'static':
166   - markdown += function_builder(name, function)
167   -
168   - markdown += "## Functions {: #" + name.lower() + "-functions }\n\n"
169   - for function in functions:
170   - if not function['Type'] == 'static':
171   - markdown += function_builder(name, function)
172   -
173   - return markdown
174   -
175   -def main():
176   - if len(sys.argv) != 3:
177   - print 'Inputs => class documentation'
178   - sys.exit(1)
179   -
180   - class_file = open(sys.argv[1], 'r')
181   - doc_file = open(sys.argv[2], 'w+')
182   -
183   - name, parent, properties, members, constructors, functions = parse(class_file.read())
184   -
185   - doc_file.write(format_md(name, parent, properties, members, constructors, functions))
186   -
187   -main()
docs/scripts/generate_plugin_docs.py
  View file @0bdd445
... ... @@ -95,7 +95,7 @@ def parseLinks(links):
95 95 if len(links) > 1:
96 96 output += "\n\n"
97 97 for link in links:
98   - output += "\t* [" + link + "](" + link + ")\n"
  98 + output += " * [" + link + "](" + link + ")\n"
99 99 output += "\n"
100 100 else:
101 101 output += " [" + links[0] + "](" + links[0] + ")\n"
... ... @@ -117,11 +117,11 @@ def parsePapers(papers):
117 117 if len(info) >= 3:
118 118 other = info[2].strip()
119 119  
120   - output += "\t" + str(i+1) + ". *" + authors + "*\n"
  120 + output += " " + str(i+1) + ". *" + authors + "*\n"
121 121 if title:
122   - output += "\t **" + title + "**\n"
  122 + output += " **" + title + "**\n"
123 123 if other:
124   - output += "\t " + other + "\n"
  124 + output += " " + other + "\n"
125 125 output += "\n"
126 126  
127 127 return output
... ... @@ -148,8 +148,8 @@ def parseProperties(properties):
148 148 return "* **properties:** None\n\n"
149 149  
150 150 output = "* **properties:**\n\n"
151   - output += "\tProperty | Type | Description\n"
152   - output += "\t--- | --- | ---\n"
  151 + output += " Property | Type | Description\n"
  152 + output += " --- | --- | ---\n"
153 153 for prop in properties:
154 154 split = prop.split(' ')
155 155 ty = split[0]
... ... @@ -172,7 +172,7 @@ def parseProperties(properties):
172 172 desc = before.strip() + table + after.strip()
173 173 table_match = table_regex.search(desc)
174 174  
175   - output += "\t" + name + " | " + ty + " | " + desc + "\n"
  175 + output += " " + name + " | " + ty + " | " + desc + "\n"
176 176  
177 177 return output
178 178  
... ...