| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>DBSCANClusterer (Apache Commons Math 3.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DBSCANClusterer (Apache Commons Math 3.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DBSCANClusterer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/commons/math3/stat/clustering/Clusterable.html" title="interface in org.apache.commons.math3.stat.clustering"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/commons/math3/stat/clustering/EuclideanDoublePoint.html" title="class in org.apache.commons.math3.stat.clustering"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/commons/math3/stat/clustering/DBSCANClusterer.html" target="_top">Frames</a></li> |
| <li><a href="DBSCANClusterer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.commons.math3.stat.clustering</div> |
| <h2 title="Class DBSCANClusterer" class="title">Class DBSCANClusterer<T extends <a href="../../../../../../org/apache/commons/math3/stat/clustering/Clusterable.html" title="interface in org.apache.commons.math3.stat.clustering">Clusterable</a><T>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.commons.math3.stat.clustering.DBSCANClusterer<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - type of the points to cluster</dd></dl> |
| <hr> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>As of 3.2 (to be removed in 4.0), |
| use <a href="../../../../../../org/apache/commons/math3/ml/clustering/DBSCANClusterer.html" title="class in org.apache.commons.math3.ml.clustering"><code>DBSCANClusterer</code></a> instead</i></div> |
| </div> |
| <br> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public class <span class="strong">DBSCANClusterer<T extends <a href="../../../../../../org/apache/commons/math3/stat/clustering/Clusterable.html" title="interface in org.apache.commons.math3.stat.clustering">Clusterable</a><T>></span> |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">DBSCAN (density-based spatial clustering of applications with noise) algorithm. |
| <p> |
| The DBSCAN algorithm forms clusters based on the idea of density connectivity, i.e. |
| a point p is density connected to another point q, if there exists a chain of |
| points p<sub>i</sub>, with i = 1 .. n and p<sub>1</sub> = p and p<sub>n</sub> = q, |
| such that each pair <p<sub>i</sub>, p<sub>i+1</sub>> is directly density-reachable. |
| A point q is directly density-reachable from point p if it is in the ε-neighborhood |
| of this point. |
| <p> |
| Any point that is not density-reachable from a formed cluster is treated as noise, and |
| will thus not be present in the result. |
| <p> |
| The algorithm requires two parameters: |
| <ul> |
| <li>eps: the distance that defines the ε-neighborhood of a point |
| <li>minPoints: the minimum number of density-connected points required to form a cluster |
| </ul> |
| <p> |
| <b>Note:</b> as DBSCAN is not a centroid-based clustering algorithm, the resulting |
| <a href="../../../../../../org/apache/commons/math3/stat/clustering/Cluster.html" title="class in org.apache.commons.math3.stat.clustering"><code>Cluster</code></a> objects will have no defined center, i.e. <a href="../../../../../../org/apache/commons/math3/stat/clustering/Cluster.html#getCenter()"><code>Cluster.getCenter()</code></a> will |
| return <code>null</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="strong">Version:</span></dt> |
| <dd>$Id: DBSCANClusterer.java 1461871 2013-03-27 22:01:25Z tn $</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="http://en.wikipedia.org/wiki/DBSCAN">DBSCAN (wikipedia)</a>, |
| <a href="http://www.dbs.ifi.lmu.de/Publikationen/Papers/KDD-96.final.frame.pdf"> |
| A Density-Based Algorithm for Discovering Clusters in Large Spatial Databases with Noise</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/clustering/DBSCANClusterer.html#DBSCANClusterer(double, int)">DBSCANClusterer</a></strong>(double eps, |
| int minPts)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Creates a new instance of a DBSCANClusterer.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/commons/math3/stat/clustering/Cluster.html" title="class in org.apache.commons.math3.stat.clustering">Cluster</a><<a href="../../../../../../org/apache/commons/math3/stat/clustering/DBSCANClusterer.html" title="type parameter in DBSCANClusterer">T</a>>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/clustering/DBSCANClusterer.html#cluster(java.util.Collection)">cluster</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/commons/math3/stat/clustering/DBSCANClusterer.html" title="type parameter in DBSCANClusterer">T</a>> points)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Performs DBSCAN cluster analysis.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/clustering/DBSCANClusterer.html#getEps()">getEps</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Returns the maximum radius of the neighborhood to be considered.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/clustering/DBSCANClusterer.html#getMinPts()">getMinPts</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Returns the minimum number of points needed for a cluster.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DBSCANClusterer(double, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DBSCANClusterer</h4> |
| <pre>public DBSCANClusterer(double eps, |
| int minPts) |
| throws <a href="../../../../../../org/apache/commons/math3/exception/NotPositiveException.html" title="class in org.apache.commons.math3.exception">NotPositiveException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Creates a new instance of a DBSCANClusterer.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>eps</code> - maximum radius of the neighborhood to be considered</dd><dd><code>minPts</code> - minimum number of points needed for a cluster</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/commons/math3/exception/NotPositiveException.html" title="class in org.apache.commons.math3.exception">NotPositiveException</a></code> - if <code>eps < 0.0</code> or <code>minPts < 0</code></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getEps()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEps</h4> |
| <pre>public double getEps()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Returns the maximum radius of the neighborhood to be considered.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>maximum radius of the neighborhood</dd></dl> |
| </li> |
| </ul> |
| <a name="getMinPts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinPts</h4> |
| <pre>public int getMinPts()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Returns the minimum number of points needed for a cluster.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>minimum number of points needed for a cluster</dd></dl> |
| </li> |
| </ul> |
| <a name="cluster(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cluster</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/commons/math3/stat/clustering/Cluster.html" title="class in org.apache.commons.math3.stat.clustering">Cluster</a><<a href="../../../../../../org/apache/commons/math3/stat/clustering/DBSCANClusterer.html" title="type parameter in DBSCANClusterer">T</a>>> cluster(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/commons/math3/stat/clustering/DBSCANClusterer.html" title="type parameter in DBSCANClusterer">T</a>> points) |
| throws <a href="../../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Performs DBSCAN cluster analysis. |
| <p> |
| <b>Note:</b> as DBSCAN is not a centroid-based clustering algorithm, the resulting |
| <a href="../../../../../../org/apache/commons/math3/stat/clustering/Cluster.html" title="class in org.apache.commons.math3.stat.clustering"><code>Cluster</code></a> objects will have no defined center, i.e. <a href="../../../../../../org/apache/commons/math3/stat/clustering/Cluster.html#getCenter()"><code>Cluster.getCenter()</code></a> will |
| return <code>null</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>points</code> - the points to cluster</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the list of clusters</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></code> - if the data points are null</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DBSCANClusterer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/commons/math3/stat/clustering/Clusterable.html" title="interface in org.apache.commons.math3.stat.clustering"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/commons/math3/stat/clustering/EuclideanDoublePoint.html" title="class in org.apache.commons.math3.stat.clustering"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/commons/math3/stat/clustering/DBSCANClusterer.html" target="_top">Frames</a></li> |
| <li><a href="DBSCANClusterer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2003–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
