doc/tutorials/introduction/windows_visual_studio_image_watch/windows_visual_studio_image_watch.markdown

   1 Image Watch: viewing in-memory images in the Visual Studio debugger {#tutorial_windows_visual_studio_image_watch}
   2 ===================================================================
   3
   4 @prev_tutorial{tutorial_windows_visual_studio_opencv}
   5 @next_tutorial{tutorial_java_dev_intro}
   6
   7
   8 Image Watch is a plug-in for Microsoft Visual Studio that lets you to visualize in-memory images
   9 (*cv::Mat* or *IplImage_* objects, for example) while debugging an application. This can be helpful
  10 for tracking down bugs, or for simply understanding what a given piece of code is doing.
  11
  12 Prerequisites
  13 -------------
  14
  15 This tutorial assumes that you have the following available:
  16
  17 -#  Visual Studio 2012 Professional (or better) with Update 1 installed. Update 1 can be downloaded
  18     [here](http://www.microsoft.com/en-us/download/details.aspx?id=35774).
  19 -#  An OpenCV installation on your Windows machine (Tutorial: @ref tutorial_windows_install).
  20 -#  Ability to create and build OpenCV projects in Visual Studio (Tutorial: @ref tutorial_windows_visual_studio_opencv).
  21
  22 Installation
  23 ------------
  24
  25 Download the Image Watch installer. ([Visual Studio 2019](https://marketplace.visualstudio.com/items?itemName=VisualCPPTeam.ImageWatch2019) | [Visual Studio 2017](https://marketplace.visualstudio.com/items?itemName=VisualCPPTeam.ImageWatch2017) | [Visual Studio 2012, 2013, 2015](https://marketplace.visualstudio.com/items?itemName=VisualCPPTeam.ImageWatch))
  26 The installer comes in a single file with extension .vsix (*Visual Studio Extension*). To launch it, simply
  27 double-click on the .vsix file in Windows Explorer. When the installer has finished, make sure to
  28 restart Visual Studio to complete the installation.
  29
  30 Example
  31 -------
  32
  33 Image Watch works with any existing project that uses OpenCV image objects (for example, *cv::Mat*).
  34 In this example, we use a minimal test program that loads an image from a file and runs an edge
  35 detector. To build the program, create a console application project in Visual Studio, name it
  36 "image-watch-demo", and insert the source code below.
  37 @code{.cpp}
  38 // Test application for the Visual Studio Image Watch Debugger extension
  39
  40 #include <iostream>                        // std::cout
  41 #include <opencv2/core/core.hpp>           // cv::Mat
  42 #include <opencv2/imgcodecs/imgcodecs.hpp>     // cv::imread()
  43 #include <opencv2/imgproc/imgproc.hpp>     // cv::Canny()
  44
  45 using namespace std;
  46 using namespace cv;
  47
  48 void help()
  49 {
  50     cout
  51         << "----------------------------------------------------" << endl
  52         << "This is a test program for the Image Watch Debugger " << endl
  53         << "plug-in for Visual Studio. The program loads an     " << endl
  54         << "image from a file and runs the Canny edge detector. " << endl
  55         << "No output is displayed or written to disk."
  56         << endl
  57         << "Usage:"                                               << endl
  58         << "image-watch-demo inputimage"                          << endl
  59         << "----------------------------------------------------" << endl
  60         << endl;
  61 }
  62
  63 int main(int argc, char *argv[])
  64 {
  65     help();
  66
  67     if (argc != 2)
  68     {
  69         cout << "Wrong number of parameters" << endl;
  70         return -1;
  71     }
  72
  73     cout << "Loading input image: " << argv[1] << endl;
  74     Mat input;
  75     input = imread(argv[1], IMREAD_COLOR);
  76
  77     cout << "Detecting edges in input image" << endl;
  78     Mat edges;
  79     Canny(input, edges, 10, 100);
  80
  81     return 0;
  82 }
  83 @endcode
  84 Make sure your active solution configuration (Build --\> Configuration Manager) is set to a debug
  85 build (usually called "Debug"). This should disable compiler optimizations so that viewing variables
  86 in the debugger can work reliably.
  87
  88 Build your solution (Build --\> Build Solution, or press *F7*).
  89
  90 Before continuing, do not forget to add the command line argument of your input image to your
  91 project (Right click on project --\> Properties --\> Configuration Properties --\> Debugging and
  92 then set the field Command Arguments with the location of the image).
  93
  94 Now set a breakpoint on the source line that says
  95 @code{.cpp}
  96 Mat edges;
  97 @endcode
  98 To set the breakpoint, right-click on the source line and select Breakpoints --\> Insert Breakpoint
  99 from the context menu.
 100
 101 Launch the program in the debugger (Debug --\> Start Debugging, or hit *F5*). When the breakpoint is
 102 hit, the program is paused and Visual Studio displays a yellow instruction pointer at the
 103 breakpoint:
 104
 105 ![](images/breakpoint.png)
 106
 107 Now you can inspect the state of you program. For example, you can bring up the *Locals* window
 108 (Debug --\> Windows --\> Locals), which will show the names and values of the variables in the
 109 current scope:
 110
 111 ![](images/vs_locals.png)
 112
 113 Note that the built-in *Locals* window will display text only. This is where the Image Watch plug-in
 114 comes in. Image Watch is like another *Locals* window, but with an image viewer built into it. To
 115 bring up Image Watch, select View --\> Other Windows --\> Image Watch. Like Visual Studio's *Locals*
 116 window, Image Watch can dock to the Visual Studio IDE. Also, Visual Studio will remember whether you
 117 had Image Watch open, and where it was located between debugging sessions. This means you only have
 118 to do this once--the next time you start debugging, Image Watch will be back where you left it.
 119 Here's what the docked Image Watch window looks like at our breakpoint:
 120
 121 ![](images/toolwindow.jpg)
 122
 123 The radio button at the top left (*Locals/Watch*) selects what is shown in the *Image List* below:
 124 *Locals* lists all OpenCV image objects in the current scope (this list is automatically populated).
 125 *Watch* shows image expressions that have been pinned for continuous inspection (not described here,
 126 see [Image Watch documentation](http://go.microsoft.com/fwlink/?LinkId=285461) for details). The
 127 image list shows basic information such as width, height, number of channels, and, if available, a
 128 thumbnail. In our example, the image list contains our two local image variables, *input* and
 129 *edges*.
 130
 131 If an image has a thumbnail, left-clicking on that image will select it for detailed viewing in the
 132 *Image Viewer* on the right. The viewer lets you pan (drag mouse) and zoom (mouse wheel). It also
 133 displays the pixel coordinate and value at the current mouse position.
 134
 135 ![](images/viewer.jpg)
 136
 137 Note that the second image in the list, *edges*, is shown as "invalid". This indicates that some
 138 data members of this image object have corrupt or invalid values (for example, a negative image
 139 width). This is expected at this point in the program, since the C++ constructor for *edges* has not
 140 run yet, and so its members have undefined values (in debug mode they are usually filled with "0xCD"
 141 bytes).
 142
 143 From here you can single-step through your code (Debug-\>Step Over, or press *F10*) and watch the
 144 pixels change: if you step once, over the *Mat edges;* statement, the *edges* image will change from
 145 "invalid" to "empty", which means that it is now in a valid state (default constructed), even though
 146 it has not been initialized yet (using *cv::Mat::create()*, for example). If you make one more step
 147 over the *cv::Canny()* call, you will see a thumbnail of the edge image appear in the image list.
 148
 149 Now assume you want to do a visual sanity check of the *cv::Canny()* implementation. Bring the
 150 *edges* image into the viewer by selecting it in the *Image List* and zoom into a region with a
 151 clearly defined edge:
 152
 153 ![](images/edges_zoom.png)
 154
 155 Right-click on the *Image Viewer* to bring up the view context menu and enable Link Views (a check
 156 box next to the menu item indicates whether the option is enabled).
 157
 158 ![](images/viewer_context_menu.png)
 159
 160 The Link Views feature keeps the view region fixed when flipping between images of the same size. To
 161 see how this works, select the input image from the image list--you should now see the corresponding
 162 zoomed-in region in the input image:
 163
 164 ![](images/input_zoom.png)
 165
 166 You may also switch back and forth between viewing input and edges with your up/down cursor keys.
 167 That way you can easily verify that the detected edges line up nicely with the data in the input
 168 image.
 169
 170 More ...
 171 --------
 172
 173 Image watch has a number of more advanced features, such as
 174
 175 -#  pinning images to a *Watch* list for inspection across scopes or between debugging sessions
 176 -#  clamping, thresholding, or diff'ing images directly inside the Watch window
 177 -#  comparing an in-memory image against a reference image from a file
 178
 179 Please refer to the online [Image Watch
 180 Documentation](http://go.microsoft.com/fwlink/?LinkId=285461) for details--you also can get to the
 181 documentation page by clicking on the *Help* link in the Image Watch window:
 182
 183 ![](images/help_button.jpg)