From 7da29fb98b07cb0e6920c90a2e68583c4140f686 Mon Sep 17 00:00:00 2001 From: Davis King Date: Sat, 17 Aug 2013 22:17:15 -0400 Subject: [PATCH] updated docs --- docs/docs/imaging.xml | 37 ++++++++++++++++++++++++++++++++++--- docs/docs/ml.xml | 5 +++-- docs/docs/term_index.xml | 1 + 3 files changed, 38 insertions(+), 5 deletions(-) diff --git a/docs/docs/imaging.xml b/docs/docs/imaging.xml index 68e4aefa3..acf382468 100644 --- a/docs/docs/imaging.xml +++ b/docs/docs/imaging.xml @@ -86,6 +86,7 @@ find_points_above_thresh scan_image_pyramid scan_image_boxes + scan_image_custom find_candidate_object_locations test_box_overlap remove_unobtainable_rectangles @@ -1729,6 +1730,34 @@ + + + + scan_image_custom + dlib/image_processing.h + dlib/image_processing/scan_image_custom_abstract.h + + This object is a tool for running a classifier over an image with the goal + of localizing each object present. The localization is in the form of the + bounding box around each object of interest. + +

+ Unlike the scan_image_pyramid + and scan_image_boxes objects, this image + scanner delegates all the work of constructing the object feature vector to + a user supplied feature extraction object. That is, scan_image_custom + simply asks the supplied feature extractor what boxes in the image we + should investigate and then asks the feature extractor for the complete + feature vector for each box. That is, scan_image_custom does not apply any + kind of pyramiding or other higher level processing to the features coming + out of the feature extractor. That means that when you use + scan_image_custom it is completely up to you to define the feature vector + used with each image box. +

+ + + + @@ -1750,9 +1779,11 @@ dlib/image_processing/object_detector_abstract.h This object is a tool for detecting the positions of objects in an image. In - particular, it is a simple container to aggregate an instance of the scan_image_pyramid or scan_image_boxes classes, the weight vector + particular, it is a simple container to aggregate an instance of an image + scanner object (either scan_image_pyramid, scan_image_boxes, or + scan_image_custom), the weight vector needed by one of these image scanners, and finally an instance of test_box_overlap. The test_box_overlap object is used to perform non-max suppression on the output of the image scanner diff --git a/docs/docs/ml.xml b/docs/docs/ml.xml index 7aa5b8418..b7e77268c 100644 --- a/docs/docs/ml.xml +++ b/docs/docs/ml.xml @@ -2694,8 +2694,9 @@ Davis E. King. dlib/svm/structural_svm_object_detection_problem_abstract.h This object is a tool for learning the parameter vector needed to use - a scan_image_pyramid or - scan_image_boxes object. + a scan_image_pyramid, + scan_image_boxes, or + scan_image_custom object.

It learns the parameter vector by formulating the problem as a structural diff --git a/docs/docs/term_index.xml b/docs/docs/term_index.xml index 31f24b0a9..833c8eca1 100644 --- a/docs/docs/term_index.xml +++ b/docs/docs/term_index.xml @@ -1263,6 +1263,7 @@ +