hikmeans.h File Reference
Detailed Description
Hierarchical Integer K-Means Clustering.Hierarchical integer K-Means clustering (HIKM) is a simple hierarchical version of integer K-Means (IKM). The algorithm recursively applies integer K-means to create more refined partitions of the data.
Create a tree with vl_hikm_new() and delete it with vl_hikm_delete(). Use vl_hikm_train() to build the tree from training data and vl_hikm_push() to project new data down a HIKM tree.
HIKM tree
The HIKM tree is represented by a VlHIKMTree structure, which contains a tree composed of VlHIKMNode. Each node is an integer K-means filter which partitions the data intoK
clusters.
Definition in file hikmeans.h.
#include "generic.h"
#include "ikmeans.h"
Go to the source code of this file.
Data Structures | |
struct | _VlHIKMNode |
HIKM tree node. More... | |
struct | _VlHIKMTree |
HIKM tree. More... | |
Functions | |
Create and destroy | |
VL_EXPORT VlHIKMTree * | vl_hikm_new (int method) |
New HIKM tree. | |
VL_EXPORT void | vl_hikm_delete (VlHIKMTree *f) |
Delete HIKM tree. | |
Retrieve data and parameters | |
VL_INLINE int | vl_hikm_get_ndims (VlHIKMTree const *f) |
Get data dimensionality. | |
VL_INLINE int | vl_hikm_get_K (VlHIKMTree const *f) |
Get K. | |
VL_INLINE int | vl_hikm_get_depth (VlHIKMTree const *f) |
Get depth. | |
VL_INLINE int | vl_hikm_get_verbosity (VlHIKMTree const *f) |
Get verbosity level. | |
VL_INLINE int | vl_hikm_get_max_niters (VlHIKMTree const *f) |
Get maximum number of iterations. | |
VL_INLINE VlHIKMNode const * | vl_hikm_get_root (VlHIKMTree const *f) |
Get maximum number of iterations. | |
Set parameters | |
VL_INLINE void | vl_hikm_set_verbosity (VlHIKMTree *f, int verb) |
Set verbosity level. | |
VL_INLINE void | vl_hikm_set_max_niters (VlHIKMTree *f, int max_niters) |
Set maximum number of iterations. | |
Process data | |
VL_EXPORT void | vl_hikm_init (VlHIKMTree *f, int M, int K, int depth) |
Initialize HIKM tree. | |
VL_EXPORT void | vl_hikm_train (VlHIKMTree *f, vl_uint8 const *data, int N) |
Train HIKM tree. | |
VL_EXPORT void | vl_hikm_push (VlHIKMTree *f, vl_uint *asgn, vl_uint8 const *data, int N) |
Project data down HIKM tree. |
Function Documentation
VL_EXPORT void vl_hikm_delete | ( | VlHIKMTree * | f | ) |
VL_INLINE int vl_hikm_get_depth | ( | VlHIKMTree const * | f | ) |
- Parameters:
-
f HIKM tree.
- Returns:
- depth.
Definition at line 109 of file hikmeans.h.
Referenced by vl_hikm_push().
VL_INLINE int vl_hikm_get_K | ( | VlHIKMTree const * | f | ) |
VL_INLINE int vl_hikm_get_max_niters | ( | VlHIKMTree const * | f | ) |
- Parameters:
-
f HIKM tree.
- Returns:
- maximum number of iterations.
Definition at line 134 of file hikmeans.h.
VL_INLINE int vl_hikm_get_ndims | ( | VlHIKMTree const * | f | ) |
- Parameters:
-
f HIKM tree.
- Returns:
- data dimensionality.
Definition at line 85 of file hikmeans.h.
Referenced by vl_hikm_push().
VL_INLINE VlHIKMNode const * vl_hikm_get_root | ( | VlHIKMTree const * | f | ) |
- Parameters:
-
f HIKM tree.
- Returns:
- maximum number of iterations.
Definition at line 146 of file hikmeans.h.
VL_INLINE int vl_hikm_get_verbosity | ( | VlHIKMTree const * | f | ) |
VL_EXPORT void vl_hikm_init | ( | VlHIKMTree * | f, | |
int | M, | |||
int | K, | |||
int | depth | |||
) |
- Parameters:
-
f HIKM tree. M Data dimensionality. K Number of clusters per node. depth Tree depth.
- Remarks:
- depth cannot be smaller than 1.
- Returns:
- a new HIKM tree representing the clustering.
Definition at line 218 of file hikmeans.c.
References xdelete().
VL_EXPORT VlHIKMTree* vl_hikm_new | ( | int | method | ) |
- Parameters:
-
method clustering method.
- Returns:
- new HIKM tree.
Definition at line 175 of file hikmeans.c.
References vl_malloc().
VL_EXPORT void vl_hikm_push | ( | VlHIKMTree * | f, | |
vl_uint * | asgn, | |||
vl_uint8 const * | data, | |||
int | N | |||
) |
- Parameters:
-
f HIKM tree. asgn Path down the tree (out). data Data to project. N Number of data.
M
by N
elements, where M
is the depth of the HIKM tree and N
is the number of data point to process.
Definition at line 262 of file hikmeans.c.
References _VlHIKMNode::children, _VlHIKMNode::filter, _VlHIKMTree::root, vl_hikm_get_depth(), vl_hikm_get_ndims(), and vl_ikm_push().
VL_INLINE void vl_hikm_set_max_niters | ( | VlHIKMTree * | f, | |
int | max_niters | |||
) |
- Parameters:
-
f HIKM tree. max_niters maximum number of iterations.
Definition at line 170 of file hikmeans.h.
VL_INLINE void vl_hikm_set_verbosity | ( | VlHIKMTree * | f, | |
int | verb | |||
) |
VL_EXPORT void vl_hikm_train | ( | VlHIKMTree * | f, | |
vl_uint8 const * | data, | |||
int | N | |||
) |
- Parameters:
-
f HIKM tree. data Data to cluster. N Number of data.
Definition at line 241 of file hikmeans.c.
References _VlHIKMTree::depth, _VlHIKMTree::K, VL_MIN, and xmeans().