Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / html / reference / group___image_view_constructors.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: Image View From Raw Data</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="#func-members">Functions</a>  </div>
44   <div class="headertitle">
45 <div class="title">Image View From Raw Data<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>
46 </div><!--header-->
47 <div class="contents">
48
49 <p>Methods for constructing image views from raw data and for getting raw data from views.  
50 <a href="#details">More...</a></p>
51 <table class="memberdecls">
52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
53 Functions</h2></td></tr>
54 <tr class="memitem:ga6953d39e284967152854fd96e7cd3e3e"><td class="memTemplParams" colspan="2"><a id="ga6953d39e284967152854fd96e7cd3e3e"></a>
55 template&lt;typename IC &gt; </td></tr>
56 <tr class="memitem:ga6953d39e284967152854fd96e7cd3e3e"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; IC, cmyk_t &gt; &gt;::view_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#ga6953d39e284967152854fd96e7cd3e3e">planar_cmyk_view</a> (std::size_t width, std::size_t height, IC c, IC m, IC y, IC k, std::ptrdiff_t rowsize_in_bytes)</td></tr>
57 <tr class="memdesc:ga6953d39e284967152854fd96e7cd3e3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">from raw CMYK planar data <br /></td></tr>
58 <tr class="separator:ga6953d39e284967152854fd96e7cd3e3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
59 <tr class="memitem:ga772354350229fa94e1e80466be41b571"><td class="memTemplParams" colspan="2"><a id="ga772354350229fa94e1e80466be41b571"></a>
60 template&lt;typename IC &gt; </td></tr>
61 <tr class="memitem:ga772354350229fa94e1e80466be41b571"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; IC, <a class="el" href="structboost_1_1gil_1_1devicen__t.html">devicen_t</a>&lt; 2 &gt; &gt; &gt;::view_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#ga772354350229fa94e1e80466be41b571">planar_devicen_view</a> (std::size_t width, std::size_t height, IC c0, IC c1, std::ptrdiff_t rowsize_in_bytes)</td></tr>
62 <tr class="memdesc:ga772354350229fa94e1e80466be41b571"><td class="mdescLeft">&#160;</td><td class="mdescRight">from 2-channel planar data <br /></td></tr>
63 <tr class="separator:ga772354350229fa94e1e80466be41b571"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:gad9d6c36ed5f4db8ef5b0ff56ac27802c"><td class="memTemplParams" colspan="2"><a id="gad9d6c36ed5f4db8ef5b0ff56ac27802c"></a>
65 template&lt;typename IC &gt; </td></tr>
66 <tr class="memitem:gad9d6c36ed5f4db8ef5b0ff56ac27802c"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#gad9d6c36ed5f4db8ef5b0ff56ac27802c">planar_devicen_view</a> (std::size_t width, std::size_t height, IC c0, IC c1, IC c2, std::ptrdiff_t rowsize_in_bytes) -&gt; typename <a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; IC, <a class="el" href="structboost_1_1gil_1_1devicen__t.html">devicen_t</a>&lt; 3 &gt;&gt;&gt;::view_t</td></tr>
67 <tr class="memdesc:gad9d6c36ed5f4db8ef5b0ff56ac27802c"><td class="mdescLeft">&#160;</td><td class="mdescRight">from 3-channel planar data <br /></td></tr>
68 <tr class="separator:gad9d6c36ed5f4db8ef5b0ff56ac27802c"><td class="memSeparator" colspan="2">&#160;</td></tr>
69 <tr class="memitem:ga4024ac76fa2b79fffd62b149ecbee3d7"><td class="memTemplParams" colspan="2"><a id="ga4024ac76fa2b79fffd62b149ecbee3d7"></a>
70 template&lt;typename IC &gt; </td></tr>
71 <tr class="memitem:ga4024ac76fa2b79fffd62b149ecbee3d7"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#ga4024ac76fa2b79fffd62b149ecbee3d7">planar_devicen_view</a> (std::size_t width, std::size_t height, IC c0, IC c1, IC c2, IC c3, std::ptrdiff_t rowsize_in_bytes) -&gt; typename <a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; IC, <a class="el" href="structboost_1_1gil_1_1devicen__t.html">devicen_t</a>&lt; 4 &gt;&gt;&gt;::view_t</td></tr>
72 <tr class="memdesc:ga4024ac76fa2b79fffd62b149ecbee3d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">from 4-channel planar data <br /></td></tr>
73 <tr class="separator:ga4024ac76fa2b79fffd62b149ecbee3d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <tr class="memitem:ga194e74dc9028773c004d42c44abb2763"><td class="memTemplParams" colspan="2"><a id="ga194e74dc9028773c004d42c44abb2763"></a>
75 template&lt;typename IC &gt; </td></tr>
76 <tr class="memitem:ga194e74dc9028773c004d42c44abb2763"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#ga194e74dc9028773c004d42c44abb2763">planar_devicen_view</a> (std::size_t width, std::size_t height, IC c0, IC c1, IC c2, IC c3, IC c4, std::ptrdiff_t rowsize_in_bytes) -&gt; typename <a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; IC, <a class="el" href="structboost_1_1gil_1_1devicen__t.html">devicen_t</a>&lt; 5 &gt;&gt;&gt;::view_t</td></tr>
77 <tr class="memdesc:ga194e74dc9028773c004d42c44abb2763"><td class="mdescLeft">&#160;</td><td class="mdescRight">from 5-channel planar data <br /></td></tr>
78 <tr class="separator:ga194e74dc9028773c004d42c44abb2763"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:gad50e29fb9bf8b22f010fbeb1a9e85a1f"><td class="memTemplParams" colspan="2"><a id="gad50e29fb9bf8b22f010fbeb1a9e85a1f"></a>
80 template&lt;typename Iterator &gt; </td></tr>
81 <tr class="memitem:gad50e29fb9bf8b22f010fbeb1a9e85a1f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; Iterator &gt;::view_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#gad50e29fb9bf8b22f010fbeb1a9e85a1f">interleaved_view</a> (std::size_t width, std::size_t height, Iterator pixels, std::ptrdiff_t rowsize_in_bytes)</td></tr>
82 <tr class="memdesc:gad50e29fb9bf8b22f010fbeb1a9e85a1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructing image views from raw interleaved pixel data. <br /></td></tr>
83 <tr class="separator:gad50e29fb9bf8b22f010fbeb1a9e85a1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:gaa66973da554475f3c8ac4087e97f7fa9"><td class="memTemplParams" colspan="2"><a id="gaa66973da554475f3c8ac4087e97f7fa9"></a>
85 template&lt;typename Iterator &gt; </td></tr>
86 <tr class="memitem:gaa66973da554475f3c8ac4087e97f7fa9"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#gaa66973da554475f3c8ac4087e97f7fa9">interleaved_view</a> (<a class="el" href="classboost_1_1gil_1_1point.html">point</a>&lt; std::size_t &gt; dim, Iterator pixels, std::ptrdiff_t rowsize_in_bytes) -&gt; typename <a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; Iterator &gt;::view_t</td></tr>
87 <tr class="memdesc:gaa66973da554475f3c8ac4087e97f7fa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructing image views from raw interleaved pixel data. <br /></td></tr>
88 <tr class="separator:gaa66973da554475f3c8ac4087e97f7fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:ga307c961cfbf5f56d3ab634d89d1ebf57"><td class="memTemplParams" colspan="2"><a id="ga307c961cfbf5f56d3ab634d89d1ebf57"></a>
90 template&lt;typename HomogeneousView &gt; </td></tr>
91 <tr class="memitem:ga307c961cfbf5f56d3ab634d89d1ebf57"><td class="memTemplItemLeft" align="right" valign="top">detail::channel_pointer_type&lt; HomogeneousView &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#ga307c961cfbf5f56d3ab634d89d1ebf57">interleaved_view_get_raw_data</a> (const HomogeneousView &amp;view)</td></tr>
92 <tr class="memdesc:ga307c961cfbf5f56d3ab634d89d1ebf57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns C pointer to the the channels of an interleaved homogeneous view. <br /></td></tr>
93 <tr class="separator:ga307c961cfbf5f56d3ab634d89d1ebf57"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:gac0fe3f405534dd13886583e99dd5ba38"><td class="memTemplParams" colspan="2"><a id="gac0fe3f405534dd13886583e99dd5ba38"></a>
95 template&lt;typename HomogeneousView &gt; </td></tr>
96 <tr class="memitem:gac0fe3f405534dd13886583e99dd5ba38"><td class="memTemplItemLeft" align="right" valign="top">detail::channel_pointer_type&lt; HomogeneousView &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#gac0fe3f405534dd13886583e99dd5ba38">planar_view_get_raw_data</a> (const HomogeneousView &amp;view, int plane_index)</td></tr>
97 <tr class="memdesc:gac0fe3f405534dd13886583e99dd5ba38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns C pointer to the the channels of a given color plane of a planar homogeneous view. <br /></td></tr>
98 <tr class="separator:gac0fe3f405534dd13886583e99dd5ba38"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <tr class="memitem:ga2caffb17f5f79eac05434c69e1e9af2a"><td class="memTemplParams" colspan="2"><a id="ga2caffb17f5f79eac05434c69e1e9af2a"></a>
100 template&lt;typename IC &gt; </td></tr>
101 <tr class="memitem:ga2caffb17f5f79eac05434c69e1e9af2a"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#ga2caffb17f5f79eac05434c69e1e9af2a">planar_rgb_view</a> (std::size_t width, std::size_t height, IC r, IC g, IC b, std::ptrdiff_t rowsize_in_bytes) -&gt; typename <a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; IC, rgb_t &gt; &gt;::view_t</td></tr>
102 <tr class="memdesc:ga2caffb17f5f79eac05434c69e1e9af2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">from raw RGB planar data <br /></td></tr>
103 <tr class="separator:ga2caffb17f5f79eac05434c69e1e9af2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <tr class="memitem:ga7936bd4b568a5fe3c1575f239a875a10"><td class="memTemplParams" colspan="2"><a id="ga7936bd4b568a5fe3c1575f239a875a10"></a>
105 template&lt;typename ChannelPtr &gt; </td></tr>
106 <tr class="memitem:ga7936bd4b568a5fe3c1575f239a875a10"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_view_constructors.html#ga7936bd4b568a5fe3c1575f239a875a10">planar_rgba_view</a> (std::size_t width, std::size_t height, ChannelPtr r, ChannelPtr g, ChannelPtr b, ChannelPtr a, std::ptrdiff_t rowsize_in_bytes) -&gt; typename <a class="el" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator</a>&lt; <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">planar_pixel_iterator</a>&lt; ChannelPtr, rgba_t &gt; &gt;::view_t</td></tr>
107 <tr class="memdesc:ga7936bd4b568a5fe3c1575f239a875a10"><td class="mdescLeft">&#160;</td><td class="mdescRight">from raw RGBA planar data <br /></td></tr>
108 <tr class="separator:ga7936bd4b568a5fe3c1575f239a875a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 </table>
110 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
111 <p>Methods for constructing image views from raw data and for getting raw data from views. </p>
112 <p>Methods for creating shallow image views from raw pixel data or from other image views - flipping horizontally or vertically, axis-aligned rotation, a subimage, subsampled or n-th channel image view. Derived image views are shallow copies and are fast to construct. </p>
113 </div><!-- contents -->
114      <!-- HTML footer for doxygen 1.8.13-->
115      <!-- start footer part -->
116      <hr class="footer"/>
117      <address class="footer">
118       <small>
119         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
120       </small>
121     </address>
122   </body>
123 </html>