libs/gil/doc/html/reference/group___image_view_s_t_l_algorithms.html

   1 <!-- HTML header for doxygen 1.8.13-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6     <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7     <meta name="generator" content="Doxygen 1.8.15"/>
   8     <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9     <title>Generic Image Library: STL-like Algorithms</title>
  10     <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11     <script type="text/javascript" src="jquery.js"></script>
  12     <script type="text/javascript" src="dynsections.js"></script>
  13     <link href="doxygen.css" rel="stylesheet" type="text/css" />
  14     <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
  15   </head>
  16   <body>
  17     <div class="boost-header">
  18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19         <tr>
  20           <td valign="top" width="300">
  21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22           </td>
  23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24           <td></td>
  25         </tr>
  26       </table>
  27     </div>
  28     <hr/>
  29     <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30 <!-- Generated by Doxygen 1.8.15 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#groups">Modules</a> &#124;
  44 <a href="#nested-classes">Classes</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">STL-like Algorithms<div class="ingroups"><a class="el" href="group___image_view.html">Image View</a> &raquo; <a class="el" href="group___image_view_algorithm.html">Algorithms and Utility Functions</a></div></div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p>Image view-equivalents of STL algorithms.
  51 <a href="#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  54 Modules</h2></td></tr>
  55 <tr class="memitem:group___image_view_s_t_l_algorithms_copy_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_copy_pixels.html">copy_pixels</a></td></tr>
  56 <tr class="memdesc:group___image_view_s_t_l_algorithms_copy_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::copy for image views <br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:group___image_view_s_t_l_algorithms_copy_and_convert_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_copy_and_convert_pixels.html">copy_and_convert_pixels</a></td></tr>
  59 <tr class="memdesc:group___image_view_s_t_l_algorithms_copy_and_convert_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">copies src view into dst view, color converting if necessary. <br /></td></tr>
  60 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:group___image_view_s_t_l_algorithms_fill_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_fill_pixels.html">fill_pixels</a></td></tr>
  62 <tr class="memdesc:group___image_view_s_t_l_algorithms_fill_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::fill for image views <br /></td></tr>
  63 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 <tr class="memitem:group___image_view_s_t_l_algorithms_destruct_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_destruct_pixels.html">destruct_pixels</a></td></tr>
  65 <tr class="memdesc:group___image_view_s_t_l_algorithms_destruct_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">invokes the destructor on every pixel of an image view <br /></td></tr>
  66 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:group___image_view_s_t_l_algorithms_uninitialized_fill_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_uninitialized_fill_pixels.html">uninitialized_fill_pixels</a></td></tr>
  68 <tr class="memdesc:group___image_view_s_t_l_algorithms_uninitialized_fill_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::uninitialized_fill for image views <br /></td></tr>
  69 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:group___image_view_s_t_l_algorithms_default_construct_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_default_construct_pixels.html">default_construct_pixels</a></td></tr>
  71 <tr class="memdesc:group___image_view_s_t_l_algorithms_default_construct_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">invokes the default constructor on every pixel of an image view <br /></td></tr>
  72 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 <tr class="memitem:group___image_view_s_t_l_algorithms_uninitialized_copy_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_uninitialized_copy_pixels.html">uninitialized_copy_pixels</a></td></tr>
  74 <tr class="memdesc:group___image_view_s_t_l_algorithms_uninitialized_copy_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::uninitialized_copy for image views <br /></td></tr>
  75 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:group___image_view_s_t_l_algorithms_for_each_pixel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_for_each_pixel.html">for_each_pixel</a></td></tr>
  77 <tr class="memdesc:group___image_view_s_t_l_algorithms_for_each_pixel"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::for_each for image views <br /></td></tr>
  78 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:group___image_view_s_t_l_algorithms_for_each_pixel_position"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_for_each_pixel_position.html">for_each_pixel_position</a></td></tr>
  80 <tr class="memdesc:group___image_view_s_t_l_algorithms_for_each_pixel_position"><td class="mdescLeft">&#160;</td><td class="mdescRight">adobe::for_each_position for image views (passes locators, instead of pixel references, to the function object) <br /></td></tr>
  81 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:group___image_view_s_t_l_algorithms_generate_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_generate_pixels.html">generate_pixels</a></td></tr>
  83 <tr class="memdesc:group___image_view_s_t_l_algorithms_generate_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::generate for image views <br /></td></tr>
  84 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <tr class="memitem:group___image_view_s_t_l_algorithms_equal_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_equal_pixels.html">equal_pixels</a></td></tr>
  86 <tr class="memdesc:group___image_view_s_t_l_algorithms_equal_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::equal for image views <br /></td></tr>
  87 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:group___image_view_s_t_l_algorithms_transform_pixels"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_transform_pixels.html">transform_pixels</a></td></tr>
  89 <tr class="memdesc:group___image_view_s_t_l_algorithms_transform_pixels"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::transform for image views <br /></td></tr>
  90 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:group___image_view_s_t_l_algorithms_transform_pixel_positions"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_view_s_t_l_algorithms_transform_pixel_positions.html">transform_pixel_positions</a></td></tr>
  92 <tr class="memdesc:group___image_view_s_t_l_algorithms_transform_pixel_positions"><td class="mdescLeft">&#160;</td><td class="mdescRight">adobe::transform_positions for image views (passes locators, instead of pixel references, to the function object) <br /></td></tr>
  93 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 </table><table class="memberdecls">
  95 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  96 Classes</h2></td></tr>
  97 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1binary__operation__obj.html">binary_operation_obj&lt; Derived, Result &gt;</a></td></tr>
  98 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A generic binary operation on viewsUse this class as a convenience superclass when defining an operation for any image views. Many operations have different behavior when the two views are compatible. This class checks for compatibility and invokes apply_compatible(V1,V2) or apply_incompatible(V1,V2) of the subclass. You must provide apply_compatible(V1,V2) method in your subclass, but apply_incompatible(V1,V2) is not required and the default throws std::bad_cast.  <a href="structboost_1_1gil_1_1binary__operation__obj.html#details">More...</a><br /></td></tr>
  99 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 </table>
 101 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 102 <p>Image view-equivalents of STL algorithms. </p>
 103 <p>Image views provide 1D iteration of their pixels via <code>begin()</code> and <code>end()</code> methods, which makes it possible to use STL algorithms with them. However, using nested loops over X and Y is in many cases more efficient. The algorithms in this section resemble STL algorithms, but they abstract away the nested loops and take views (as opposed to ranges) as input.</p>
 104 <p>Most algorithms check whether the image views are 1D-traversable. A 1D-traversable image view has no gaps at the end of the rows. In other words, if an x_iterator of that view is advanced past the last pixel in a row it will move to the first pixel of the next row. When image views are 1D-traversable, the algorithms use a single loop and run more efficiently. If one or more of the input views are not 1D-traversable, the algorithms fall-back to an X-loop nested inside a Y-loop.</p>
 105 <p>The algorithms typically delegate the work to their corresponding STL algorithms. For example, <code>copy_pixels</code> calls <code>std::copy</code> either for each row, or, when the images are 1D-traversable, once for all pixels.</p>
 106 <p>In addition, overloads are sometimes provided for the STL algorithms. For example, std::copy for planar iterators is overloaded to perform <code>std::copy</code> for each of the planes. <code>std::copy</code> over bitwise-copiable pixels results in std::copy over unsigned char, which STL typically implements via <code>memmove</code>.</p>
 107 <p>As a result <code>copy_pixels</code> may result in a single call to <code>memmove</code> for interleaved 1D-traversable views, or one per each plane of planar 1D-traversable views, or one per each row of interleaved non-1D-traversable images, etc. </p>
 108 </div><!-- contents -->
 109      <!-- HTML footer for doxygen 1.8.13-->
 110      <!-- start footer part -->
 111      <hr class="footer"/>
 112      <address class="footer">
 113       <small>
 114         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 115       </small>
 116     </address>
 117   </body>
 118 </html>