3.0 KiB
#Introduction to using CVVisual
##Enabling debug mode
Define the CVV_DEBUG_MODE macro somewhere in the translation unit.
##Opening the debug window
Open the debug window by putting one of the functions from the CVVisual API into your code.
In this example, we want to debug a call to 'dilate' (line.1) which is a filter, so we use debugFilter.
###Example: Code
src, dest and the structuring element elem are of type cv::Mat (see the OpenCV doc on dilate());
CVVISUAL_LOCATION is a special macro that inserts the location of the code and description and view can be either string-literals or std::strings. The later three are all optional.
#include <filter.hpp>
//...
cv::dilate(src, dest, elem);
cvv::debugFilter(src, dest, CVVISUAL_LOCATION, description, view);
When executing the code, the debugFilter function will open the window and halt the execution.
##The Overview Tab
You are now in the overview tab. Each time you call one of the CVVisual functions, a Call is added to the table.
You can see the images you passed to the funtion as well as metadata and additional information.
The text field allows you to sort or group the Calls by different criteria; see the filter query language documentation on how to use it.
Now double-click on the Call or select Open in 'CVVisual|main window' from the context menu.
(You can also choose to remove the Call or open it in a new window there)
##Debugging a filter operation
A CallTab opens. In the center, there are the images from the call.
In the View drop-down menu you find different Views of the Call, that is, different visualizations of it. The accordion menu on the left offers information on the images and additional options depending on the View and the type of the Call.
Important here might be that ImageInformation offers the possibility to zoom (you can also use Ctrl plus the mouse wheel); if you zoom in more than 60%, the image pixels will be overlaid with the channel values, in a 3-channel image usually in order (top-down) BGR.
As our dilate seems to have produced acceptable results, we want to continue through the code.
So, we push the Step button in the upper left.
The window will comes up again the next time one of the CVVisual functions is called.
Then, we see two Calls in the Overview table, the one from before and the new one.
You need to put finalShow() after the last regular CVVisual function. If the program reaches it, Step and the fast-forward button >> will vanish, so we press Close, which does exactly what it says.
(Source of the image used for demonstration.
Note that the screenshots were taken during development and may not depict all features of the current version.)
