Skip to content

D
dlib
Commit 5c710a6a authored by Davis King's avatar Davis King
Browse files
Options

updated docs

parent e0a6e305
Show whitespace changes
Inline Side-by-side
Showing with 5 additions and 65 deletions
docs/docs/imaging.xml
View file @ 5c710a6a
......@@ -176,10 +176,6 @@
<name>Scaling and Rotating</name>
<item>pyramid_up</item>
<item>pyramid_down</item>
<item>pyramid_down_generic</item>
<item>pyramid_down_3_2</item>
<item>pyramid_down_4_3</item>
<item>pyramid_down_5_4</item>
<item>pyramid_disable</item>
<item>interpolate_nearest_neighbor</item>
......@@ -1312,36 +1308,10 @@
<name>pyramid_down</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/image_pyramid_abstract.h</spec_file>
<description>
This is a simple function object to help create image pyramids. It
downsamples an image by half.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>pyramid_down_generic</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/image_pyramid_abstract.h</spec_file>
<description>
This is a simple function object to help create image pyramids. It
downsamples an image by a ratio of N to N-1 where N is supplied by the
user.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>pyramid_down_3_2</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/image_pyramid_abstract.h</spec_file>
<description>
This is a simple function object to help create image pyramids. It
downsamples an image by a ratio of 3 to 2.
user as a template argument.
</description>
</component>
......@@ -1363,32 +1333,6 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>pyramid_down_4_3</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/image_pyramid_abstract.h</spec_file>
<description>
This is a simple function object to help create image pyramids. It
downsamples an image by a ratio of 4 to 3.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>pyramid_down_5_4</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/image_pyramid_abstract.h</spec_file>
<description>
This is a simple function object to help create image pyramids. It
downsamples an image by a ratio of 5 to 4.
</description>
</component>
<!-- ************************************************************************* -->
<component>
......@@ -1458,10 +1402,10 @@
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/interpolation_abstract.h</spec_file>
<description>
This routine upsamples an image. In particular, it takes one of the
<a href="#pyramid_down">pyramid_down</a> objects as an argument and
performs an upsampling which is the inverse of the supplied pyramid_down
object.
This routine upsamples an image. In particular, it takes a
<a href="#pyramid_down">pyramid_down</a> object (or an object with a
compatible interface) as an argument and performs an upsampling
which is the inverse of the supplied pyramid_down object.
</description>
</component>
......
docs/docs/term_index.xml
View file @ 5c710a6a
......@@ -1216,11 +1216,7 @@
<term file="imaging.html" name="separable_3x3_filter_block_grayscale" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="separable_3x3_filter_block_rgb" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="pyramid_down" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="pyramid_down_generic" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="pyramid_disable" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="pyramid_down_3_2" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="pyramid_down_4_3" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="pyramid_down_5_4" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="threshold_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="auto_threshold_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="png_loader" include="dlib/image_io.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