|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectweka.core.neighboursearch.NearestNeighbourSearch
weka.core.neighboursearch.BallTree
public class BallTree
Class implementing the BallTree/Metric Tree algorithm for nearest neighbour search.
The connection to dataset is only a reference. For the tree structure the indexes are stored in an array.
See the implementing classes of different construction methods of the trees for details on its construction.
For more information see also:
Stephen M. Omohundro (1989). Five Balltree Construction Algorithms.
Jeffrey K. Uhlmann (1991). Satisfying general proximity/similarity queries with metric trees. Information Processing Letters. 40(4):175-179.
@techreport{Omohundro1989,
author = {Stephen M. Omohundro},
institution = {International Computer Science Institute},
month = {December},
number = {TR-89-063},
title = {Five Balltree Construction Algorithms},
year = {1989}
}
@article{Uhlmann1991,
author = {Jeffrey K. Uhlmann},
journal = {Information Processing Letters},
month = {November},
number = {4},
pages = {175-179},
title = {Satisfying general proximity/similarity queries with metric trees},
volume = {40},
year = {1991}
}
Valid options are:
-C <classname and options> The construction method to employ. Either TopDown or BottomUp (default: weka.core.TopDownConstructor)
| Constructor Summary | |
|---|---|
BallTree()
Creates a new instance of BallTree. |
|
BallTree(Instances insts)
Creates a new instance of BallTree. |
|
| Method Summary | |
|---|---|
void |
addInstanceInfo(Instance ins)
Adds the given instance's info. |
java.lang.String |
ballTreeConstructorTipText()
Returns the tip text for this property. |
java.util.Enumeration |
enumerateMeasures()
Returns an enumeration of the additional measure names. |
BallTreeConstructor |
getBallTreeConstructor()
Returns the BallTreeConstructor currently in use. |
double[] |
getDistances()
Returns the distances of the k nearest neighbours. |
double |
getMeasure(java.lang.String additionalMeasureName)
Returns the value of the named measure. |
java.lang.String[] |
getOptions()
Gets the current settings of KDtree. |
java.lang.String |
getRevision()
Returns the revision string. |
TechnicalInformation |
getTechnicalInformation()
Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on. |
java.lang.String |
globalInfo()
Returns a string describing this nearest neighbour search algorithm. |
Instances |
kNearestNeighbours(Instance target,
int k)
Returns k nearest instances in the current neighbourhood to the supplied instance. |
java.util.Enumeration |
listOptions()
Returns an enumeration describing the available options. |
double |
measureMaxDepth()
Returns the depth of the tree. |
double |
measureNumLeaves()
Returns the number of leaves. |
double |
measureTreeSize()
Returns the size of the tree. |
Instance |
nearestNeighbour(Instance target)
Returns the nearest instance in the current neighbourhood to the supplied instance. |
void |
setBallTreeConstructor(BallTreeConstructor constructor)
Sets the BallTreeConstructor for building the BallTree (default TopDownConstructor). |
void |
setInstances(Instances insts)
Builds the BallTree based on the given set of instances. |
void |
setMeasurePerformance(boolean measurePerformance)
Sets whether to calculate the performance statistics or not. |
void |
setOptions(java.lang.String[] options)
Parses a given list of options. |
void |
update(Instance ins)
Adds one instance to the BallTree. |
| Methods inherited from class weka.core.neighboursearch.NearestNeighbourSearch |
|---|
combSort11, distanceFunctionTipText, getDistanceFunction, getInstances, getMeasurePerformance, getPerformanceStats, measurePerformanceTipText, quickSort, setDistanceFunction |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BallTree()
public BallTree(Instances insts)
insts - The instances/points on which the BallTree
should be built on.| Method Detail |
|---|
public java.lang.String globalInfo()
globalInfo in class NearestNeighbourSearchpublic TechnicalInformation getTechnicalInformation()
getTechnicalInformation in interface TechnicalInformationHandler
public Instances kNearestNeighbours(Instance target,
int k)
throws java.lang.Exception
kNearestNeighbours in class NearestNeighbourSearchtarget - The instance to find the k nearest neighbours for.k - The number of nearest neighbours to find.
java.lang.Exception - If the neighbours could not be found.
public Instance nearestNeighbour(Instance target)
throws java.lang.Exception
nearestNeighbour in class NearestNeighbourSearchtarget - The instance to find the nearest neighbour for.
java.lang.Exception - if the nearest neighbour could not be found.
public double[] getDistances()
throws java.lang.Exception
getDistances in class NearestNeighbourSearchjava.lang.Exception - if called before calling kNearestNeighbours
or nearestNeighbours.
public void update(Instance ins)
throws java.lang.Exception
update in class NearestNeighbourSearchins - The instance to be added. Usually the newly added instance in the
training set.
java.lang.Exception - If the instance cannot be added to the tree.public void addInstanceInfo(Instance ins)
addInstanceInfo in class NearestNeighbourSearchins - The instance to add the information of. Usually this is
the test instance supplied to update the range of
attributes in the distance function.
public void setInstances(Instances insts)
throws java.lang.Exception
setInstances in class NearestNeighbourSearchinsts - The insts for which the BallTree is to be
built.
java.lang.Exception - If some error occurs while
building the BallTreepublic java.lang.String ballTreeConstructorTipText()
public BallTreeConstructor getBallTreeConstructor()
public void setBallTreeConstructor(BallTreeConstructor constructor)
constructor - The new BallTreeConstructor.public double measureTreeSize()
public double measureNumLeaves()
public double measureMaxDepth()
public java.util.Enumeration enumerateMeasures()
enumerateMeasures in interface AdditionalMeasureProducerenumerateMeasures in class NearestNeighbourSearchpublic double getMeasure(java.lang.String additionalMeasureName)
getMeasure in interface AdditionalMeasureProducergetMeasure in class NearestNeighbourSearchadditionalMeasureName - the name of the measure to query for
its value.
java.lang.IllegalArgumentException - if the named measure is not supported.public void setMeasurePerformance(boolean measurePerformance)
setMeasurePerformance in class NearestNeighbourSearchmeasurePerformance - This should be true if performance
statistics are to be calculated.public java.util.Enumeration listOptions()
listOptions in interface OptionHandlerlistOptions in class NearestNeighbourSearch
public void setOptions(java.lang.String[] options)
throws java.lang.Exception
-C <classname and options> The construction method to employ. Either TopDown or BottomUp (default: weka.core.TopDownConstructor)
setOptions in interface OptionHandlersetOptions in class NearestNeighbourSearchoptions - the list of options as an array of strings
java.lang.Exception - if an option is not supportedpublic java.lang.String[] getOptions()
getOptions in interface OptionHandlergetOptions in class NearestNeighbourSearchpublic java.lang.String getRevision()
getRevision in interface RevisionHandler
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||