structboost_1_1gil_1_1reader__base.html 9.7 KB

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