Skip to content

D
dlib
Commit 0b3a6207 authored by Davis King's avatar Davis King
Browse files
Options

updated docs

parent 444f42eb
Hide whitespace changes
Inline Side-by-side
Showing with 86 additions and 15 deletions
docs/docs/imaging.xml
View file @ 0b3a6207
......@@ -99,23 +99,29 @@
</section>
<section>
<name>Keypoints and Descriptors</name>
<name>Feature Extraction</name>
<item>get_surf_points</item>
<item nolink="true">
<name>SURF Tools</name>
<sub>
<item>hessian_pyramid</item>
<item>compute_surf_descriptor</item>
<item>haar_x</item>
<item>haar_y</item>
<item>get_interest_points</item>
<item>interest_point</item>
<item>surf_point</item>
<item>compute_dominant_angle</item>
</sub>
</item>
<item>integral_image</item>
<item>integral_image_generic</item>
<item>hessian_pyramid</item>
<item>compute_dominant_angle</item>
<item>compute_surf_descriptor</item>
<item>hog_image</item>
<item>poly_image</item>
<item>hashed_feature_image</item>
<item>haar_x</item>
<item>haar_y</item>
<item>get_interest_points</item>
<item>get_surf_points</item>
<item>interest_point</item>
<item>surf_point</item>
<item>nearest_neighbor_feature_image</item>
</section>
<section>
<name>Edges and Thresholds</name>
<item>edge_orientation</item>
......@@ -170,6 +176,8 @@
<item>pyramid_down_4_3</item>
<item>pyramid_down_5_4</item>
<item>zero_border_pixels</item>
<item>integral_image</item>
<item>integral_image_generic</item>
</section>
......@@ -316,6 +324,22 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>poly_image</name>
<file>dlib/image_keypoint.h</file>
<spec_file link="true">dlib/image_keypoint/hog_abstract.h</spec_file>
<description>
This object is a tool for extracting local feature descriptors from an image.
In particular, it fits a polynomial to every local pixel patch in an image and
allows you to query the coefficients of this polynomial. The coefficients
are intensity normalized by dividing them by the constant term of the fitted
polynomial and then the constant term is discarded.
</description>
</component>
<!-- ************************************************************************* -->
<component>
......@@ -329,6 +353,13 @@
this by hashing each feature vector and then returns a new vector
which is zero everywhere except for the position determined by the
hash.
<br/><br/>
The following feature extractors can be wrapped by the hashed_feature_image:
<ul style="margin-top:0em">
<li><a href="#hog_image">hog_image</a></li>
<li><a href="#poly_image">poly_image</a></li>
</ul>
</description>
<examples>
<example>object_detector_ex.cpp.html</example>
......@@ -336,6 +367,30 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>nearest_neighbor_feature_image</name>
<file>dlib/image_keypoint.h</file>
<spec_file link="true">dlib/image_keypoint/nearest_neighbor_feature_image_abstract.h</spec_file>
<description>
This object is a tool for performing image feature extraction. In
particular, it wraps another image feature extractor and converts
the wrapped image feature vectors into sparse indicator vectors. It does
this by finding the nearest neighbor for each feature vector and returning an
indicator vector that is zero everywhere except for the position indicated by
the nearest neighbor.
<br/><br/>
The following feature extractors can be wrapped by the nearest_neighbor_feature_image:
<ul style="margin-top:0em">
<li><a href="#hog_image">hog_image</a></li>
<li><a href="#poly_image">poly_image</a></li>
</ul>
</description>
</component>
<!-- ************************************************************************* -->
<component>
......@@ -1250,6 +1305,13 @@
Natural Scene Categories by Svetlana Lazebnik, Cordelia Schmid,
and Jean Ponce
</blockquote>
<br/><br/>
The following feature extractors can be used with the scan_image_pyramid object:
<ul style="margin-top:0em">
<li><a href="#hashed_feature_image">hashed_feature_image</a></li>
<li><a href="#nearest_neighbor_feature_image">nearest_neighbor_feature_image</a></li>
</ul>
</description>
<examples>
<example>object_detector_ex.cpp.html</example>
......
docs/docs/stylesheet.xsl
View file @ 0b3a6207
......@@ -834,9 +834,16 @@ function BigToggle(node)
</li>
</xsl:template>
<xsl:template match="ul">
<ul>
<xsl:apply-templates/>
</ul>
<xsl:if test="@style">
<ul style="{@style}">
<xsl:apply-templates/>
</ul>
</xsl:if>
<xsl:if test="not(@style)">
<ul>
<xsl:apply-templates/>
</ul>
</xsl:if>
</xsl:template>
<xsl:template match="u">
<u>
......
docs/docs/term_index.xml
View file @ 0b3a6207
......@@ -1035,7 +1035,9 @@
<term file="imaging.html" name="compute_dominant_angle"/>
<term file="imaging.html" name="compute_surf_descriptor"/>
<term file="imaging.html" name="hog_image"/>
<term file="imaging.html" name="poly_image"/>
<term file="imaging.html" name="hashed_feature_image"/>
<term file="imaging.html" name="nearest_neighbor_feature_image"/>
<term file="imaging.html" name="haar_x"/>
<term file="imaging.html" name="haar_y"/>
<term file="imaging.html" name="get_interest_points"/>
......
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