libs/gil/doc/html/reference/structboost_1_1gil_1_1reader__base.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: reader_base&lt; FormatTag, ConversionPolicy &gt; Struct 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="structboost_1_1gil_1_1reader__base.html">reader_base</a></li>  </ul>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="summary">
  47 <a href="#pub-methods">Public Member Functions</a> &#124;
  48 <a href="#pro-attribs">Protected Attributes</a> &#124;
  49 <a href="structboost_1_1gil_1_1reader__base-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">reader_base&lt; FormatTag, ConversionPolicy &gt; Struct Template Reference</div>  </div>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p><code>#include &lt;<a class="el" href="reader__base_8hpp_source.html">reader_base.hpp</a>&gt;</code></p>
  56 <table class="memberdecls">
  57 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58 Public Member Functions</h2></td></tr>
  59 <tr class="memitem:ab7d83e196429f1866b5116097463791b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1reader__base.html#ab7d83e196429f1866b5116097463791b">reader_base</a> ()</td></tr>
  60 <tr class="separator:ab7d83e196429f1866b5116097463791b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:a5d4a087855cec43f12ec8dfa8447f9ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1reader__base.html#a5d4a087855cec43f12ec8dfa8447f9ae">reader_base</a> (const ConversionPolicy &amp;cc)</td></tr>
  62 <tr class="separator:a5d4a087855cec43f12ec8dfa8447f9ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 <tr class="memitem:a74c187b2eea93fb74ecaa0d5848b595e"><td class="memTemplParams" colspan="2">template&lt;typename Image &gt; </td></tr>
  64 <tr class="memitem:a74c187b2eea93fb74ecaa0d5848b595e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1reader__base.html#a74c187b2eea93fb74ecaa0d5848b595e">init_image</a> (Image &amp;img, const image_read_settings&lt; FormatTag &gt; &amp;settings)</td></tr>
  65 <tr class="separator:a74c187b2eea93fb74ecaa0d5848b595e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:aca2c4379bd365e450b18260b2d1916d3"><td class="memTemplParams" colspan="2"><a id="aca2c4379bd365e450b18260b2d1916d3"></a>
  67 template&lt;typename View &gt; </td></tr>
  68 <tr class="memitem:aca2c4379bd365e450b18260b2d1916d3"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>init_view</b> (const View &amp;view, const image_read_settings&lt; FormatTag &gt; &amp;)</td></tr>
  69 <tr class="separator:aca2c4379bd365e450b18260b2d1916d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 </table><table class="memberdecls">
  71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  72 Protected Attributes</h2></td></tr>
  73 <tr class="memitem:af41bac8cb5ef4e50adcaa8ca022a92d9"><td class="memItemLeft" align="right" valign="top"><a id="af41bac8cb5ef4e50adcaa8ca022a92d9"></a>
  74 ConversionPolicy&#160;</td><td class="memItemRight" valign="bottom"><b>_cc_policy</b></td></tr>
  75 <tr class="separator:af41bac8cb5ef4e50adcaa8ca022a92d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 </table>
  77 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  78 <div class="textblock"><h3>template&lt;typename FormatTag, typename ConversionPolicy&gt;<br />
  79 struct boost::gil::reader_base&lt; FormatTag, ConversionPolicy &gt;</h3>
  80
  81 <p>Reader Base Class</p>
  82 <p>It provides some basic functionality which is shared for all readers. For instance, it recreates images when necessary. It checks whether user supplied coordinates are valid.</p>
  83 <dl class="tparams"><dt>Template Parameters</dt><dd>
  84   <table class="tparams">
  85     <tr><td class="paramname">FormatTag</td><td>A format tag, like jpeg_tag. </td></tr>
  86     <tr><td class="paramname">ConversionPolicy</td><td>Conversion policy, see coversion_policies.hpp. </td></tr>
  87   </table>
  88   </dd>
  89 </dl>
  90 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  91 <a id="ab7d83e196429f1866b5116097463791b"></a>
  92 <h2 class="memtitle"><span class="permalink"><a href="#ab7d83e196429f1866b5116097463791b">&#9670;&nbsp;</a></span>reader_base() <span class="overload">[1/2]</span></h2>
  93
  94 <div class="memitem">
  95 <div class="memproto">
  96 <table class="mlabels">
  97   <tr>
  98   <td class="mlabels-left">
  99       <table class="memname">
 100         <tr>
 101           <td class="memname"><a class="el" href="structboost_1_1gil_1_1reader__base.html">reader_base</a> </td>
 102           <td>(</td>
 103           <td class="paramname"></td><td>)</td>
 104           <td></td>
 105         </tr>
 106       </table>
 107   </td>
 108   <td class="mlabels-right">
 109 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 110   </tr>
 111 </table>
 112 </div><div class="memdoc">
 113 <p>Default Constructor </p>
 114
 115 </div>
 116 </div>
 117 <a id="a5d4a087855cec43f12ec8dfa8447f9ae"></a>
 118 <h2 class="memtitle"><span class="permalink"><a href="#a5d4a087855cec43f12ec8dfa8447f9ae">&#9670;&nbsp;</a></span>reader_base() <span class="overload">[2/2]</span></h2>
 119
 120 <div class="memitem">
 121 <div class="memproto">
 122 <table class="mlabels">
 123   <tr>
 124   <td class="mlabels-left">
 125       <table class="memname">
 126         <tr>
 127           <td class="memname"><a class="el" href="structboost_1_1gil_1_1reader__base.html">reader_base</a> </td>
 128           <td>(</td>
 129           <td class="paramtype">const ConversionPolicy &amp;&#160;</td>
 130           <td class="paramname"><em>cc</em></td><td>)</td>
 131           <td></td>
 132         </tr>
 133       </table>
 134   </td>
 135   <td class="mlabels-right">
 136 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 137   </tr>
 138 </table>
 139 </div><div class="memdoc">
 140 <p>Constructor </p>
 141
 142 </div>
 143 </div>
 144 <h2 class="groupheader">Member Function Documentation</h2>
 145 <a id="a74c187b2eea93fb74ecaa0d5848b595e"></a>
 146 <h2 class="memtitle"><span class="permalink"><a href="#a74c187b2eea93fb74ecaa0d5848b595e">&#9670;&nbsp;</a></span>init_image()</h2>
 147
 148 <div class="memitem">
 149 <div class="memproto">
 150 <table class="mlabels">
 151   <tr>
 152   <td class="mlabels-left">
 153       <table class="memname">
 154         <tr>
 155           <td class="memname">void init_image </td>
 156           <td>(</td>
 157           <td class="paramtype">Image &amp;&#160;</td>
 158           <td class="paramname"><em>img</em>, </td>
 159         </tr>
 160         <tr>
 161           <td class="paramkey"></td>
 162           <td></td>
 163           <td class="paramtype">const image_read_settings&lt; FormatTag &gt; &amp;&#160;</td>
 164           <td class="paramname"><em>settings</em>&#160;</td>
 165         </tr>
 166         <tr>
 167           <td></td>
 168           <td>)</td>
 169           <td></td><td></td>
 170         </tr>
 171       </table>
 172   </td>
 173   <td class="mlabels-right">
 174 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 175   </tr>
 176 </table>
 177 </div><div class="memdoc">
 178 <p>Initializes an image. But also does some check ups.</p>
 179 <dl class="tparams"><dt>Template Parameters</dt><dd>
 180   <table class="tparams">
 181     <tr><td class="paramname">Image</td><td>Image which implements boost::gil's <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>.</td></tr>
 182   </table>
 183   </dd>
 184 </dl>
 185 <dl class="params"><dt>Parameters</dt><dd>
 186   <table class="params">
 187     <tr><td class="paramname">img</td><td>The image. </td></tr>
 188     <tr><td class="paramname">info</td><td>The image read info. </td></tr>
 189   </table>
 190   </dd>
 191 </dl>
 192
 193 </div>
 194 </div>
 195 <hr/>The documentation for this struct was generated from the following file:<ul>
 196 <li><a class="el" href="reader__base_8hpp_source.html">reader_base.hpp</a></li>
 197 </ul>
 198 </div><!-- contents -->
 199      <!-- HTML footer for doxygen 1.8.13-->
 200      <!-- start footer part -->
 201      <hr class="footer"/>
 202      <address class="footer">
 203       <small>
 204         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 205       </small>
 206     </address>
 207   </body>
 208 </html>