Commit ca68fc80 authored by Davis King's avatar Davis King

updated docs

parent c0eaf1fd
......@@ -240,6 +240,7 @@
<item>zero_border_pixels</item>
<item>integral_image</item>
<item>integral_image_generic</item>
<item>hough_transform</item>
</section>
......@@ -252,6 +253,24 @@
<components>
<!-- ************************************************************************* -->
<component>
<name>hough_transform</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/hough_transform_abstract.h</spec_file>
<description>
This object is a tool for computing the line finding version of
the Hough transform given some kind of edge detection image as
input. It also allows the edge pixels to be weighted such that
higher weighted edge pixels contribute correspondingly more to
the output of the Hough transform, allowing stronger edges to
create correspondingly stronger line detections in the final
Hough transform.
</description>
</component>
<!-- ************************************************************************* -->
<component>
......
......@@ -620,6 +620,8 @@
<item>move_rect</item>
<item>nearest_point</item>
<item>distance_to_rect_edge</item>
<item>clip_line_to_rectangle</item>
<item>distance_to_line</item>
</section>
......@@ -857,6 +859,32 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>distance_to_line</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a line and a <a href="#point">point</a>
and returns the distance from the line to the point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>clip_line_to_rectangle</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and a line segment and
returns the part of the line segment that is entirely contained within the
rectangle.
</description>
</component>
<!-- ************************************************************************* -->
<component>
......
......@@ -47,6 +47,8 @@
<term file="linear_algebra.html" name="center" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="nearest_point" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="distance_to_rect_edge" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="distance_to_line" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="clip_line_to_rectangle" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="shrink_rect" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="grow_rect" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="dcenter" include="dlib/geometry.h"/>
......@@ -1284,6 +1286,7 @@
<term file="imaging.html" name="integral_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="integral_image_generic" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="hough_transform" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="hessian_pyramid" include="dlib/image_keypoint.h"/>
<term file="imaging.html" name="compute_dominant_angle" include="dlib/image_keypoint.h"/>
<term file="imaging.html" name="draw_surf_points" include="dlib/image_keypoint/draw_surf_points.h"/>
......
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