clusterlib.dox 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. /*! \page clusterlib GRASS Cluster analysis statistics Library
  2. by GRASS Development Team (http://grass.osgeo.org)
  3. \section clusterintro Introduction
  4. This library does a k-means style of cluster analysis. It is currently
  5. only used by <tt>i.cluster</tt>.
  6. The library functions are defined in <tt>cluster.h</tt>.
  7. \code
  8. #include <grass/cluster.h>
  9. \endcode
  10. \section ClusterStruct Cluster structure
  11. \code
  12. struct Cluster
  13. {
  14. int nbands; /* number of bands */
  15. int npoints; /* number of points */
  16. DCELL **points; /* array of points */
  17. int np;
  18. double *band_sum; /* sum over each band */
  19. double *band_sum2; /* sum of squares over each band */
  20. int *class; /* class of each point */
  21. int *reclass; /* for removing empty classes */
  22. int *count; /* number of points in each class */
  23. int *countdiff; /* change in count */
  24. double **sum; /* sum over band per class */
  25. double **sumdiff; /* change in sum */
  26. double **sum2; /* sum of squares per band per class */
  27. double **mean; /* initial class means */
  28. struct Signature S; /* final signature(s) */
  29. int nclasses; /* number of classes */
  30. int merge1, merge2;
  31. int iteration; /* number of iterations */
  32. double percent_stable; /* percentage stable */
  33. };
  34. \endcode
  35. \section listFn List of functions
  36. - I_cluster_assign()
  37. - I_cluster_begin()
  38. - I_cluster_clear()
  39. - I_cluster_distinct()
  40. - I_cluster_exec()
  41. - I_cluster_exec_allocate()
  42. - I_cluster_exec_free()
  43. - I_cluster_means()
  44. - I_cluster_merge()
  45. - I_cluster_nclasses()
  46. - I_cluster_point()
  47. - I_cluster_begin_point_set()
  48. - I_cluster_point_part()
  49. - I_cluster_end_point_set()
  50. - I_cluster_reassign()
  51. - I_cluster_reclass()
  52. - I_cluster_separation()
  53. - I_cluster_signatures()
  54. - I_cluster_sum2()
  55. */