mlpack
Functions
mean_shift_main.cpp File Reference
#include <mlpack/prereqs.hpp>
#include <mlpack/core/util/io.hpp>
#include <mlpack/core/util/mlpack_main.hpp>
#include <mlpack/core/kernels/gaussian_kernel.hpp>
#include "mean_shift.hpp"
Include dependency graph for mean_shift_main.cpp:
This graph shows which files directly or indirectly include this file:

Functions

 BINDING_NAME ("Mean Shift Clustering")
 
 BINDING_SHORT_DESC ("A fast implementation of mean-shift clustering using dual-tree range " "search. Given a dataset, this uses the mean shift algorithm to produce " "and return a clustering of the data.")
 
 BINDING_LONG_DESC ("This program performs mean shift clustering on the given dataset, storing " "the learned cluster assignments either as a column of labels in the input " "dataset or separately." "\" "The input dataset should be specified with the "+PRINT_PARAM_STRING("input")+" parameter, and the radius used for search" " can be specified with the "+PRINT_PARAM_STRING("radius")+" " "parameter. The maximum number of iterations before algorithm termination " "is controlled with the "+PRINT_PARAM_STRING("max_iterations")+" " "parameter." "\" "The output labels may be saved with the "+PRINT_PARAM_STRING("output")+" output parameter and the centroids of each cluster may be saved with the" " "+PRINT_PARAM_STRING("centroid")+" output parameter.")
 
 BINDING_EXAMPLE ("For example, to run mean shift clustering on the dataset "+PRINT_DATASET("data")+" and store the centroids to "+PRINT_DATASET("centroids")+", the following command may be used: " "\"+PRINT_CALL("mean_shift", "input", "data", "centroid", "centroids"))
 
 BINDING_SEE_ALSO ("@kmeans", "#kmeans")
 
 BINDING_SEE_ALSO ("@dbscan", "#dbscan")
 
 BINDING_SEE_ALSO ("Mean shift on Wikipedia", "https://en.wikipedia.org/wiki/Mean_shift")
 
 BINDING_SEE_ALSO ("Mean Shift, Mode Seeking, and Clustering (pdf)", "http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.510.1222" "&rep=rep1&type=pdf")
 
 BINDING_SEE_ALSO ("mlpack::mean_shift::MeanShift C++ class documentation", "@doxygen/classmlpack_1_1meanshift_1_1MeanShift.html")
 
 PARAM_MATRIX_IN_REQ ("input", "Input dataset to perform clustering on.", "i")
 
 PARAM_FLAG ("in_place", "If specified, a column containing the learned cluster " "assignments will be added to the input dataset file. In this case, " "--output_file is overridden. (Do not use with Python.)", "P")
 
 PARAM_FLAG ("labels_only", "If specified, only the output labels will be " "written to the file specified by --output_file.", "l")
 
 PARAM_FLAG ("force_convergence", "If specified, the mean shift algorithm will " "continue running regardless of max_iterations until the clusters converge.", "f")
 
 PARAM_MATRIX_OUT ("output", "Matrix to write output labels or labeled data to.", "o")
 
 PARAM_MATRIX_OUT ("centroid", "If specified, the centroids of each cluster will " "be written to the given matrix.", "C")
 
 PARAM_INT_IN ("max_iterations", "Maximum number of iterations before mean shift " "terminates.", "m", 1000)
 
 PARAM_DOUBLE_IN ("radius", "If the distance between two centroids is less than " "the given radius, one will be removed. A radius of 0 or less means an " "estimate will be calculated and used for the radius.", "r", 0)
 

Detailed Description

Author
Shangtong Zhang

Executable for running Mean Shift.

mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see http://www.opensource.org/licenses/BSD-3-Clause for more information.