<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>FingerprintRecognition: ImageProcessingTools.ConvolutionFilter Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">FingerprintRecognition </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Packages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('class_image_processing_tools_1_1_convolution_filter.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Events</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="#properties">Properties</a> </div> <div class="headertitle"> <div class="title">ImageProcessingTools.ConvolutionFilter Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Represents a convolution filter. <a href="class_image_processing_tools_1_1_convolution_filter.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for ImageProcessingTools.ConvolutionFilter:</div> <div class="dyncontent"> <div class="center"> <img src="class_image_processing_tools_1_1_convolution_filter.png" usemap="#ImageProcessingTools.ConvolutionFilter_map" alt=""/> <map id="ImageProcessingTools.ConvolutionFilter_map" name="ImageProcessingTools.ConvolutionFilter_map"> <area href="class_image_processing_tools_1_1_gaussian_blur.html" alt="ImageProcessingTools.GaussianBlur" shape="rect" coords="0,56,260,80"/> <area href="class_image_processing_tools_1_1_sobel_horizontal_filter.html" title="A 3x3 Sobel filter for horizontal edge detection." alt="ImageProcessingTools.SobelHorizontalFilter" shape="rect" coords="270,56,530,80"/> <area href="class_image_processing_tools_1_1_sobel_vertical_filter.html" title="A 3x3 Sobel filter for vertical edge detection." alt="ImageProcessingTools.SobelVerticalFilter" shape="rect" coords="540,56,800,80"/> </map> </div></div> <p><a href="class_image_processing_tools_1_1_convolution_filter-members.html">List of all members.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a07df919a825c2e56890227dbebd9a164"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html#a07df919a825c2e56890227dbebd9a164">ConvolutionFilter</a> (int width, int height, int factor)</td></tr> <tr class="memdesc:a07df919a825c2e56890227dbebd9a164"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a <a class="el" href="class_image_processing_tools_1_1_convolution_filter.html" title="Represents a convolution filter.">ConvolutionFilter</a> with the specified width, height and factor. <a href="#a07df919a825c2e56890227dbebd9a164"></a><br/></td></tr> <tr class="memitem:a641af1adb7b280fcea011644cfdb2425"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_image_processing_tools_1_1_image_matrix.html">ImageMatrix</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html#a641af1adb7b280fcea011644cfdb2425">Apply</a> (<a class="el" href="class_image_processing_tools_1_1_image_matrix.html">ImageMatrix</a> img)</td></tr> <tr class="memdesc:a641af1adb7b280fcea011644cfdb2425"><td class="mdescLeft"> </td><td class="mdescRight">Applies the current convolution filter to the specified <a class="el" href="class_image_processing_tools_1_1_image_matrix.html" title="A class to represent a gray scale image using a matrix.">ImageMatrix</a>. <a href="#a641af1adb7b280fcea011644cfdb2425"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a8e392d752ef8c64d945c6d32de670b51"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html#a8e392d752ef8c64d945c6d32de670b51">ConvolutionFilter</a> ()</td></tr> <tr class="memdesc:a8e392d752ef8c64d945c6d32de670b51"><td class="mdescLeft"> </td><td class="mdescRight">A base constructor to be used in concrete classes. <a href="#a8e392d752ef8c64d945c6d32de670b51"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:a3f9a2a32bad42ed07b2a472c75cd1140"><td class="memItemLeft" align="right" valign="top">int[,] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html#a3f9a2a32bad42ed07b2a472c75cd1140">pixels</a></td></tr> <tr class="memdesc:a3f9a2a32bad42ed07b2a472c75cd1140"><td class="mdescLeft"> </td><td class="mdescRight">The matrix of the filter. <a href="#a3f9a2a32bad42ed07b2a472c75cd1140"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="properties"></a> Properties</h2></td></tr> <tr class="memitem:a386e9e770b2ab3c3c2c072c1b1357e6f"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html#a386e9e770b2ab3c3c2c072c1b1357e6f">this[int row, int column]</a><code> [get, set]</code></td></tr> <tr class="memdesc:a386e9e770b2ab3c3c2c072c1b1357e6f"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the value of a pixel in the filter. <a href="#a386e9e770b2ab3c3c2c072c1b1357e6f"></a><br/></td></tr> <tr class="memitem:afd201a517a241fa1ec49ad050bb5b026"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html#afd201a517a241fa1ec49ad050bb5b026">Height</a><code> [get, set]</code></td></tr> <tr class="memdesc:afd201a517a241fa1ec49ad050bb5b026"><td class="mdescLeft"> </td><td class="mdescRight">Gets the height of the filter. <a href="#afd201a517a241fa1ec49ad050bb5b026"></a><br/></td></tr> <tr class="memitem:a1e948c19acff5e1b85bbd2c4550c6308"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html#a1e948c19acff5e1b85bbd2c4550c6308">Width</a><code> [get, set]</code></td></tr> <tr class="memdesc:a1e948c19acff5e1b85bbd2c4550c6308"><td class="mdescLeft"> </td><td class="mdescRight">Gets the width of the filter. <a href="#a1e948c19acff5e1b85bbd2c4550c6308"></a><br/></td></tr> <tr class="memitem:ad6dc280de472324bee0862cb2d2e518d"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html#ad6dc280de472324bee0862cb2d2e518d">Factor</a><code> [get, set]</code></td></tr> <tr class="memdesc:ad6dc280de472324bee0862cb2d2e518d"><td class="mdescLeft"> </td><td class="mdescRight">A factor to divide the value before assigning to the pixel. <a href="#ad6dc280de472324bee0862cb2d2e518d"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Represents a convolution filter. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a07df919a825c2e56890227dbebd9a164"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ImageProcessingTools.ConvolutionFilter.ConvolutionFilter </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>width</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>height</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>factor</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize a <a class="el" href="class_image_processing_tools_1_1_convolution_filter.html" title="Represents a convolution filter.">ConvolutionFilter</a> with the specified width, height and factor. </p> <dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">width</td><td>The width of the filter.</td></tr> <tr><td class="paramname">height</td><td>The height of the filter.</td></tr> <tr><td class="paramname">factor</td><td>The factor to divide the value before assigining to the pixel.</td></tr> </table> </dd> </dl> <dl class="exception"><dt>Exceptions:</dt><dd> <table class="exception"> <tr><td class="paramname">ArgumentOutOfRangeException</td><td>Thrown when the specified with or height are not an odd number.</td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a8e392d752ef8c64d945c6d32de670b51"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">ImageProcessingTools.ConvolutionFilter.ConvolutionFilter </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>A base constructor to be used in concrete classes. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a641af1adb7b280fcea011644cfdb2425"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_image_processing_tools_1_1_image_matrix.html">ImageMatrix</a> ImageProcessingTools.ConvolutionFilter.Apply </td> <td>(</td> <td class="paramtype"><a class="el" href="class_image_processing_tools_1_1_image_matrix.html">ImageMatrix</a> </td> <td class="paramname"><em>img</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Applies the current convolution filter to the specified <a class="el" href="class_image_processing_tools_1_1_image_matrix.html" title="A class to represent a gray scale image using a matrix.">ImageMatrix</a>. </p> <dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">img</td><td>The <a class="el" href="class_image_processing_tools_1_1_image_matrix.html" title="A class to represent a gray scale image using a matrix.">ImageMatrix</a> where the convolution filter will be applied. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns:</dt><dd>A new <a class="el" href="class_image_processing_tools_1_1_image_matrix.html" title="A class to represent a gray scale image using a matrix.">ImageMatrix</a> resulting from applying the current filter to the specified <a class="el" href="class_image_processing_tools_1_1_image_matrix.html" title="A class to represent a gray scale image using a matrix.">ImageMatrix</a>. </dd></dl> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a3f9a2a32bad42ed07b2a472c75cd1140"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int [,] ImageProcessingTools.ConvolutionFilter.pixels</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>The matrix of the filter. </p> </div> </div> <hr/><h2>Property Documentation</h2> <a class="anchor" id="ad6dc280de472324bee0862cb2d2e518d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int ImageProcessingTools.ConvolutionFilter.Factor</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>A factor to divide the value before assigning to the pixel. </p> <p>Reimplemented in <a class="el" href="class_image_processing_tools_1_1_sobel_horizontal_filter.html#a99f77b26280f3540013c320d45b27445">ImageProcessingTools.SobelHorizontalFilter</a>, <a class="el" href="class_image_processing_tools_1_1_sobel_vertical_filter.html#a33d870fbf1f4e1fe82bedfa49756c7fe">ImageProcessingTools.SobelVerticalFilter</a>, and <a class="el" href="class_image_processing_tools_1_1_gaussian_blur.html#a1c05ecf1f6dbc0ceedd7dd74cc095fe8">ImageProcessingTools.GaussianBlur</a>.</p> </div> </div> <a class="anchor" id="afd201a517a241fa1ec49ad050bb5b026"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int ImageProcessingTools.ConvolutionFilter.Height</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the height of the filter. </p> <p>Reimplemented in <a class="el" href="class_image_processing_tools_1_1_sobel_horizontal_filter.html#a5ebb24e3c2cfc8a0ad17ec996f76fa71">ImageProcessingTools.SobelHorizontalFilter</a>, <a class="el" href="class_image_processing_tools_1_1_sobel_vertical_filter.html#a784d7a0541da2af0485f930f33add9fe">ImageProcessingTools.SobelVerticalFilter</a>, and <a class="el" href="class_image_processing_tools_1_1_gaussian_blur.html#a08d864e55e6d7fb1ae45cd58675ae468">ImageProcessingTools.GaussianBlur</a>.</p> </div> </div> <a class="anchor" id="a386e9e770b2ab3c3c2c072c1b1357e6f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int ImageProcessingTools.ConvolutionFilter.this[int row, int column]</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets or sets the value of a pixel in the filter. </p> <dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">row</td><td>The row of the specified pixel.</td></tr> <tr><td class="paramname">column</td><td>The column of the specified pixel.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns:</dt><dd>The value of the filter in the specified pixel.</dd></dl> </div> </div> <a class="anchor" id="a1e948c19acff5e1b85bbd2c4550c6308"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int ImageProcessingTools.ConvolutionFilter.Width</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the width of the filter. </p> <p>Reimplemented in <a class="el" href="class_image_processing_tools_1_1_sobel_horizontal_filter.html#a3f092515d5fabd9515e2790125206ced">ImageProcessingTools.SobelHorizontalFilter</a>, <a class="el" href="class_image_processing_tools_1_1_sobel_vertical_filter.html#a018b1f45274df59685633002718d094a">ImageProcessingTools.SobelVerticalFilter</a>, and <a class="el" href="class_image_processing_tools_1_1_gaussian_blur.html#a3b6c792d6aaec74c9cf14b84c771eb7f">ImageProcessingTools.GaussianBlur</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>D:/Migue/Code/FingerprintRecognition/CodeProject/[2012-05-16] FingerprintRecognition/FingerprintRecognition/ImageProcessingTools/ConvolutionFilter.cs</li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespace_image_processing_tools.html">ImageProcessingTools</a></li><li class="navelem"><a class="el" href="class_image_processing_tools_1_1_convolution_filter.html">ConvolutionFilter</a></li> <li class="footer">Generated on Mon May 21 2012 20:06:33 for FingerprintRecognition by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li> </ul> </div> </body> </html>
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.
This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)