updated docs

docs/docs/imaging.xml

@@ -77,6 +77,23 @@
          <item>save_png</item> 
       </section>
 
+      <section>
+         <name>Object Detection</name>
+         <item>object_detector</item>
+         <item>scan_image</item>
+         <item>scan_image_pyramid</item>
+         <item>test_box_overlap</item>
+         <item nolink="true">
+            <name>Detection_Templates</name>
+            <sub>
+               <item>compute_box_dimensions</item>
+               <item>create_single_box_detection_template</item>
+               <item>create_overlapped_2x2_detection_template</item>
+               <item>create_grid_detection_template</item>
+            </sub>
+         </item>
+      </section>
+
       <section>
          <name>Keypoints and Descriptors</name>
 
@@ -86,6 +103,7 @@
          <item>compute_dominant_angle</item>
          <item>compute_surf_descriptor</item>
          <item>hog_image</item>
+         <item>hashed_feature_image</item>
          <item>haar_x</item>
          <item>haar_y</item>
          <item>get_interest_points</item>
@@ -134,7 +152,6 @@
          <item>binary_union</item>
          <item>binary_difference</item>
          <item>binary_complement</item>
-         <item>scan_image</item>
       </section>
 
     </top>  
@@ -277,6 +294,23 @@
                                  
       </component>
 
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>hashed_feature_image</name>
+         <file>dlib/image_keypoint.h</file>
+         <spec_file link="true">dlib/image_keypoint/hashed_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 indicator vectors.  It does
+                this by hashing each feature vector and then returns a new vector 
+                which is zero everywhere except for the position determined by the 
+                hash.  
+         </description>
+                                 
+      </component>
+
    <!-- ************************************************************************* -->
       
       <component>
@@ -1076,7 +1110,115 @@
       </component>
             
    <!-- ************************************************************************* -->
-      
+
+      <component>
+         <name>scan_image_pyramid</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/scan_image_pyramid_abstract.h</spec_file>
+         <description>        
+                This object is a tool for running a sliding window classifier over
+                an image pyramid.  This object can also be understood as a general 
+                tool for implementing the spatial pyramid models described in the paper:
+                <blockquote>
+                    Beyond Bags of Features: Spatial Pyramid Matching for Recognizing 
+                    Natural Scene Categories by Svetlana Lazebnik, Cordelia Schmid, 
+                    and Jean Ponce
+                </blockquote>
+         </description>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>object_detector</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/object_detector_abstract.h</spec_file>
+         <description>        
+                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 <a href="#scan_image_pyramid">scan_image_pyramid</a> 
+                class, the weight vector needed by scan_image_pyramid, and finally 
+                an instance of <a href="#test_box_overlap">test_box_overlap</a>.  The test_box_overlap 
+                object is used to perform non-max suppression on the output of the 
+                scan_image_pyramid object.  
+         </description>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>test_box_overlap</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/box_overlap_testing_abstract.h</spec_file>
+         <description>        
+            This object is a simple function object for determining if two 
+            <a href="algorithms.html#rectangle">rectangles</a> overlap.  
+         </description>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>compute_box_dimensions</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/detection_template_tools_abstract.h</spec_file>
+         <description>        
+            This function is a tool for computing a rectangle with a particular 
+            width/height ratio and area.
+         </description>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>create_single_box_detection_template</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/detection_template_tools_abstract.h</spec_file>
+         <description>        
+            This function is a tool for creating a detection template usable by 
+            the <a href="#scan_image_pyramid">scan_image_pyramid</a> object.  This
+            particular function creates a detection template with exactly one feature
+            extraction region.
+         </description>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>create_overlapped_2x2_detection_template</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/detection_template_tools_abstract.h</spec_file>
+         <description>        
+            This function is a tool for creating a detection template usable by 
+            the <a href="#scan_image_pyramid">scan_image_pyramid</a> object.  This
+            particular function creates a detection template with four overlapping feature
+            extraction regions.
+         </description>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>create_grid_detection_template</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/detection_template_tools_abstract.h</spec_file>
+         <description>        
+            This function is a tool for creating a detection template usable by 
+            the <a href="#scan_image_pyramid">scan_image_pyramid</a> object.  This
+            particular function creates a detection template with a grid of feature
+            extraction regions.
+         </description>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
    </components>
 
    <!-- ************************************************************************* -->

docs/docs/ml.xml

@@ -93,6 +93,7 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
       <section>
          <name>Structured Prediction</name>
          <item>structural_svm_problem</item> 
+         <item>structural_svm_object_detection_problem</item> 
          <item>structural_svm_problem_threaded</item> 
          <item>svm_struct_controller_node</item> 
          <item>svm_struct_processing_node</item> 
@@ -2105,6 +2106,29 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
                                  
       </component>
       
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>structural_svm_object_detection_problem</name>
+         <file>dlib/svm_threaded.h</file>
+         <spec_file link="true">dlib/svm/structural_svm_object_detection_problem_abstract.h</spec_file>
+         <description>
+               This object is a tool for learning the parameter vector needed to use
+               a <a href="imaging.html#scan_image_pyramid">scan_image_pyramid</a> object.  
+
+            <p>
+               It learns the parameter vector by formulating the problem as a <a href="#structural_svm_problem">structural 
+               SVM problem</a>.  The general approach is similar to the method discussed in 
+               Learning to Localize Objects with Structured Output Regression by 
+               Matthew B. Blaschko and Christoph H. Lampert.  However, the method has 
+               been extended to datasets with multiple, potentially overlapping, objects 
+               per image and the measure of loss is different from what is described in 
+               the paper.  
+            </p>
+         </description>
+                                 
+      </component>
+      
    <!-- ************************************************************************* -->
       
       <component>

docs/docs/term_index.xml

@@ -36,6 +36,7 @@
          <term file="dlib/optimization/optimization_oca_abstract.h.html" name="oca_problem"/>
          <term file="ml.html" name="structural_svm_problem"/>
          <term file="ml.html" name="structural_svm_problem_threaded"/>
+         <term file="ml.html" name="structural_svm_object_detection_problem"/>
          <term file="ml.html" name="svm_struct_controller_node"/>
          <term file="ml.html" name="svm_struct_processing_node"/>
 
@@ -979,6 +980,7 @@
          <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="hashed_feature_image"/>
          <term file="imaging.html" name="haar_x"/>
          <term file="imaging.html" name="haar_y"/>
          <term file="imaging.html" name="get_interest_points"/>
@@ -986,7 +988,14 @@
          <term file="imaging.html" name="interest_point"/>
          <term file="imaging.html" name="surf_point"/>
 
+         <term file="imaging.html" name="test_box_overlap"/>
+         <term file="imaging.html" name="object_detector"/>
          <term file="imaging.html" name="scan_image"/>
+         <term file="imaging.html" name="scan_image_pyramid"/>
+         <term file="imaging.html" name="compute_box_dimensions"/>
+         <term file="imaging.html" name="create_single_box_detection_template"/>
+         <term file="imaging.html" name="create_overlapped_2x2_detection_template"/>
+         <term file="imaging.html" name="create_grid_detection_template"/>
          <term file="dlib/image_processing/scan_image_abstract.h.html" name="all_images_same_size"/>
          <term file="dlib/image_processing/scan_image_abstract.h.html" name="sum_of_rects_in_images"/>