animaSpectralClusteringFilter.h

Go to the documentation of this file.

#pragma once

#include <vector>
#include <vnl/vnl_matrix.h>
#include <vnl/vnl_diag_matrix.h>

#include <itkSymmetricEigenAnalysis.h>

#include <animaFuzzyCMeansFilter.h>

namespace anima
{

template <class ScalarType>
class SpectralClusteringFilter
{
public:
    typedef std::vector <ScalarType> VectorType;
    typedef vnl_matrix <ScalarType> MatrixType;

    typedef anima::FuzzyCMeansFilter <ScalarType> CMeansFilterType;
    typedef typename CMeansFilterType::CentroidAverageType CMeansAverageType;
    typedef itk::SymmetricEigenAnalysis <MatrixType, vnl_diag_matrix<ScalarType>, MatrixType> EigenAnalysisType;

    SpectralClusteringFilter();
    virtual ~SpectralClusteringFilter() {}

    void SetInputData(MatrixType &data);
    void SetDataWeights(VectorType &val) {m_DataWeights = val;}
    void SetNbClass(unsigned int nbC) {m_NbClass = nbC;}
    void SetSigmaWeighting(double sigma) {m_SigmaWeighting = sigma;}

    // Parameters for fuzzy c-means
    void SetMaxIterations(unsigned int mIt) {m_MaxIterations = mIt;}
    void SetRelStopCriterion(double rC) {m_RelStopCriterion = rC;}
    void SetMValue(double mV) {m_MValue = mV;}

    void SetCMeansAverageType(CMeansAverageType val) {m_CMeansAverageType = val;}

    void ComputeSpectralVectors();
    void Update();

    double ComputeClustersSpreading();
    void InitializeSigmaFromDistances();

    void SetVerbose(bool verb) {m_Verbose = verb;}

    VectorType &GetSpectralVector(unsigned int i) {return m_SpectralVectors[i];}
    VectorType &GetClassesMembership(unsigned int i) {return m_ClassesMembership[i];}
    VectorType &GetCentroid(unsigned int i) {return m_Centroids[i];}
    std::vector <unsigned int> GetClassMembers(unsigned int i);

private:
    std::vector <VectorType> m_ClassesMembership;
    std::vector <VectorType> m_Centroids;
    std::vector <VectorType> m_SpectralVectors;
    MatrixType m_InputData;
    VectorType m_DataWeights;

    unsigned int m_NbClass;

    CMeansAverageType m_CMeansAverageType;
    CMeansFilterType m_MainFilter;

    bool m_Verbose;

    unsigned int m_MaxIterations;
    double m_RelStopCriterion;
    double m_MValue;

    double m_SigmaWeighting;

    // Internal data
    MatrixType m_WMatrix;
    std::vector <double> m_DValues;

    EigenAnalysisType m_EigenAnalyzer;
    vnl_diag_matrix<ScalarType> m_EigVals;
    MatrixType m_EigVecs;
    VectorType m_WorkVec;
};

} // end namespace anima

#include "animaSpectralClusteringFilter.hxx"