updated docs

docs/docs/imaging.xml

@@ -165,6 +165,7 @@
          <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> 
          <item>interpolate_bilinear</item> 
@@ -1125,6 +1126,23 @@
                                  
       </component>
             
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>pyramid_disable</name>
+         <file>dlib/image_transforms.h</file>
+         <spec_file link="true">dlib/image_transforms/image_pyramid_abstract.h</spec_file>
+         <description>        
+               This object downsamples an image at a ratio of infinity to 1.  That
+               means it always outputs an image of size zero.  This is useful because
+               it can be supplied to routines which take a pyramid_down function object
+               and it will essentially disable pyramid processing.  This way, a pyramid
+               oriented function can be turned into a regular routine which processes
+               just the original undownsampled image.
+         </description>
+                                 
+      </component>
+            
    <!-- ************************************************************************* -->
       
       <component>

docs/docs/term_index.xml

@@ -1056,6 +1056,7 @@
          <term file="imaging.html" name="separable_3x3_filter_block_grayscale"/>
          <term file="imaging.html" name="separable_3x3_filter_block_rgb"/>
          <term file="imaging.html" name="pyramid_down"/>
+         <term file="imaging.html" name="pyramid_disable"/>
          <term file="imaging.html" name="pyramid_down_3_2"/>
          <term file="imaging.html" name="pyramid_down_4_3"/>
          <term file="imaging.html" name="pyramid_down_5_4"/>