Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html
blob: 25a43d1008e254f5d0eeb5958801a1e08eb36f9b [file] [log] [blame]
<!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"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Spatial.BBox.AreaSimilarity 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="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 id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<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&#160;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><a href="files.html"><span>Files</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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_spatial.html">Spatial</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_spatial_1_1_b_box.html">BBox</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html">AreaSimilarity</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Spatial.BBox.AreaSimilarity Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The algorithm is implemented as envelope on envelope overlays rather than complex polygon on complex polygon overlays. <a class="el" href="namespace_lucene_1_1_net_1_1_spatial.html">Spatial</a> relevance scoring algorithm: <br/>
queryArea = the area of the input query envelope <br/>
targetArea = the area of the target envelope (per <a class="el" href="namespace_lucene.html">Lucene</a> document) <br/>
intersectionArea = the area of the intersection for the query/target envelopes <br/>
queryPower = the weighting power associated with the query envelope (default = 1.0) <br/>
targetPower = the weighting power associated with the target envelope (default = 1.0) <br/>
queryRatio = intersectionArea / queryArea; <br/>
targetRatio = intersectionArea / targetArea; <br/>
queryFactor = Math.pow(queryRatio,queryPower); <br/>
targetFactor = Math.pow(targetRatio,targetPower); <br/>
score = queryFactor /// targetFactor; Based on Geoportal's <a href="http://geoportal.svn.sourceforge.net/svnroot/geoportal/Geoportal/trunk/src/com/esri/gpt/catalog/lucene/SpatialRankingValueSource.java">SpatialRankingValueSource</a>.
<a href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html#details">More...</a></p>
<p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity.html">Lucene.Net.Spatial.BBox.BBoxSimilarity</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a25bd618e0ea3648f0d1a27930c4177f4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html#a25bd618e0ea3648f0d1a27930c4177f4">AreaSimilarity</a> (Rectangle queryExtent, double queryPower, double targetPower)</td></tr>
<tr class="separator:a25bd618e0ea3648f0d1a27930c4177f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb16f020d6a4ede5717e10c6fe081b30"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html#aeb16f020d6a4ede5717e10c6fe081b30">AreaSimilarity</a> (Rectangle queryExtent)</td></tr>
<tr class="separator:aeb16f020d6a4ede5717e10c6fe081b30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fdb847fe09dc065a8a882fb9bcd68df"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html#a1fdb847fe09dc065a8a882fb9bcd68df">GetDelimiterQueryParameters</a> ()</td></tr>
<tr class="separator:a1fdb847fe09dc065a8a882fb9bcd68df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a9fbcb11eb1318d259367296f93d7c3"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html#a3a9fbcb11eb1318d259367296f93d7c3">Score</a> (Rectangle target, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html">Explanation</a> exp)</td></tr>
<tr class="separator:a3a9fbcb11eb1318d259367296f93d7c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fd50eab260fb2ed013244ebf14300d0"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html#a0fd50eab260fb2ed013244ebf14300d0">Equals</a> (object obj)</td></tr>
<tr class="separator:a0fd50eab260fb2ed013244ebf14300d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67c8423ff13d81fc59b98a4bca1137ca"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_area_similarity.html#a67c8423ff13d81fc59b98a4bca1137ca">GetHashCode</a> ()</td></tr>
<tr class="separator:a67c8423ff13d81fc59b98a4bca1137ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The algorithm is implemented as envelope on envelope overlays rather than complex polygon on complex polygon overlays. </p>
<p><a class="el" href="namespace_lucene_1_1_net_1_1_spatial.html">Spatial</a> relevance scoring algorithm: </p>
<p><br/>
queryArea = the area of the input query envelope <br/>
targetArea = the area of the target envelope (per <a class="el" href="namespace_lucene.html">Lucene</a> document) <br/>
intersectionArea = the area of the intersection for the query/target envelopes <br/>
queryPower = the weighting power associated with the query envelope (default = 1.0) <br/>
targetPower = the weighting power associated with the target envelope (default = 1.0) </p>
<p><br/>
queryRatio = intersectionArea / queryArea; <br/>
targetRatio = intersectionArea / targetArea; <br/>
queryFactor = Math.pow(queryRatio,queryPower); <br/>
targetFactor = Math.pow(targetRatio,targetPower); <br/>
score = queryFactor /// targetFactor; </p>
<p>Based on Geoportal's <a href="http://geoportal.svn.sourceforge.net/svnroot/geoportal/Geoportal/trunk/src/com/esri/gpt/catalog/lucene/SpatialRankingValueSource.java">SpatialRankingValueSource</a>. </p>
<p>.experimental </p>
<p>Definition at line <a class="el" href="_area_similarity_8cs_source.html#l00050">50</a> of file <a class="el" href="_area_similarity_8cs_source.html">AreaSimilarity.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a25bd618e0ea3648f0d1a27930c4177f4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Spatial.BBox.AreaSimilarity.AreaSimilarity </td>
<td>(</td>
<td class="paramtype">Rectangle&#160;</td>
<td class="paramname"><em>queryExtent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>queryPower</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>targetPower</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_area_similarity_8cs_source.html#l00061">61</a> of file <a class="el" href="_area_similarity_8cs_source.html">AreaSimilarity.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aeb16f020d6a4ede5717e10c6fe081b30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Spatial.BBox.AreaSimilarity.AreaSimilarity </td>
<td>(</td>
<td class="paramtype">Rectangle&#160;</td>
<td class="paramname"><em>queryExtent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_area_similarity_8cs_source.html#l00077">77</a> of file <a class="el" href="_area_similarity_8cs_source.html">AreaSimilarity.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0fd50eab260fb2ed013244ebf14300d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Spatial.BBox.AreaSimilarity.Equals </td>
<td>(</td>
<td class="paramtype">object&#160;</td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_area_similarity_8cs_source.html#l00219">219</a> of file <a class="el" href="_area_similarity_8cs_source.html">AreaSimilarity.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a1fdb847fe09dc065a8a882fb9bcd68df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">String Lucene.Net.Spatial.BBox.AreaSimilarity.GetDelimiterQueryParameters </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_area_similarity_8cs_source.html#l00082">82</a> of file <a class="el" href="_area_similarity_8cs_source.html">AreaSimilarity.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a67c8423ff13d81fc59b98a4bca1137ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Spatial.BBox.AreaSimilarity.GetHashCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_area_similarity_8cs_source.html#l00226">226</a> of file <a class="el" href="_area_similarity_8cs_source.html">AreaSimilarity.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a3a9fbcb11eb1318d259367296f93d7c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Lucene.Net.Spatial.BBox.AreaSimilarity.Score </td>
<td>(</td>
<td class="paramtype">Rectangle&#160;</td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html">Explanation</a>&#160;</td>
<td class="paramname"><em>exp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity.html#a74e8742e647bedb8b0c3df1a0c7b1eeb">Lucene.Net.Spatial.BBox.BBoxSimilarity</a>.</p>
<p>Definition at line <a class="el" href="_area_similarity_8cs_source.html#l00087">87</a> of file <a class="el" href="_area_similarity_8cs_source.html">AreaSimilarity.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Spatial/BBox/<a class="el" href="_area_similarity_8cs_source.html">AreaSimilarity.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:58 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>