libs/gil/doc/html/reference/classboost_1_1gil_1_1any__image__view.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: any_image_view&lt; Views &gt; Class Template Reference</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 id="nav-path" class="navpath">
  41   <ul>
  42 <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a></li>  </ul>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="summary">
  47 <a href="#pub-types">Public Types</a> &#124;
  48 <a href="#pub-methods">Public Member Functions</a> &#124;
  49 <a href="classboost_1_1gil_1_1any__image__view-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">any_image_view&lt; Views &gt; Class Template Reference<div class="ingroups"><a class="el" href="group___image_view.html">Image View</a> &raquo; <a class="el" href="group___image_view_model.html">Models</a></div></div>  </div>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p>Represents a run-time specified image view. Models <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_y_step_type_concept.html" title="Concept for locators and views that can define a type just like the given locator or view,...">HasDynamicYStepTypeConcept</a>, Note that this class does NOT model <a class="el" href="structboost_1_1gil_1_1_image_view_concept.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>.
  56  <a href="classboost_1_1gil_1_1any__image__view.html#details">More...</a></p>
  57
  58 <p><code>#include &lt;<a class="el" href="any__image__view_8hpp_source.html">any_image_view.hpp</a>&gt;</code></p>
  59
  60 <p>Inherits type&lt; Views &gt;.</p>
  61 <table class="memberdecls">
  62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  63 Public Types</h2></td></tr>
  64 <tr class="memitem:ad45f8bc5e0315dc5031e85041d0e43ba"><td class="memItemLeft" align="right" valign="top"><a id="ad45f8bc5e0315dc5031e85041d0e43ba"></a>
  65 using&#160;</td><td class="memItemRight" valign="bottom"><b>const_t</b> = <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; detail::views_get_const_t&lt; Views &gt; &gt;</td></tr>
  66 <tr class="separator:ad45f8bc5e0315dc5031e85041d0e43ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:a2f1a92adcae3b10cbad7fe560a94d1b1"><td class="memItemLeft" align="right" valign="top"><a id="a2f1a92adcae3b10cbad7fe560a94d1b1"></a>
  68 using&#160;</td><td class="memItemRight" valign="bottom"><b>x_coord_t</b> = std::ptrdiff_t</td></tr>
  69 <tr class="separator:a2f1a92adcae3b10cbad7fe560a94d1b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:a13938895b1e20b12d10f76329d47dc4a"><td class="memItemLeft" align="right" valign="top"><a id="a13938895b1e20b12d10f76329d47dc4a"></a>
  71 using&#160;</td><td class="memItemRight" valign="bottom"><b>y_coord_t</b> = std::ptrdiff_t</td></tr>
  72 <tr class="separator:a13938895b1e20b12d10f76329d47dc4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 <tr class="memitem:addc40a18340d115ea17a7ab120debe08"><td class="memItemLeft" align="right" valign="top"><a id="addc40a18340d115ea17a7ab120debe08"></a>
  74 using&#160;</td><td class="memItemRight" valign="bottom"><b>point_t</b> = <a class="el" href="classboost_1_1gil_1_1point.html">point</a>&lt; std::ptrdiff_t &gt;</td></tr>
  75 <tr class="separator:addc40a18340d115ea17a7ab120debe08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 </table><table class="memberdecls">
  77 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78 Public Member Functions</h2></td></tr>
  79 <tr class="memitem:a7247fb6c60d4cfc81f95d20e443fb5a3"><td class="memItemLeft" align="right" valign="top"><a id="a7247fb6c60d4cfc81f95d20e443fb5a3"></a>
  80 &#160;</td><td class="memItemRight" valign="bottom"><b>any_image_view</b> (<a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a> const &amp;view)</td></tr>
  81 <tr class="separator:a7247fb6c60d4cfc81f95d20e443fb5a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:a040965d28eaa229fb77aee6278d00a1b"><td class="memTemplParams" colspan="2"><a id="a040965d28eaa229fb77aee6278d00a1b"></a>
  83 template&lt;typename View &gt; </td></tr>
  84 <tr class="memitem:a040965d28eaa229fb77aee6278d00a1b"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>any_image_view</b> (View const &amp;view)</td></tr>
  85 <tr class="separator:a040965d28eaa229fb77aee6278d00a1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:accfe9ad258a5d3376463e1c9e360ea7e"><td class="memTemplParams" colspan="2"><a id="accfe9ad258a5d3376463e1c9e360ea7e"></a>
  87 template&lt;typename OtherViews &gt; </td></tr>
  88 <tr class="memitem:accfe9ad258a5d3376463e1c9e360ea7e"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>any_image_view</b> (<a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; OtherViews &gt; const &amp;view)</td></tr>
  89 <tr class="separator:accfe9ad258a5d3376463e1c9e360ea7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:a3ae448f15af336769a05d9c98b104f17"><td class="memItemLeft" align="right" valign="top"><a id="a3ae448f15af336769a05d9c98b104f17"></a>
  91 <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a> const &amp;view)</td></tr>
  92 <tr class="separator:a3ae448f15af336769a05d9c98b104f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 <tr class="memitem:a2e045932aa13082dcfbcf408cf8bf152"><td class="memTemplParams" colspan="2"><a id="a2e045932aa13082dcfbcf408cf8bf152"></a>
  94 template&lt;typename View &gt; </td></tr>
  95 <tr class="memitem:a2e045932aa13082dcfbcf408cf8bf152"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (View const &amp;view)</td></tr>
  96 <tr class="separator:a2e045932aa13082dcfbcf408cf8bf152"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 <tr class="memitem:a6dd4b64fc4bfe88de7203f3afa377fa8"><td class="memTemplParams" colspan="2"><a id="a6dd4b64fc4bfe88de7203f3afa377fa8"></a>
  98 template&lt;typename OtherViews &gt; </td></tr>
  99 <tr class="memitem:a6dd4b64fc4bfe88de7203f3afa377fa8"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; OtherViews &gt; const &amp;view)</td></tr>
 100 <tr class="separator:a6dd4b64fc4bfe88de7203f3afa377fa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 101 <tr class="memitem:a01929e1ce958f3b0258d24a6cfe90bee"><td class="memItemLeft" align="right" valign="top"><a id="a01929e1ce958f3b0258d24a6cfe90bee"></a>
 102 std::size_t&#160;</td><td class="memItemRight" valign="bottom"><b>num_channels</b> () const</td></tr>
 103 <tr class="separator:a01929e1ce958f3b0258d24a6cfe90bee"><td class="memSeparator" colspan="2">&#160;</td></tr>
 104 <tr class="memitem:ae8ab598c540ffef16daf364f7aa87c21"><td class="memItemLeft" align="right" valign="top"><a id="ae8ab598c540ffef16daf364f7aa87c21"></a>
 105 <a class="el" href="classboost_1_1gil_1_1point.html">point_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>dimensions</b> () const</td></tr>
 106 <tr class="separator:ae8ab598c540ffef16daf364f7aa87c21"><td class="memSeparator" colspan="2">&#160;</td></tr>
 107 <tr class="memitem:add9c490d2545adf2d1f85b84958c167c"><td class="memItemLeft" align="right" valign="top"><a id="add9c490d2545adf2d1f85b84958c167c"></a>
 108 x_coord_t&#160;</td><td class="memItemRight" valign="bottom"><b>width</b> () const</td></tr>
 109 <tr class="separator:add9c490d2545adf2d1f85b84958c167c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 110 <tr class="memitem:a7dd7e3c9d94dc1ab42b6d04b39ab1201"><td class="memItemLeft" align="right" valign="top"><a id="a7dd7e3c9d94dc1ab42b6d04b39ab1201"></a>
 111 y_coord_t&#160;</td><td class="memItemRight" valign="bottom"><b>height</b> () const</td></tr>
 112 <tr class="separator:a7dd7e3c9d94dc1ab42b6d04b39ab1201"><td class="memSeparator" colspan="2">&#160;</td></tr>
 113 </table>
 114 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 115 <div class="textblock"><h3>template&lt;typename Views&gt;<br />
 116 class boost::gil::any_image_view&lt; Views &gt;</h3>
 117
 118 <p>Represents a run-time specified image view. Models <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_y_step_type_concept.html" title="Concept for locators and views that can define a type just like the given locator or view,...">HasDynamicYStepTypeConcept</a>, Note that this class does NOT model <a class="el" href="structboost_1_1gil_1_1_image_view_concept.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>. </p>
 119 <p>CLASS <a class="el" href="classboost_1_1gil_1_1any__image__view.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCon...">any_image_view</a></p>
 120 <p>Represents a view whose type (color space, layout, planar/interleaved organization, etc) can be specified at run time. It is the runtime equivalent of <code><a class="el" href="classboost_1_1gil_1_1image__view.html" title="A lightweight object that interprets memory as a 2D array of pixels. Models ImageViewConcept,...">image_view</a></code>. Some of the requirements of <a class="el" href="structboost_1_1gil_1_1_image_view_concept.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>, such as the <code>value_type</code> alias cannot be fulfilled, since the language does not allow runtime type specification. Other requirements, such as access to the pixels, would be inefficient to provide. Thus <code><a class="el" href="classboost_1_1gil_1_1any__image__view.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCon...">any_image_view</a></code> does not fully model <a class="el" href="structboost_1_1gil_1_1_image_view_concept.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>. However, many algorithms provide overloads taking runtime specified views and thus in many cases <code><a class="el" href="classboost_1_1gil_1_1any__image__view.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCon...">any_image_view</a></code> can be used in places taking a view.</p>
 121 <p>To perform an algorithm on <a class="el" href="classboost_1_1gil_1_1any__image__view.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCon...">any_image_view</a>, put the algorithm in a function object and invoke it by calling <code>apply_operation(runtime_view, algorithm_fn)</code>; </p>
 122 </div><hr/>The documentation for this class was generated from the following file:<ul>
 123 <li><a class="el" href="any__image__view_8hpp_source.html">any_image_view.hpp</a></li>
 124 </ul>
 125 </div><!-- contents -->
 126      <!-- HTML footer for doxygen 1.8.13-->
 127      <!-- start footer part -->
 128      <hr class="footer"/>
 129      <address class="footer">
 130       <small>
 131         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 132       </small>
 133     </address>
 134   </body>
 135 </html>