Commit a220bddd authored by ahb's avatar ahb

api documentation complete; cvv now shows up in index

parent b4354bbe
...@@ -10,10 +10,11 @@ Introduction ...@@ -10,10 +10,11 @@ Introduction
Namespace for all functions is **cvv**, i.e. *cvv::showImage()*. Namespace for all functions is **cvv**, i.e. *cvv::showImage()*.
Compilation: Compilation:
* For development, i.e. for cvv GUI to show up, compile your code using cvv with *cmake -DCVV_DEBUG_MODE=ON* (or *g++ -DCVVISUAL_DEBUGMODE*). * For development, i.e. for cvv GUI to show up, compile your code using cvv with *cmake -DCVV_DEBUG_MODE=ON* (or *g++ -DCVVISUAL_DEBUGMODE*).
* For release, i.e. cvv calls doing nothing, compile your code with *cmake -DCVV_DEBUG_MODE=OFF* (or *g++* without *-DCVVISUAL_DEBUGMODE* flag). * For release, i.e. cvv calls doing nothing, compile your code with *cmake -DCVV_DEBUG_MODE=OFF* (or *g++* without above flag).
See cvv tutorial TODO-ADD-LINK for a commented example application using cvv. See cvv tutorial for a commented example application using cvv.
...@@ -24,7 +25,7 @@ API Functions ...@@ -24,7 +25,7 @@ API Functions
showImage showImage
--------- ---------
Add a single image to debug GUI (similar to imshow()). Add a single image to debug GUI (similar to :ocv:func:`imshow` ).
.. ocv:function:: void showImage(InputArray img, const CallMetaData& metaData, const string& description, const string& view) .. ocv:function:: void showImage(InputArray img, const CallMetaData& metaData, const string& description, const string& view)
...@@ -51,24 +52,24 @@ Add two images to debug GUI for comparison. Usually the input and output of some ...@@ -51,24 +52,24 @@ Add two images to debug GUI for comparison. Usually the input and output of some
debugDMatch debugDMatch
----------- -----------
TODO Add a filled in :ocv:struct:`DMatch` to debug GUI. The matches can are visualized for interactive inspection in different GUI views (one similar to an interactive :ocv:func:`drawMatches` ).
.. ocv:function:: void debugDMatch(InputArray img1, std::vector<cv::KeyPoint> keypoints1, InputArray img2, std::vector<cv::KeyPoint> keypoints2, std::vector<cv::DMatch> matches, const CallMetaData& metaData, const string& description, const string& view, bool useTrainDescriptor) .. ocv:function:: void debugDMatch(InputArray img1, std::vector<cv::KeyPoint> keypoints1, InputArray img2, std::vector<cv::KeyPoint> keypoints2, std::vector<cv::DMatch> matches, const CallMetaData& metaData, const string& description, const string& view, bool useTrainDescriptor)
:param img1: First image used in DMatch. :param img1: First image used in :ocv:struct:`DMatch`
:param keypoints1: Keypoints of first image. :param keypoints1: Keypoints of first image.
:param img2: Second image used in DMatch. :param img2: Second image used in DMatch.
:param keypoints2: Keypoints of second image. :param keypoints2: Keypoints of second image.
:param metaData: See :ocv:func:`showImage` :param metaData: See :ocv:func:`showImage`
:param description: See :ocv:func:`showImage` :param description: See :ocv:func:`showImage`
:param view: See :ocv:func:`showImage` :param view: See :ocv:func:`showImage`
:param useTrainDescriptor: TODO :param useTrainDescriptor: Use :ocv:struct:`DMatch`'s train descriptor index instead of query descriptor index.
finalShow finalShow
--------- ---------
This function ***must*** be called **once** **after** all cvv calls if any. This function **must** be called *once* *after* all cvv calls if any.
As an alternative create an instance of FinalShowCaller, which calls finalShow() in its destructor (RAII-style). As an alternative create an instance of FinalShowCaller, which calls finalShow() in its destructor (RAII-style).
.. ocv:function:: void finalShow() .. ocv:function:: void finalShow()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment