Commit 62ea86a3 authored by Davis King's avatar Davis King

updated docs

parent ae73da44
...@@ -188,6 +188,7 @@ ...@@ -188,6 +188,7 @@
<name>Miscellaneous</name> <name>Miscellaneous</name>
<item>cv_image</item> <item>cv_image</item>
<item>toMat</item>
<item>draw_line</item> <item>draw_line</item>
<item>fill_rect</item> <item>fill_rect</item>
...@@ -573,15 +574,38 @@ ...@@ -573,15 +574,38 @@
<file>dlib/opencv.h</file> <file>dlib/opencv.h</file>
<spec_file link="true">dlib/opencv/cv_image_abstract.h</spec_file> <spec_file link="true">dlib/opencv/cv_image_abstract.h</spec_file>
<description> <description>
This object is meant to be used as a simple wrapper around the OpenCV This object is meant to be used as a simple wrapper around the OpenCV
IplImage struct. Using this class template you can turn an IplImage IplImage struct or Mat object. Using this class template you can turn
object into something that looks like a normal dlib style image object. an OpenCV image into something that looks like a normal dlib style
image object.
<p> <p>
So you should be able to use cv_image objects with many of the image So you should be able to use cv_image objects with many of the image
processing functions in dlib as well as the GUI tools for displaying processing functions in dlib as well as the GUI tools for displaying
images on the screen. images on the screen.
</p> </p>
<p>
Note that you can do the reverse conversion, from dlib to OpenCV,
using the <a href="#toMat">toMat</a> routine.
</p>
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>toMat</name>
<file>dlib/opencv.h</file>
<spec_file link="true">dlib/opencv/to_open_cv_abstract.h</spec_file>
<description>
This routine converts a dlib style image into an instance of OpenCV's cv::Mat object.
This is done by setting up the Mat object to point to the same memory as the dlib image.
<p>
Note that you can do the reverse conversion, from OpenCV to dlib,
using the <a href="#cv_image">cv_image</a> object.
</p>
</description> </description>
</component> </component>
......
...@@ -1050,6 +1050,7 @@ ...@@ -1050,6 +1050,7 @@
<term file="imaging.html" name="rgb_pixel"/> <term file="imaging.html" name="rgb_pixel"/>
<term file="imaging.html" name="bgr_pixel"/> <term file="imaging.html" name="bgr_pixel"/>
<term file="imaging.html" name="cv_image"/> <term file="imaging.html" name="cv_image"/>
<term file="imaging.html" name="toMat"/>
<term link="imaging.html#cv_image" name="OpenCV Image"/> <term link="imaging.html#cv_image" name="OpenCV Image"/>
<term file="imaging.html" name="rgb_alpha_pixel"/> <term file="imaging.html" name="rgb_alpha_pixel"/>
<term link="imaging.html#rgb_alpha_pixel" name="alpha"/> <term link="imaging.html#rgb_alpha_pixel" name="alpha"/>
......
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