Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / html / reference / group___image_processing_math.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: ImageProcessingMath</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">ImageProcessingMath</div>  </div>
46 </div><!--header-->
47 <div class="contents">
48
49 <p>Math operations for IP algorithms.  
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:gaaa4583e6d012a8b49ad1738cec762651"><td class="memItemLeft" align="right" valign="top"><a id="gaaa4583e6d012a8b49ad1738cec762651"></a>
55 double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#gaaa4583e6d012a8b49ad1738cec762651">lanczos</a> (double x, std::ptrdiff_t a)</td></tr>
56 <tr class="memdesc:gaaa4583e6d012a8b49ad1738cec762651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lanczos response at point xLanczos response is defined as: x == 0: 1 -a &lt; x &amp;&amp; x &lt; a: 0 otherwise: normalized_sinc(x) / normalized_sinc(x / a) <br /></td></tr>
57 <tr class="separator:gaaa4583e6d012a8b49ad1738cec762651"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:ga29d420198670c0445e58a0e428ef9230"><td class="memTemplParams" colspan="2">template&lt;typename T  = float, typename Allocator  = std::allocator&lt;T&gt;&gt; </td></tr>
59 <tr class="memitem:ga29d420198670c0445e58a0e428ef9230"><td class="memTemplItemLeft" align="right" valign="top">detail::kernel_2d&lt; T, Allocator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#ga29d420198670c0445e58a0e428ef9230">generate_normalized_mean</a> (std::size_t side_length)</td></tr>
60 <tr class="memdesc:ga29d420198670c0445e58a0e428ef9230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate mean kernelFills supplied view with normalized mean in which all entries will be equal to.  <a href="group___image_processing_math.html#ga29d420198670c0445e58a0e428ef9230">More...</a><br /></td></tr>
61 <tr class="separator:ga29d420198670c0445e58a0e428ef9230"><td class="memSeparator" colspan="2">&#160;</td></tr>
62 <tr class="memitem:ga182587a9a3438ba3eab25a476bbad777"><td class="memTemplParams" colspan="2"><a id="ga182587a9a3438ba3eab25a476bbad777"></a>
63 template&lt;typename T  = float, typename Allocator  = std::allocator&lt;T&gt;&gt; </td></tr>
64 <tr class="memitem:ga182587a9a3438ba3eab25a476bbad777"><td class="memTemplItemLeft" align="right" valign="top">detail::kernel_2d&lt; T, Allocator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#ga182587a9a3438ba3eab25a476bbad777">generate_unnormalized_mean</a> (std::size_t side_length)</td></tr>
65 <tr class="memdesc:ga182587a9a3438ba3eab25a476bbad777"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate kernel with all 1sFills supplied view with 1s (ones) <br /></td></tr>
66 <tr class="separator:ga182587a9a3438ba3eab25a476bbad777"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:gac1aaebf1673d8b0f087ed851b5b7a47d"><td class="memTemplParams" colspan="2"><a id="gac1aaebf1673d8b0f087ed851b5b7a47d"></a>
68 template&lt;typename T  = float, typename Allocator  = std::allocator&lt;T&gt;&gt; </td></tr>
69 <tr class="memitem:gac1aaebf1673d8b0f087ed851b5b7a47d"><td class="memTemplItemLeft" align="right" valign="top">detail::kernel_2d&lt; T, Allocator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#gac1aaebf1673d8b0f087ed851b5b7a47d">generate_gaussian_kernel</a> (std::size_t side_length, double sigma)</td></tr>
70 <tr class="memdesc:gac1aaebf1673d8b0f087ed851b5b7a47d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate Gaussian kernelFills supplied view with values taken from Gaussian distribution. See <a href="https://en.wikipedia.org/wiki/Gaussian_blur">https://en.wikipedia.org/wiki/Gaussian_blur</a>. <br /></td></tr>
71 <tr class="separator:gac1aaebf1673d8b0f087ed851b5b7a47d"><td class="memSeparator" colspan="2">&#160;</td></tr>
72 <tr class="memitem:gaadc550b82ba9119bad0bbf4d358e0b73"><td class="memTemplParams" colspan="2"><a id="gaadc550b82ba9119bad0bbf4d358e0b73"></a>
73 template&lt;typename T  = float, typename Allocator  = std::allocator&lt;T&gt;&gt; </td></tr>
74 <tr class="memitem:gaadc550b82ba9119bad0bbf4d358e0b73"><td class="memTemplItemLeft" align="right" valign="top">detail::kernel_2d&lt; T, Allocator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#gaadc550b82ba9119bad0bbf4d358e0b73">generate_dx_sobel</a> (unsigned int degree=1)</td></tr>
75 <tr class="memdesc:gaadc550b82ba9119bad0bbf4d358e0b73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates Sobel operator in horizontal directionGenerates a kernel which will represent Sobel operator in horizontal direction of specified degree (no need to convolve multiple times to obtain the desired degree). <a href="https://www.researchgate.net/publication/239398674_An_Isotropic_3_3_Image_Gradient_Operator">https://www.researchgate.net/publication/239398674_An_Isotropic_3_3_Image_Gradient_Operator</a>. <br /></td></tr>
76 <tr class="separator:gaadc550b82ba9119bad0bbf4d358e0b73"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 <tr class="memitem:gae9b2680356c21a952cb0daf2a2c779f0"><td class="memTemplParams" colspan="2"><a id="gae9b2680356c21a952cb0daf2a2c779f0"></a>
78 template&lt;typename T  = float, typename Allocator  = std::allocator&lt;T&gt;&gt; </td></tr>
79 <tr class="memitem:gae9b2680356c21a952cb0daf2a2c779f0"><td class="memTemplItemLeft" align="right" valign="top">detail::kernel_2d&lt; T, Allocator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#gae9b2680356c21a952cb0daf2a2c779f0">generate_dx_scharr</a> (unsigned int degree=1)</td></tr>
80 <tr class="memdesc:gae9b2680356c21a952cb0daf2a2c779f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate Scharr operator in horizontal directionGenerates a kernel which will represent Scharr operator in horizontal direction of specified degree (no need to convolve multiple times to obtain the desired degree). <a href="https://www.researchgate.net/profile/Hanno_Scharr/publication/220955743_Optimal_Filters_for_Extended_Optical_Flow/links/004635151972eda98f000000/Optimal-Filters-for-Extended-Optical-Flow.pdf">https://www.researchgate.net/profile/Hanno_Scharr/publication/220955743_Optimal_Filters_for_Extended_Optical_Flow/links/004635151972eda98f000000/Optimal-Filters-for-Extended-Optical-Flow.pdf</a>. <br /></td></tr>
81 <tr class="separator:gae9b2680356c21a952cb0daf2a2c779f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:ga726dd0714f3e65ea9bab6b9201c16c96"><td class="memTemplParams" colspan="2"><a id="ga726dd0714f3e65ea9bab6b9201c16c96"></a>
83 template&lt;typename T  = float, typename Allocator  = std::allocator&lt;T&gt;&gt; </td></tr>
84 <tr class="memitem:ga726dd0714f3e65ea9bab6b9201c16c96"><td class="memTemplItemLeft" align="right" valign="top">detail::kernel_2d&lt; T, Allocator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#ga726dd0714f3e65ea9bab6b9201c16c96">generate_dy_sobel</a> (unsigned int degree=1)</td></tr>
85 <tr class="memdesc:ga726dd0714f3e65ea9bab6b9201c16c96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates Sobel operator in vertical directionGenerates a kernel which will represent Sobel operator in vertical direction of specified degree (no need to convolve multiple times to obtain the desired degree). <a href="https://www.researchgate.net/publication/239398674_An_Isotropic_3_3_Image_Gradient_Operator">https://www.researchgate.net/publication/239398674_An_Isotropic_3_3_Image_Gradient_Operator</a>. <br /></td></tr>
86 <tr class="separator:ga726dd0714f3e65ea9bab6b9201c16c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:gad626d5b1cbd1e81ffbf638c2ec1e030c"><td class="memTemplParams" colspan="2"><a id="gad626d5b1cbd1e81ffbf638c2ec1e030c"></a>
88 template&lt;typename T  = float, typename Allocator  = std::allocator&lt;T&gt;&gt; </td></tr>
89 <tr class="memitem:gad626d5b1cbd1e81ffbf638c2ec1e030c"><td class="memTemplItemLeft" align="right" valign="top">detail::kernel_2d&lt; T, Allocator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#gad626d5b1cbd1e81ffbf638c2ec1e030c">generate_dy_scharr</a> (unsigned int degree=1)</td></tr>
90 <tr class="memdesc:gad626d5b1cbd1e81ffbf638c2ec1e030c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate Scharr operator in vertical directionGenerates a kernel which will represent Scharr operator in vertical direction of specified degree (no need to convolve multiple times to obtain the desired degree). <a href="https://www.researchgate.net/profile/Hanno_Scharr/publication/220955743_Optimal_Filters_for_Extended_Optical_Flow/links/004635151972eda98f000000/Optimal-Filters-for-Extended-Optical-Flow.pdf">https://www.researchgate.net/profile/Hanno_Scharr/publication/220955743_Optimal_Filters_for_Extended_Optical_Flow/links/004635151972eda98f000000/Optimal-Filters-for-Extended-Optical-Flow.pdf</a>. <br /></td></tr>
91 <tr class="separator:gad626d5b1cbd1e81ffbf638c2ec1e030c"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:ga5b662d207dd54aba778c0f8c3697c025"><td class="memTemplParams" colspan="2"><a id="ga5b662d207dd54aba778c0f8c3697c025"></a>
93 template&lt;typename GradientView , typename OutputView &gt; </td></tr>
94 <tr class="memitem:ga5b662d207dd54aba778c0f8c3697c025"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___image_processing_math.html#ga5b662d207dd54aba778c0f8c3697c025">compute_hessian_entries</a> (GradientView dx, GradientView dy, OutputView ddxx, OutputView dxdy, OutputView ddyy)</td></tr>
95 <tr class="memdesc:ga5b662d207dd54aba778c0f8c3697c025"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute xy gradient, and second order x and y gradientsHessian matrix is defined as a matrix of partial derivates for 2d case, it is [[ddxx, dxdy], [dxdy, ddyy]. d stands for derivative, and x or y stand for direction. For example, dx stands for derivative (gradient) in horizontal direction, and ddxx means second order derivative in horizon direction <a href="https://en.wikipedia.org/wiki/Hessian_matrix">https://en.wikipedia.org/wiki/Hessian_matrix</a>. <br /></td></tr>
96 <tr class="separator:ga5b662d207dd54aba778c0f8c3697c025"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 </table>
98 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
99 <p>Math operations for IP algorithms. </p>
100 <p>This is mostly handful of mathemtical operations that are required by other image processing algorithms</p>
101 <p>Normalized cardinal sine</p>
102 <p>normalized_sinc(x) = sin(pi * x) / (pi * x) </p>
103 <h2 class="groupheader">Function Documentation</h2>
104 <a id="ga29d420198670c0445e58a0e428ef9230"></a>
105 <h2 class="memtitle"><span class="permalink"><a href="#ga29d420198670c0445e58a0e428ef9230">&#9670;&nbsp;</a></span>generate_normalized_mean()</h2>
106
107 <div class="memitem">
108 <div class="memproto">
109 <table class="mlabels">
110   <tr>
111   <td class="mlabels-left">
112       <table class="memname">
113         <tr>
114           <td class="memname">detail::kernel_2d&lt;T, Allocator&gt; boost::gil::generate_normalized_mean </td>
115           <td>(</td>
116           <td class="paramtype">std::size_t&#160;</td>
117           <td class="paramname"><em>side_length</em></td><td>)</td>
118           <td></td>
119         </tr>
120       </table>
121   </td>
122   <td class="mlabels-right">
123 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
124   </tr>
125 </table>
126 </div><div class="memdoc">
127
128 <p>Generate mean kernelFills supplied view with normalized mean in which all entries will be equal to. </p>
129 <div class="fragment"><div class="line">1 / (dst.size()) </div></div><!-- fragment --> 
130 </div>
131 </div>
132 </div><!-- contents -->
133      <!-- HTML footer for doxygen 1.8.13-->
134      <!-- start footer part -->
135      <hr class="footer"/>
136      <address class="footer">
137       <small>
138         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
139       </small>
140     </address>
141   </body>
142 </html>