Commit 5e09fc1ced6cf8ae0e58df93d81e9e9b37fb4e43
1 parent
74df0715
Working with stock mkdocs
Showing
53 changed files
with
264 additions
and
73 deletions
docs/docs/api_docs/c_api/functions.md
| ... | ... | @@ -1391,3 +1391,7 @@ Close a provided [Gallery](../cpp_api/gallery/gallery.md). |
| 1391 | 1391 | [^1]: *Zhu et al.* |
| 1392 | 1392 | **A Rank-Order Distance based Clustering Algorithm for Face Tagging**, |
| 1393 | 1393 | CVPR 2011 |
| 1394 | + | |
| 1395 | +<!-- Links --> | |
| 1396 | +[R]: http://www.r-project.org/ "R" | |
| 1397 | +[QRegExp]: http://doc.qt.io/qt-5/QRegExp.html "QRegExp" | ... | ... |
docs/docs/api_docs/cl_api.md
docs/docs/api_docs/cpp_api/apifunctions.md
| ... | ... | @@ -283,3 +283,7 @@ Deduplicate a gallery. A duplicate is defined as an image with a match score abo |
| 283 | 283 | File input("/path/to/input/galley/with/dups"); |
| 284 | 284 | File output("/path/to/output/gallery"); |
| 285 | 285 | Deduplicate(input, output, "0.7"); // Remove duplicates with match scores above 0.7 |
| 286 | + | |
| 287 | +<!-- Links --> | |
| 288 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 289 | +[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | ... | ... |
docs/docs/api_docs/cpp_api/classifier/functions.md
| ... | ... | @@ -50,3 +50,7 @@ This is a pure virtual function. Classify a provided input image. |
| 50 | 50 | |
| 51 | 51 | classifier->classify(p1); // returns confidence > 0 |
| 52 | 52 | classifier->classify(n1); // returns confidence < 0 |
| 53 | + | |
| 54 | +<!-- Links --> | |
| 55 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 56 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | ... | ... |
docs/docs/api_docs/cpp_api/classifier/statics.md
| ... | ... | @@ -19,3 +19,7 @@ Make a [Classifier](classifier.md) from a string. The string is passed to [Facto |
| 19 | 19 | |
| 20 | 20 | Classifier *classifier = Classifier::make("Classifier(representation=Representation(property1=value1)"); |
| 21 | 21 | classifier->description(); // Returns "Classifier(representation=Representation(property1=value1))" |
| 22 | + | |
| 23 | +<!-- Links --> | |
| 24 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 25 | +[QObject]: http://doc.qt.io/qt-5/QObject.html "QObject" | ... | ... |
docs/docs/api_docs/cpp_api/compositetransform/properties.md
| 1 | 1 | Property | Type | Description |
| 2 | 2 | --- | --- | --- |
| 3 | -transforms | [QList][QList]<[Transform](../transform/transform.md)\*> | List of child transforms | |
| 4 | 3 | \ No newline at end of file |
| 4 | +transforms | [QList][QList]<[Transform](../transform/transform.md)\*> | List of child transforms | |
| 5 | + | |
| 6 | +<!-- Links --> | |
| 7 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | ... | ... |
docs/docs/api_docs/cpp_api/context/functions.md
| ... | ... | @@ -81,3 +81,7 @@ Get the completion percentage of a call to [Train](../apifunctions.md#train), [E |
| 81 | 81 | |
| 82 | 82 | * **parameters:** NONE |
| 83 | 83 | * **output:** (float) Returns the fraction of the currently running job that has been completed. |
| 84 | + | |
| 85 | +<!-- Links --> | |
| 86 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 87 | +[QObject::property]: http://doc.qt.io/qt-5/qobject.html#property "QObject::property" | ... | ... |
docs/docs/api_docs/cpp_api/context/members.md
| ... | ... | @@ -21,3 +21,13 @@ Member | Type | Description |
| 21 | 21 | <a class="table-anchor" id=abbreviations></a>abbreviations | [QHash][QHash]<[QString][QString], [QString][QString]> | Used by [Transform](../transform/transform.md)::[make](../transform/statics.md#make) to expand abbreviated algorithms into their complete definitions. |
| 22 | 22 | <a class="table-anchor" id=starttime></a>startTime | [QTime][QTime] | Used to estimate [timeRemaining](functions.md#timeremaining). |
| 23 | 23 | <a class="table-anchor" id=logfile></a>logFile | [QFile][QFile] | Log file to write to. |
| 24 | + | |
| 25 | + | |
| 26 | +<!-- Links --> | |
| 27 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 28 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 29 | +[QHash]: http://doc.qt.io/qt-5/qhash.html "QHash" | |
| 30 | +[QThread]: http://doc.qt.io/qt-5/qthread.html "QThread" | |
| 31 | +[QByteArray]: http://doc.qt.io/qt-5/qbytearray.html "QByteArray" | |
| 32 | +[QTime]: http://doc.qt.io/qt-5/QTime.html "QTime" | |
| 33 | +[QFile]: http://doc.qt.io/qt-5/qfile.html "QFile" | ... | ... |
docs/docs/api_docs/cpp_api/context/statics.md
| ... | ... | @@ -134,3 +134,13 @@ Get a collection of objects in OpenBR that match provided regular expressions. T |
| 134 | 134 | |
| 135 | 135 | // Find all 'Rnd' Transforms |
| 136 | 136 | Context::objects("Transform", "Rnd.*", false); // returns ["RndPoint", "RndRegion", "RndRotate", "RndSample", "RndSubspace"] |
| 137 | + | |
| 138 | +<!-- Links --> | |
| 139 | +[Qt]: http://qt-project.org/ "Qt" | |
| 140 | +[QApplication]: http://doc.qt.io/qt-5/qapplication.html "QApplication" | |
| 141 | +[QCoreApplication]: http://doc.qt.io/qt-5/qcoreapplication.html "QCoreApplication" | |
| 142 | + | |
| 143 | +[QRegExp]: http://doc.qt.io/qt-5/QRegExp.html "QRegExp" | |
| 144 | + | |
| 145 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 146 | +[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | ... | ... |
docs/docs/api_docs/cpp_api/distance/distance.md
docs/docs/api_docs/cpp_api/distance/functions.md
| ... | ... | @@ -62,7 +62,7 @@ This is a virtual function. Compare two [TemplateLists](../templatelist/template |
| 62 | 62 | * **output:** (void) |
| 63 | 63 | |
| 64 | 64 | |
| 65 | -## [QList][QList]<float> compare(const [TemplateList][TemplateList] &target, const [Template](../template/template.md) &query) {: #compare-2 } | |
| 65 | +## [QList][QList]<float> compare(const [TemplateList](../templatelist/templatelist.md) &target, const [Template](../template/template.md) &query) {: #compare-2 } | |
| 66 | 66 | |
| 67 | 67 | This is a virtual function. Compare a query against a list of targets. Each comparison results in a floating point response which is the distance between the query and a specific target. |
| 68 | 68 | |
| ... | ... | @@ -211,3 +211,8 @@ This is a protected function. Makes a child distance from a provided description |
| 211 | 211 | description | const [QString][QString] & | Description of the child distance |
| 212 | 212 | |
| 213 | 213 | * **output:** ([Distance](distance.md) \*) Returns a pointer to the created child distance |
| 214 | + | |
| 215 | +<!-- Links --> | |
| 216 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 217 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 218 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | ... | ... |
docs/docs/api_docs/cpp_api/distance/statics.md
| ... | ... | @@ -44,3 +44,8 @@ Create a [Distance](distance.md) from an OpenBR algorithm string. The [Distance] |
| 44 | 44 | |
| 45 | 45 | Distance::fromAlgorithm("EnrollmentTransform:Distance")->decription(); // returns "Distance" |
| 46 | 46 | Distance::fromAlgorithm("EnrollmentTransform!Distance1+Distance2")->decription(); // returns "Pipe(distances=[Distance1,Distance2]) |
| 47 | + | |
| 48 | +<!-- Links --> | |
| 49 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 50 | +[QObject]: http://doc.qt.io/qt-5/QObject.html "QObject" | |
| 51 | +[QSharedPointer]: http://doc.qt.io/qt-5/qsharedpointer.html "QSharedPointer" | ... | ... |
docs/docs/api_docs/cpp_api/factory/constructors.md
| 1 | 1 | Constructor \| Destructor | Description |
| 2 | 2 | --- | --- |
| 3 | 3 | Factory([QString][QString] name) | This is a special constructor in OpenBR. It is used to register new objects in the [registry](members.md#registry). |
| 4 | -virtual ~Factory() | Default destructor | |
| 5 | 4 | \ No newline at end of file |
| 5 | +virtual ~Factory() | Default destructor | |
| 6 | + | |
| 7 | +<!-- Links --> | |
| 8 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | ... | ... |
docs/docs/api_docs/cpp_api/factory/members.md
| 1 | 1 | Member | Type | Description |
| 2 | 2 | --- | --- | --- |
| 3 | 3 | <a class="table-anchor" id=registry></a>registry | static [QMap][QMap]<[QString][QString],[Factory](factory.md)<<tt>T</tt>>\*> | List of all objects that have been registered with the factory. Registered objects are stored in this static registry by abstraction type. |
| 4 | + | |
| 5 | +<!-- Links --> | |
| 6 | +[QMap]: http://doc.qt.io/qt-5/qmap.html "QMap" | |
| 7 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | ... | ... |
docs/docs/api_docs/cpp_api/factory/statics.md
| ... | ... | @@ -88,3 +88,9 @@ Get the parameters for the plugin defined by the provided name. |
| 88 | 88 | |
| 89 | 89 | Factory<Transform>::parameters("Example"); // returns "int property1 = 1, float property2 = 2.5, QString property3 = Value" |
| 90 | 90 | Factory<Transform>::parameters("Example(property3=NewValue)"); // returns "int property1 = 1, float property2 = 2.5, QString property3 = NewValue" |
| 91 | + | |
| 92 | +<!-- Links --> | |
| 93 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 94 | +[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | |
| 95 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 96 | +[QSharedPointer]: http://doc.qt.io/qt-5/qsharedpointer.html "QSharedPointer" | ... | ... |
docs/docs/api_docs/cpp_api/file/constructors.md
| 1 | -## Constructors {: #file-constructors } | |
| 2 | - | |
| 3 | 1 | Constructor | Description |
| 4 | 2 | --- | --- |
| 5 | 3 | File() | Default constructor. Sets [name](members.md#name) to false. |
| ... | ... | @@ -7,3 +5,8 @@ File(const [QString][QString] &file) | Initializes the file by calling the priva |
| 7 | 5 | 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 | 6 | File(const char \*file) | Initializes the file with a c-style string. |
| 9 | 7 | File(const [QVariantMap][QVariantMap] &metadata) | Sets [name](members.md#name) to false and sets the [file metadata](members.md#m_metadata) to metadata. |
| 8 | + | |
| 9 | +<!-- Links --> | |
| 10 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 11 | +[QVariant]: http://doc.qt.io/qt-5/qvariant.html "QVariant" | |
| 12 | +[QVariantMap]: http://doc.qt.io/qt-5/qvariant.html#QVariantMap-typedef "QVariantMap" | ... | ... |
docs/docs/api_docs/cpp_api/file/file.md
| 1 | -# File | |
| 2 | - | |
| 3 | 1 | A file path with associated metadata. |
| 4 | 2 | |
| 5 | 3 | See: |
| ... | ... | @@ -63,3 +61,9 @@ Age | float | Age used for demographic filtering |
| 63 | 61 | Gender | QString | Subject gender |
| 64 | 62 | Train | bool | The data is for training, as opposed to enrollment |
| 65 | 63 | _\* | \* | Reserved for internal use |
| 64 | + | |
| 65 | +<!-- Links --> | |
| 66 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 67 | +[QVariantList]: http://doc.qt.io/qt-5/qvariant.html#QVariantList-typedef "QVariantList" | |
| 68 | +[QRectF]: http://doc.qt.io/qt-5/qrectf.html "QRectF" | |
| 69 | +[QPointF]: http://doc.qt.io/qt-5/qpointf.html "QPointF" | ... | ... |
docs/docs/api_docs/cpp_api/file/functions.md
| ... | ... | @@ -1272,3 +1272,43 @@ Replace the rects stored at [metadata](members.md#m_metadata) with a provided li |
| 1272 | 1272 | |
| 1273 | 1273 | file.setRects(QList<cv::Rect>() << cv::Rect(3, 3, 5, 5) << cv::Rect(4, 4, 5, 5)); |
| 1274 | 1274 | file.rects(); // returns [QRectF(3, 3, 5x5), QRectF(4, 4, 5x5)] |
| 1275 | + | |
| 1276 | +<!-- Links --> | |
| 1277 | +[Qt]: http://qt-project.org/ "Qt" | |
| 1278 | +[QApplication]: http://doc.qt.io/qt-5/qapplication.html "QApplication" | |
| 1279 | +[QCoreApplication]: http://doc.qt.io/qt-5/qcoreapplication.html "QCoreApplication" | |
| 1280 | +[QObject]: http://doc.qt.io/qt-5/QObject.html "QObject" | |
| 1281 | +[Qt Property System]: http://doc.qt.io/qt-5/properties.html "Qt Property System" | |
| 1282 | + | |
| 1283 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 1284 | +[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | |
| 1285 | + | |
| 1286 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 1287 | +[QMap]: http://doc.qt.io/qt-5/qmap.html "QMap" | |
| 1288 | +[QHash]: http://doc.qt.io/qt-5/qhash.html "QHash" | |
| 1289 | + | |
| 1290 | +[QRectF]: http://doc.qt.io/qt-5/qrectf.html "QRectF" | |
| 1291 | +[QPoint]: http://doc.qt.io/qt-5/qpoint.html "QPoint" | |
| 1292 | +[QPointF]: http://doc.qt.io/qt-5/qpointf.html "QPointF" | |
| 1293 | + | |
| 1294 | +[QVariant]: http://doc.qt.io/qt-5/qvariant.html "QVariant" | |
| 1295 | +[QVariantList]: http://doc.qt.io/qt-5/qvariant.html#QVariantList-typedef "QVariantList" | |
| 1296 | +[QVariantMap]: http://doc.qt.io/qt-5/qvariant.html#QVariantMap-typedef "QVariantMap" | |
| 1297 | + | |
| 1298 | +[QRegExp]: http://doc.qt.io/qt-5/QRegExp.html "QRegExp" | |
| 1299 | +[QThread]: http://doc.qt.io/qt-5/qthread.html "QThread" | |
| 1300 | +[QFile]: http://doc.qt.io/qt-5/qfile.html "QFile" | |
| 1301 | + | |
| 1302 | +[QSharedPointer]: http://doc.qt.io/qt-5/qsharedpointer.html "QSharedPointer" | |
| 1303 | + | |
| 1304 | +[QTime]: http://doc.qt.io/qt-5/QTime.html "QTime" | |
| 1305 | +[QDebug]: http://doc.qt.io/qt-5/qdebug.html "QDebug" | |
| 1306 | +[QDataStream]: http://doc.qt.io/qt-5/qdatastream.html "QDataStream" | |
| 1307 | +[QByteArray]: http://doc.qt.io/qt-5/qbytearray.html "QByteArray" | |
| 1308 | + | |
| 1309 | +[R]: http://www.r-project.org/ "R" | |
| 1310 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | |
| 1311 | +[Rect]: http://docs.opencv.org/modules/core/doc/basic_structures.html#rect "Rect" | |
| 1312 | +[InputArray]: http://docs.opencv.org/modules/core/doc/basic_structures.html#inputarray "InputArray" | |
| 1313 | +[OutputArray]: http://docs.opencv.org/modules/core/doc/basic_structures.html#outputarray "OutputArray" | |
| 1314 | +[OpenCV Image Formats]: http://docs.opencv.org/modules/highgui/doc/reading_and_writing_images_and_video.html?highlight=imread#imread "OpenCV Image Formats" | ... | ... |
docs/docs/api_docs/cpp_api/file/members.md
| ... | ... | @@ -3,3 +3,8 @@ Member | Type | Description |
| 3 | 3 | <a class="table-anchor" id="name"></a>name | [QString][QString] | Path to a file on disk |
| 4 | 4 | <a class="table-anchor" id=fte></a>fte | bool | Failed to enroll. If true this file failed to be processed somewhere in the template enrollment algorithm |
| 5 | 5 | <a class="table-anchor" id=m_metadata></a>m_metadata | [QVariantMap][QVariantMap] | Map for storing metadata. It is a [QString][QString], [QVariant][QVariant] key value pairing. |
| 6 | + | |
| 7 | +<!-- Links --> | |
| 8 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 9 | +[QVariant]: http://doc.qt.io/qt-5/qvariant.html "QVariant" | |
| 10 | +[QVariantMap]: http://doc.qt.io/qt-5/qvariant.html#QVariantMap-typedef "QVariantMap" | ... | ... |
docs/docs/api_docs/cpp_api/file/statics.md
| ... | ... | @@ -194,3 +194,11 @@ Deserialize a file from a data stream. |
| 194 | 194 | out.name; // returns "../path/to/pictures/picture.jpg" |
| 195 | 195 | out.flat(); // returns "../path/to/pictures/picture.jpg[Key=Value]" |
| 196 | 196 | } |
| 197 | + | |
| 198 | +<!-- Links --> | |
| 199 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 200 | +[QVariant]: http://doc.qt.io/qt-5/qvariant.html "QVariant" | |
| 201 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 202 | +[QDataStream]: http://doc.qt.io/qt-5/qdatastream.html "QDataStream" | |
| 203 | +[QRectF]: http://doc.qt.io/qt-5/qrectf.html "QRectF" | |
| 204 | +[QPointF]: http://doc.qt.io/qt-5/qpointf.html "QPointF" | ... | ... |
docs/docs/api_docs/cpp_api/filegallery/members.md
docs/docs/api_docs/cpp_api/filelist/constructors.md
| ... | ... | @@ -4,3 +4,7 @@ FileList() | Default constructor. Doesn't do anything. |
| 4 | 4 | FileList(int n) | Intialize the [FileList](filelist.md) with n empty [Files](../file/file.md) |
| 5 | 5 | FileList(const [QStringList][QStringList] &files) | Initialize the [FileList](filelist.md) with a list of strings. Each string should have the format "filename[key1=value1, key2=value2, ... keyN=valueN]" |
| 6 | 6 | FileList(const [QList][QList]<[File](../file/file.md)> &files) | Initialize the [FileList](filelist.md) from a list of [files](../file/file.md). |
| 7 | + | |
| 8 | +<!-- Links --> | |
| 9 | +[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | |
| 10 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | ... | ... |
docs/docs/api_docs/cpp_api/filelist/filelist.md
| 1 | -<!-- FILELIST --> | |
| 2 | - | |
| 3 | 1 | Inherits [QList][QList]<[File](../file/file.md)>. |
| 4 | 2 | |
| 5 | 3 | See: |
| ... | ... | @@ -9,3 +7,6 @@ See: |
| 9 | 7 | * [Functions](functions.md) |
| 10 | 8 | |
| 11 | 9 | A convenience class for dealing with lists of files. |
| 10 | + | |
| 11 | +<!-- Links --> | |
| 12 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | ... | ... |
docs/docs/api_docs/cpp_api/filelist/functions.md
| ... | ... | @@ -104,3 +104,8 @@ Get the number of [Files](../file/file.md) in the list that have [failed to enro |
| 104 | 104 | |
| 105 | 105 | FileList fList(QList<File>() << f1 << f2 << f3); |
| 106 | 106 | fList.failures(); // returns 2 |
| 107 | + | |
| 108 | +<!-- Links --> | |
| 109 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 110 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 111 | +[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | ... | ... |
docs/docs/api_docs/cpp_api/format/format.md
| ... | ... | @@ -28,3 +28,6 @@ A *format* is a [File](../file/file.md) representing a [Template](../template/te |
| 28 | 28 | * binary |
| 29 | 29 | |
| 30 | 30 | Many of these extensions are unique to OpenBR. Please look at the relevant [Format plugin](../../../plugin_docs/format.md) for information on formatting and other concerns. |
| 31 | + | |
| 32 | +<!-- Links --> | |
| 33 | +[OpenCV Image Formats]: http://docs.opencv.org/modules/highgui/doc/reading_and_writing_images_and_video.html?highlight=imread#imread "OpenCV Image Formats" | ... | ... |
docs/docs/api_docs/cpp_api/format/statics.md
docs/docs/api_docs/cpp_api/matrixoutput/functions.md
docs/docs/api_docs/cpp_api/matrixoutput/members.md
docs/docs/api_docs/cpp_api/object/functions.md
| ... | ... | @@ -453,3 +453,11 @@ Provides a wrapper on [getChildren](#getchildren-1) as a convenience to allow th |
| 453 | 453 | QScopedPointer<Transform> transform(Factory<Transform>::make(".Parent")); |
| 454 | 454 | transform->getChildren<Transform>(); // returns [br::ChildTransform(0x7fc10bf01050, name = "Child")] |
| 455 | 455 | transform->getChildren<Transform>().first()->parameters(); // returns ["int property1 = 2", "float property2 = 2"] |
| 456 | + | |
| 457 | +<!-- Links --> | |
| 458 | +[QDataStream]: http://doc.qt.io/qt-5/qdatastream.html "QDataStream" | |
| 459 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 460 | +[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | |
| 461 | +[QVariant]: http://doc.qt.io/qt-5/qvariant.html "QVariant" | |
| 462 | +[QObject]: http://doc.qt.io/qt-5/QObject.html "QObject" | |
| 463 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | ... | ... |
docs/docs/api_docs/cpp_api/object/macros.md
docs/docs/api_docs/cpp_api/object/object.md
| ... | ... | @@ -10,3 +10,6 @@ See: |
| 10 | 10 | * [Functions](functions.md) |
| 11 | 11 | |
| 12 | 12 | This is the base class of all OpenBR plugins. [Objects](object.md) are constructed from [Files](../file/file.md). The [File's](../file/file.md) [name](../file/members.md#name) specifies which plugin to construct and the [File's](../file/file.md) [metadata](../file/members.md#m_metadata) provides initialization values for the plugin's properties. |
| 13 | + | |
| 14 | +<!-- Links --> | |
| 15 | +[QObject]: http://doc.qt.io/qt-5/QObject.html "QObject" | ... | ... |
docs/docs/api_docs/cpp_api/object/statics.md
| ... | ... | @@ -17,3 +17,7 @@ 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 | + | |
| 21 | +<!-- Links --> | |
| 22 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 23 | +[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | ... | ... |
docs/docs/api_docs/cpp_api/output/members.md
| 1 | 1 | Member | Type | Description |
| 2 | 2 | --- | --- | --- |
| 3 | -<a class="table-anchor" id=targetfiles></a>targetFiles | [FileList][../filelist/filelist.md] | List of files representing the target templates | |
| 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 | 5 | <a class="table-anchor" id=selfsimilar></a>selfSimilar | bool | True if targetFiles == queryFiles, false otherwise | ... | ... |
docs/docs/api_docs/cpp_api/representation/functions.md
| ... | ... | @@ -89,3 +89,7 @@ This is a pure virtual function. Get the size of the feature space. |
| 89 | 89 | |
| 90 | 90 | rep1->numFeatures(); // returns 1000 |
| 91 | 91 | rep2->numFeatures(); // returns 25643 |
| 92 | + | |
| 93 | +<!-- Links --> | |
| 94 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 95 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | ... | ... |
docs/docs/api_docs/cpp_api/representation/statics.md
| ... | ... | @@ -18,4 +18,8 @@ Make a [Representation](representation.md) from a string. The string is passed t |
| 18 | 18 | * **example:** |
| 19 | 19 | |
| 20 | 20 | Representation *rep = Representation::make("Representation(property1=value1)"); |
| 21 | - rep->description(); // Returns "Representation(property1=value1)" | |
| 22 | 21 | \ No newline at end of file |
| 22 | + rep->description(); // Returns "Representation(property1=value1)" | |
| 23 | + | |
| 24 | +<!-- Links --> | |
| 25 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 26 | +[QObject]: http://doc.qt.io/qt-5/QObject.html "QObject" | ... | ... |
docs/docs/api_docs/cpp_api/template/constructors.md
| ... | ... | @@ -4,3 +4,6 @@ Template() | The default template constructor. It doesn't do anything. |
| 4 | 4 | Template(const [File](../file/file.md) &file) | Sets [file](members.md#file) to the given [File](../file/file.md). |
| 5 | 5 | Template(const [File](../file/file.md) &file, const [Mat][Mat] &mat) | Sets [file](members.md#file) to the given [File](../file/file.md) and appends the given [Mat][Mat] to itself. |
| 6 | 6 | Template(const [Mat][Mat] &mat) | Appends the given [Mat][Mat] to itself |
| 7 | + | |
| 8 | +<!-- Links --> | |
| 9 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | ... | ... |
docs/docs/api_docs/cpp_api/template/functions.md
| ... | ... | @@ -162,7 +162,7 @@ Append the contents of another template. The [files](members.md#file) are append |
| 162 | 162 | |
| 163 | 163 | Parameter | Type | Description |
| 164 | 164 | --- | --- | --- |
| 165 | - other | const [Template][template.md] & | Template to be merged | |
| 165 | + other | const [Template](template.md) & | Template to be merged | |
| 166 | 166 | |
| 167 | 167 | * **output:** (void) |
| 168 | 168 | * **example:** |
| ... | ... | @@ -221,3 +221,8 @@ Clone the template |
| 221 | 221 | |
| 222 | 222 | t2.file; // returns "picture.jpg" |
| 223 | 223 | t2; // returns ["1"] |
| 224 | + | |
| 225 | +<!-- Links --> | |
| 226 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | |
| 227 | +[InputArray]: http://docs.opencv.org/modules/core/doc/basic_structures.html#inputarray "InputArray" | |
| 228 | +[OutputArray]: http://docs.opencv.org/modules/core/doc/basic_structures.html#outputarray "OutputArray" | ... | ... |
docs/docs/api_docs/cpp_api/template/statics.md
docs/docs/api_docs/cpp_api/template/template.md
| ... | ... | @@ -20,3 +20,7 @@ In the cases where exactly one image is expected, the template provides the func |
| 20 | 20 | Casting operators are also provided to pass the template into image processing functions expecting matrices. |
| 21 | 21 | |
| 22 | 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 | + | |
| 24 | +<!-- Links --> | |
| 25 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 26 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | ... | ... |
docs/docs/api_docs/cpp_api/templatelist/constructors.md
| ... | ... | @@ -3,3 +3,6 @@ Constructor | Description |
| 3 | 3 | TemplateList() | The default [TemplateList](templatelist.md) constructor. Doesn't do anything. |
| 4 | 4 | TemplateList(const [QList][QList]<[Template](../template/template.md)> &templates) | Initialize the [TemplateList](templatelist.md) with a list of templates. The given list is appended |
| 5 | 5 | TemplateList(const [QList][QList]<[File](../file/file.md)> &files) | Initialize the [TemplateList](templatelist.md) with a list of [Files](../file/file.md). Each [File](../file/file.md) is treated like a template and appended. |
| 6 | + | |
| 7 | +<!-- Links --> | |
| 8 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | ... | ... |
docs/docs/api_docs/cpp_api/templatelist/functions.md
| ... | ... | @@ -304,3 +304,11 @@ Get the indices of every [Template](../template/template.md) that has a provided |
| 304 | 304 | |
| 305 | 305 | TemplateList tList(QList<Template>() << t1 << t2 << t3); |
| 306 | 306 | tList.find<QString>("Key", "Value2"); // returns [1, 2] |
| 307 | + | |
| 308 | +<!-- Links --> | |
| 309 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 310 | +[QHash]: http://doc.qt.io/qt-5/qhash.html "QHash" | |
| 311 | +[QMap]: http://doc.qt.io/qt-5/qmap.html "QMap" | |
| 312 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 313 | +[QVariant]: http://doc.qt.io/qt-5/qvariant.html "QVariant" | |
| 314 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | ... | ... |
docs/docs/api_docs/cpp_api/templatelist/statics.md
| ... | ... | @@ -29,7 +29,7 @@ Create a template from a memory buffer of individual templates. This is compatib |
| 29 | 29 | --- | --- | --- |
| 30 | 30 | buffer | const [QByteArray][QByteArray] & | Raw data buffer to be enrolled |
| 31 | 31 | |
| 32 | -* **output:** ([TemplateList][TemplateList]) Returns a [TemplateList](templatelist.md) created by enrolling the buffer | |
| 32 | +* **output:** ([TemplateList](templatelist.md)) Returns a [TemplateList](templatelist.md) created by enrolling the buffer | |
| 33 | 33 | |
| 34 | 34 | |
| 35 | 35 | ## [TemplateList](templatelist.md) relabel(const [TemplateList](templatelist.md) &tl, const [QString][QString] &propName, bool preserveIntegers) {: #relabel } |
| ... | ... | @@ -63,3 +63,7 @@ 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 | + | |
| 67 | +<!-- Links --> | |
| 68 | +[QByteArray]: http://doc.qt.io/qt-5/qbytearray.html "QByteArray" | |
| 69 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | ... | ... |
docs/docs/api_docs/cpp_api/templatelist/templatelist.md
docs/docs/api_docs/cpp_api/timevaryingtransform/timevaryingtransform.md
docs/docs/api_docs/cpp_api/transform/functions.md
| ... | ... | @@ -417,3 +417,9 @@ This is a protected function. Makes a child transform from a provided descriptio |
| 417 | 417 | description | const [QString][QString] & | Description of the child transform |
| 418 | 418 | |
| 419 | 419 | * **output:** ([Transform](transform.md) \*) Returns a pointer to the created child transform |
| 420 | + | |
| 421 | +<!-- Links --> | |
| 422 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | |
| 423 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 424 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 425 | +[QSharedPointer]: http://doc.qt.io/qt-5/qsharedpointer.html "QSharedPointer" | ... | ... |
docs/docs/api_docs/cpp_api/transform/members.md
| ... | ... | @@ -2,3 +2,6 @@ Member | Type | Description |
| 2 | 2 | --- | --- | --- |
| 3 | 3 | <a class="table-anchor" id=independent></a>independent | bool | True if the transform is independent, false otherwise. Independent transforms process each [Mat][Mat] in a [Template](../template/template.md) independently. This means that a new instance of the transform is created for each [Mat][Mat]. If the transform is [trainable](#trainable) and the training data has more then one [Mat][Mat] per template, each created instance of the transform is trained separately. Please see [Training Algorithms](../../../tutorials.md#training-algorithms) for more details. |
| 4 | 4 | <a class="table-anchor" id=trainable></a>trainable | bool | True if the transform is trainable, false otherwise. Trainable transforms need to overload the [train](functions.md#train-1) function. |
| 5 | + | |
| 6 | +<!-- Links --> | |
| 7 | +[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | ... | ... |
docs/docs/api_docs/cpp_api/transform/statics.md
| ... | ... | @@ -191,3 +191,9 @@ Convenience function for [load](../object/functions.md#load) |
| 191 | 191 | Transform out; |
| 192 | 192 | stream >> out; |
| 193 | 193 | out->description(); // returns "Example(property1=value1,property2=value2)" |
| 194 | + | |
| 195 | +<!-- Links --> | |
| 196 | +[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 197 | +[QObject]: http://doc.qt.io/qt-5/QObject.html "QObject" | |
| 198 | +[QSharedPointer]: http://doc.qt.io/qt-5/qsharedpointer.html "QSharedPointer" | |
| 199 | +[QDataStream]: http://doc.qt.io/qt-5/qdatastream.html "QDataStream" | ... | ... |
docs/docs/api_docs/cpp_api/wrappertransform/functions.md
| ... | ... | @@ -151,3 +151,6 @@ Get a smart copy, meaning a copy only if one is required, of this transform |
| 151 | 151 | newTransform | bool & | True if a new, simplified, transform was allocated inside this call, false otherwise |
| 152 | 152 | |
| 153 | 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 | + | |
| 155 | +<!-- Links --> | |
| 156 | +[QList]: http://doc.qt.io/qt-5/QList.html "QList" | ... | ... |
docs/docs/contributors.md deleted
| 1 | -<!-- Contributors --> | |
| 2 | - | |
| 3 | -[jklontz]: https://github.com/jklontz "Joshua C. Klontz, jklontz@ieee.org" | |
| 4 | -[mburge]: https://github.com/mburge "Dr. Mark J. Burge mburge@gmail.com" | |
| 5 | -[bklare]: https://github.com/bklare "Dr. Brendan F. Klare brendan.klare@ieee.org" | |
| 6 | -[mmtaborsky]: https://github.com/mmtaborsky "M. M. Taborsky mmtaborsky@gmail.com" | |
| 7 | -[sklum]: https://github.com/sklum "Scott J. Klum scott.klum@gmail.com" | |
| 8 | -[caotto]: https://github.com/caotto "Charles A. Otto ottochar@gmail.com" | |
| 9 | -[lbestrowden]: https://github.com/lbestrowden "Lacey S. Best-Rowden bestrow1@msu.edu" | |
| 10 | -[imaus10]: https://github.com/imaus10 "Austin Blanton imaus10@gmail.com" | |
| 11 | -[dgcrouse]: https://github.com/dgcrouse "David G. Crouse dgcrouse@gmail.com" | |
| 12 | -[baba1472]: https://github.com/baba1472 "Babatunde Ogunfemi ogunfemi.b@gmail.com" | |
| 13 | -[jcheney]: https://github.com/JordanCheney "Jordan Cheney jordan.cheney@gmail.com" |
docs/docs/links.md deleted
| 1 | -<!-- Links --> | |
| 2 | -[Qt]: http://qt-project.org/ "Qt" | |
| 3 | -[QApplication]: http://doc.qt.io/qt-5/qapplication.html "QApplication" | |
| 4 | -[QCoreApplication]: http://doc.qt.io/qt-5/qcoreapplication.html "QCoreApplication" | |
| 5 | -[QObject]: http://doc.qt.io/qt-5/QObject.html "QObject" | |
| 6 | -[Qt Property System]: http://doc.qt.io/qt-5/properties.html "Qt Property System" | |
| 7 | - | |
| 8 | -[QString]: http://doc.qt.io/qt-5/QString.html "QString" | |
| 9 | -[QStringList]: http://doc.qt.io/qt-5/qstringlist.html "QStringList" | |
| 10 | - | |
| 11 | -[QList]: http://doc.qt.io/qt-5/QList.html "QList" | |
| 12 | -[QMap]: http://doc.qt.io/qt-5/qmap.html "QMap" | |
| 13 | -[QHash]: http://doc.qt.io/qt-5/qhash.html "QHash" | |
| 14 | - | |
| 15 | -[QRectF]: http://doc.qt.io/qt-5/qrectf.html "QRectF" | |
| 16 | -[QPoint]: http://doc.qt.io/qt-5/qpoint.html "QPoint" | |
| 17 | -[QPointF]: http://doc.qt.io/qt-5/qpointf.html "QPointF" | |
| 18 | - | |
| 19 | -[QVariant]: http://doc.qt.io/qt-5/qvariant.html "QVariant" | |
| 20 | -[QVariantList]: http://doc.qt.io/qt-5/qvariant.html#QVariantList-typedef "QVariantList" | |
| 21 | -[QVariantMap]: http://doc.qt.io/qt-5/qvariant.html#QVariantMap-typedef "QVariantMap" | |
| 22 | - | |
| 23 | -[QRegExp]: http://doc.qt.io/qt-5/QRegExp.html "QRegExp" | |
| 24 | -[QThread]: http://doc.qt.io/qt-5/qthread.html "QThread" | |
| 25 | -[QFile]: http://doc.qt.io/qt-5/qfile.html "QFile" | |
| 26 | - | |
| 27 | -[QSharedPointer]: http://doc.qt.io/qt-5/qsharedpointer.html "QSharedPointer" | |
| 28 | - | |
| 29 | -[QTime]: http://doc.qt.io/qt-5/QTime.html "QTime" | |
| 30 | -[QDebug]: http://doc.qt.io/qt-5/qdebug.html "QDebug" | |
| 31 | -[QDataStream]: http://doc.qt.io/qt-5/qdatastream.html "QDataStream" | |
| 32 | -[QByteArray]: http://doc.qt.io/qt-5/qbytearray.html "QByteArray" | |
| 33 | - | |
| 34 | -[R]: http://www.r-project.org/ "R" | |
| 35 | -[Mat]: http://docs.opencv.org/modules/core/doc/basic_structures.html#mat "Mat" | |
| 36 | -[Rect]: http://docs.opencv.org/modules/core/doc/basic_structures.html#rect "Rect" | |
| 37 | -[InputArray]: http://docs.opencv.org/modules/core/doc/basic_structures.html#inputarray "InputArray" | |
| 38 | -[OutputArray]: http://docs.opencv.org/modules/core/doc/basic_structures.html#outputarray "OutputArray" | |
| 39 | -[OpenCV Image Formats]: http://docs.opencv.org/modules/highgui/doc/reading_and_writing_images_and_video.html?highlight=imread#imread "OpenCV Image Formats" |
docs/mkdocs.yml
docs/scripts/check_links.py
| ... | ... | @@ -101,11 +101,10 @@ def main(): |
| 101 | 101 | docs_dir = '../docs/' |
| 102 | 102 | ext = 'md' |
| 103 | 103 | |
| 104 | - links = open('../docs/links.md', 'r').read() | |
| 105 | 104 | md_files = walk(docs_dir, ext) |
| 106 | 105 | md = markdown.Markdown( ['meta', 'toc', 'tables', 'fenced_code', 'attr_list', 'footnotes'] ) |
| 107 | 106 | |
| 108 | - html_files = [md.convert(open(f, 'r', encoding='utf-8').read() + "\n\n" + links) for f in md_files] | |
| 107 | + html_files = [md.convert(open(f, 'r', encoding='utf-8').read()) for f in md_files] | |
| 109 | 108 | |
| 110 | 109 | headers = {} |
| 111 | 110 | links = {} | ... | ... |
docs/scripts/generate_plugin_docs.py
| ... | ... | @@ -17,6 +17,20 @@ abstractions = ['FileList', 'File', |
| 17 | 17 | 'Classifier' |
| 18 | 18 | ] |
| 19 | 19 | |
| 20 | +contributors = [ | |
| 21 | + '[jklontz]: https://github.com/jklontz "Joshua C. Klontz, jklontz@ieee.org"', | |
| 22 | + '[mburge]: https://github.com/mburge "Dr. Mark J. Burge mburge@gmail.com"', | |
| 23 | + '[bklare]: https://github.com/bklare "Dr. Brendan F. Klare brendan.klare@ieee.org"', | |
| 24 | + '[mmtaborsky]: https://github.com/mmtaborsky "M. M. Taborsky mmtaborsky@gmail.com"', | |
| 25 | + '[sklum]: https://github.com/sklum "Scott J. Klum scott.klum@gmail.com"', | |
| 26 | + '[caotto]: https://github.com/caotto "Charles A. Otto ottochar@gmail.com"', | |
| 27 | + '[lbestrowden]: https://github.com/lbestrowden "Lacey S. Best-Rowden bestrow1@msu.edu"', | |
| 28 | + '[imaus10]: https://github.com/imaus10 "Austin Blanton imaus10@gmail.com"', | |
| 29 | + '[dgcrouse]: https://github.com/dgcrouse "David G. Crouse dgcrouse@gmail.com"', | |
| 30 | + '[baba1472]: https://github.com/baba1472 "Babatunde Ogunfemi ogunfemi.b@gmail.com"', | |
| 31 | + '[jcheney]: https://github.com/JordanCheney "Jordan Cheney jordan.cheney@gmail.com"' | |
| 32 | + ] | |
| 33 | + | |
| 20 | 34 | def subfiles(path): |
| 21 | 35 | return [name for name in os.listdir(path) if os.path.isfile(os.path.join(path, name)) and not name[0] == '.'] |
| 22 | 36 | |
| ... | ... | @@ -255,4 +269,9 @@ def main(): |
| 255 | 269 | |
| 256 | 270 | for name in sorted(names): |
| 257 | 271 | output_file.write(docs[name]) |
| 272 | + | |
| 273 | + output_file.write("<!-- Contributors -->\n") | |
| 274 | + for contributor in contributors: | |
| 275 | + output_file.write(contributor + "\n") | |
| 276 | + | |
| 258 | 277 | main() | ... | ... |