updated docs with recent additions

docs/docs/algorithms.xml

@@ -104,6 +104,7 @@
          <item>running_covariance</item> 
          <item>random_subset_selector</item> 
          <item>randomly_subsample</item> 
+         <item>randomly_sample_image_features</item> 
 
       </section>
 
@@ -113,6 +114,8 @@
          <item>crc32</item> 
          <item>hash</item> 
          <item>murmur_hash3</item> 
+         <item>projection_hash</item> 
+         <item>create_random_projection_hash</item> 
       </section>
     </top>  
    </menu>
@@ -202,6 +205,33 @@
          
       </component>
             
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>projection_hash</name>
+         <file>dlib/lsh.h</file>
+         <spec_file>dlib/lsh/projection_hash_abstract.h</spec_file>
+         <description>
+                This is a tool for hashing elements of a vector space into the integers.  
+                It is intended to represent locality sensitive hashing functions such as 
+                the popular <a href="#create_random_projection_hash">random projection hashing</a> method.
+         </description>
+         
+      </component>
+            
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>create_random_projection_hash</name>
+         <file>dlib/lsh.h</file>
+         <spec_file>dlib/lsh/create_random_projection_hash_abstract.h</spec_file>
+         <description>
+            Creates a random projection based locality sensitive 
+            <a href="#projection_hash">hashing function</a>.
+         </description>
+         
+      </component>
+            
    <!-- ************************************************************************* -->
       
       <component>
@@ -427,6 +457,20 @@
                                  
       </component>
       
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>randomly_sample_image_features</name>
+         <file>dlib/statistics.h</file>
+         <spec_file link="true">dlib/statistics/image_feature_sampling_abstract.h</spec_file>
+         <description>
+            Given a feature extractor such as the <a href="imaging.html#hog_image">hog_image</a>,
+            this routine selects a random subsample of local image feature vectors 
+            from a set of images.  
+         </description>
+                                 
+      </component>
+      
    <!-- ************************************************************************* -->
 
       <component>

docs/docs/imaging.xml

@@ -84,12 +84,16 @@
          <item>scan_image_pyramid</item>
          <item>test_box_overlap</item>
          <item nolink="true">
-            <name>Detection_Templates</name>
+            <name>Scan Image Pyramid Tools</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>
+
+               <item>determine_object_boxes</item>
+               <item>setup_grid_detection_templates</item>
+               <item>setup_hashed_features</item>
             </sub>
          </item>
       </section>
@@ -1322,6 +1326,59 @@
                                  
       </component>
             
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>determine_object_boxes</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/scan_image_pyramid_tools_abstract.h</spec_file>
+         <description>        
+            The <a href="#scan_image_pyramid">scan_image_pyramid</a> object represents a sliding
+            window classifier system.  For it to work correctly it needs to be given a set of
+            object boxes which define the size and shape of each sliding window and these windows
+            need to be able to match the sizes and shapes of targets the user wishes to detect.
+            Therefore, the determine_object_boxes() routine is a tool for computing a set of object boxes
+            which can meet this requirement.
+
+         </description>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>setup_grid_detection_templates</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/scan_image_pyramid_tools_abstract.h</spec_file>
+         <description>        
+            This routine uses <a href="#determine_object_boxes">determine_object_boxes</a> to obtain a set of
+              object boxes and then adds them to a <a href="#scan_image_pyramid">scan_image_pyramid</a> object 
+              as detection templates.  It also uses <a href="#create_grid_detection_template">create_grid_detection_template</a>
+               to create each feature extraction region.  Therefore, the detection templates will extract
+              features from a regular grid inside each object box.
+         </description>
+         <examples>
+            <example>object_detector_ex.cpp.html</example>
+         </examples>
+                                 
+      </component>
+            
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>setup_hashed_features</name>
+         <file>dlib/image_processing.h</file>
+         <spec_file link="true">dlib/image_processing/scan_image_pyramid_tools_abstract.h</spec_file>
+         <description>        
+            This is a tool for configuring the <a href="#hashed_feature_image">hashed_feature_image</a> object
+            with a random <a href="algorithms.html#projection_hash">projection hash</a>. 
+         </description>
+         <examples>
+            <example>object_detector_ex.cpp.html</example>
+         </examples>
+                                 
+      </component>
+            
    <!-- ************************************************************************* -->
 
    </components>

docs/docs/term_index.xml

@@ -9,7 +9,6 @@
    <body>
       <term_list>
 
-   <!-- ************* DLIB-ML STUFF **************** -->
 
          <term file="dlib/rand/rand_float_abstract.h.html" name="get_random_float"/>
          <term link="compile.html" name="DLIB_REVISION"/>
@@ -112,6 +111,9 @@
          <term file="bayes.html" name="node_next_parent_assignment"/>
          <term file="bayes.html" name="node_cpt_filled_out"/>
 
+         <term file="algorithms.html" name="projection_hash"/>
+         <term file="algorithms.html" name="create_random_projection_hash"/>
+         <term file="algorithms.html" name="randomly_sample_image_features"/>
          <term file="algorithms.html" name="disjoint_subsets"/>
          <term link="algorithms.html#disjoint_subsets" name="union-find"/>
          <term file="algorithms.html" name="rectangle"/>
@@ -554,9 +556,6 @@
 
          <term link="intro.html#Creating Objects" name="debugging modes: enable/disable"/>
 
-   <!-- ******************************************** -->
-   <!-- ************* GENERAL STUFF **************** -->
-   <!-- ******************************************** -->
 
          <term file="other.html" name="console_progress_indicator"/>
 
@@ -1050,8 +1049,13 @@
          <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="imaging.html" name="determine_object_boxes"/>
+         <term file="imaging.html" name="setup_grid_detection_templates"/>
+         <term file="imaging.html" name="setup_hashed_features"/>
          <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"/>
+         <term file="dlib/image_processing/box_overlap_testing_abstract.h.html" name="find_tight_overlap_tester"/>
+         <term file="dlib/image_processing/scan_image_pyramid_tools_abstract.h.html" name="image_hash_construction_failure"/>