Skip to content

D
dlib
Commit 4f159e7e authored by Davis King's avatar Davis King
Browse files
Options

updated docs

parent 35d6a5b7
Show whitespace changes
Inline Side-by-side
Showing with 144 additions and 1 deletion
docs/docs/imaging.xml
View file @ 4f159e7e
......@@ -107,6 +107,7 @@
<item>scan_fhog_pyramid</item>
<item>scan_image_custom</item>
<item>find_candidate_object_locations</item>
<item>min_barrier_distance</item>
<item>test_box_overlap</item>
<item>remove_unobtainable_rectangles</item>
<item>setup_hashed_features</item>
......@@ -233,6 +234,7 @@
<item>flip_image_dataset_left_right</item>
<item>rotate_image_dataset</item>
<item>extract_image_chips</item>
<item>extract_image_4points</item>
<item>random_cropper</item>
<item>jitter_image</item>
<item>sub_image</item>
......@@ -1898,6 +1900,29 @@
</examples>
</component>
<!-- ************************************************************************* -->
<component>
<name>extract_image_4points</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/interpolation_abstract.h</spec_file>
<description>
This function allows you to extract an arbitrary quadrilateral patch from
an image. For example, given the image on the left and the 4 corners of the
red box you can extract the image on the right:
<br/>
<br/>
<center>
<table>
<tr>
<td><img src="images/extract_image_4points_source.jpg"/></td>
<td><img src="images/extract_image_4points_crop.jpg"/></td>
</tr>
</table>
</center>
</description>
</component>
<!-- ************************************************************************* -->
<component>
......@@ -2169,6 +2194,34 @@
</examples>
</component>
<!-- ************************************************************************* -->
<component>
<name>min_barrier_distance</name>
<file>dlib/image_transforms.h</file>
<spec_file link="true">dlib/image_transforms/segment_image_abstract.h</spec_file>
<description>
This function implements the salient object detection method described in the paper:
<blockquote>
"Minimum barrier salient object detection at 80 fps" by Zhang, Jianming, et al.
</blockquote>
This routine takes an image as input and creates a new image where objects that are
visually distinct from the borders of the image have bright pixels while everything else is
dark. This is useful because you can then threshold the resulting image to detect objects.
For example, given the left image as input you get the right image as output:
<br/>
<br/>
<center>
<table>
<tr>
<td><img src="images/mbd_example_in.jpg"/></td>
<td><img src="images/mbd_example_out.jpg"/></td>
</tr>
</table>
</center>
</description>
</component>
<!-- ************************************************************************* -->
<component>
......
docs/docs/linear_algebra.xml
View file @ 4f159e7e
......@@ -663,6 +663,9 @@
<item>intersect</item>
<item>count_points_on_side_of_line</item>
<item>count_points_between_lines</item>
<item>angle_between_lines</item>
<item>is_convex_quadrilateral</item>
<item>find_convex_quadrilateral</item>
</section>
......@@ -823,6 +826,42 @@
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>angle_between_lines</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/line_abstract.h</spec_file>
<description>
This routine returns the angle, in degrees, between two <a
href="#line">lines</a>. This is a number in the range [0 90].
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>is_convex_quadrilateral</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This routine tests if 4 points define a convex quadrilateral.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>find_convex_quadrilateral</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/line_abstract.h</spec_file>
<description>
This routine takes 4 <a href="#line">lines</a> as input and determines if their
intersections form a convex quadrilateral. If so it returns the 4 corners of
this quadrilateral.
</description>
</component>
<!-- ************************************************************************* -->
......
docs/docs/release_notes.xml
View file @ 4f159e7e
......@@ -11,6 +11,49 @@
<!-- ************************************************************************************** -->
<current>
New Features and Improvements:
- Added a lot of new Python bindings. You can now use these things from Python:
- gaussian_blur(), label_connected_blobs(), randomly_color_image(), jet(),
skeleton(), find_line_endpoints(), get_rect(), shrink_rect(), grow_rect(),
image_gradients, label_connected_blobs_watershed(), convert_image(),
convert_image_scaled(), dpoint, centered_rect(), centered_rects(), length(),
as_grayscale(), pyramid_down, find_bright_keypoints(), find_bright_lines(),
find_dark_lines(), find_dark_keypoints(), suppress_non_maximum_edges(),
find_peaks(), hysteresis_threshold(), sobel_edge_detector(), equalize_histogram(),
resize_image(), hough_transform, remove_incoherent_edge_pixels(),
normalize_image_gradients(), line, signed_distance_to_line(), distance_to_line(),
reverse(), intersect(), count_points_on_side_of_line(),
count_points_between_lines(), dot(), normalize(), point_transform_projective,
find_projective_transform(), inv(), transform_image(), angle_between_lines(),
extract_image_4points(), load_grayscale_image(), min_barrier_distance().
- Added a .add_overlay_circle() to dlib.image_window. Also made .add_overlay()
take lines.
- Added the *_corner() routines to rectangle and drectangle and made these
objects constructable from instances of each other.
- Made the Python extension module automatically enable AVX instructions if the host
machine supports them. So you never need to say --yes USE_AVX_INSTRUCTIONS anymore
when installing dlib.
- New C++ routines:
- Added an image_window::add_overlay() overload for line object.
- Added angle_between_lines()
- Added extract_image_4points()
- Added is_convex_quadrilateral(), find_convex_quadrilateral(), and no_convex_quadrilateral.
- Added python_list_to_array()
- Added min_barrier_distance()
Non-Backwards Compatible Changes:
Bug fixes:
- Fixed numpy_image and pybind11 crashing python sometimes when certain types of
conversions are attempted.
- Fixed some python functions not taking as wide a range of image types as they did in
previous dlib versions.
</current>
<!-- ************************************************************************************** -->
<old name="19.12" date="May 19, 2018">
New Features and Improvements:
- Added Python interface to threshold_image() and partition_pixels().
......@@ -20,7 +63,7 @@ Non-Backwards Compatible Changes:
Bug fixes:
- Dlib 19.11 had a bug that caused the Python interface to reject grayscale images.
This has been fixed.
</current>
</old>
<!-- ************************************************************************************** -->
......
docs/docs/term_index.xml
View file @ 4f159e7e
......@@ -433,6 +433,10 @@
<term file="linear_algebra.html" name="intersect" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="count_points_on_side_of_line" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="count_points_between_lines" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="angle_between_lines" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="is_convex_quadrilateral" include="dlib/geometry.h"/>
<term file="linear_algebra.html" name="find_convex_quadrilateral" include="dlib/geometry.h"/>
<term file="dlib/geometry/line_abstract.h.html" name="no_convex_quadrilateral" include="dlib/geometry.h"/>
<term file="algorithms.html" name="running_stats" include="dlib/statistics.h"/>
......@@ -1514,6 +1518,7 @@
<term file="dlib/image_transforms/image_pyramid_abstract.h.html" name="image_to_tiled_pyramid" include="dlib/image_transforms.h"/>
<term file="dlib/image_transforms/image_pyramid_abstract.h.html" name="tiled_pyramid_to_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="threshold_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="min_barrier_distance" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="partition_pixels" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="png_loader" include="dlib/image_io.h"/>
<term file="imaging.html" name="jpeg_loader" include="dlib/image_io.h"/>
......@@ -1525,6 +1530,7 @@
<term file="imaging.html" name="rotate_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="resize_image" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="extract_image_chips" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="extract_image_4points" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="random_cropper" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="sub_image" include="dlib/image_transforms.h"/>
<term file="dlib/image_transforms/interpolation_abstract.h.html" name="sub_image_proxy" include="dlib/image_transforms.h"/>
......
docs/makedocs
View file @ 4f159e7e
......@@ -184,6 +184,8 @@ makedocs ()
cp docs/ml_guide.svg docs/chm/docs
cp -r docs/guipics docs/web
cp -r docs/guipics docs/chm/docs
cp -r docs/images docs/web
cp -r docs/images docs/chm/docs
cp docs/*.html docs/web
cp docs/*.html docs/chm/docs
cp docs/*.css docs/web
......
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