mitkConnectomicsSimulatedAnnealingCostFunctionModularity.h

Go to the documentation of this file.

/*===================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef mitkConnectomicsSimulatedAnnealingCostFunctionModularity_h
#define mitkConnectomicsSimulatedAnnealingCostFunctionModularity_h

#include "mitkConnectomicsSimulatedAnnealingCostFunctionBase.h"

#include "mitkConnectomicsNetwork.h"

namespace mitk
{
  class MITKCONNECTOMICS_EXPORT ConnectomicsSimulatedAnnealingCostFunctionModularity : public mitk::ConnectomicsSimulatedAnnealingCostFunctionBase
  {
  public:

    typedef mitk::ConnectomicsNetwork::VertexDescriptorType VertexDescriptorType;
    typedef std::map< VertexDescriptorType, int > ToModuleMapType;
    typedef std::map< VertexDescriptorType, VertexDescriptorType > VertexToVertexMapType;

    mitkClassMacro(ConnectomicsSimulatedAnnealingCostFunctionModularity, mitk::ConnectomicsSimulatedAnnealingCostFunctionBase);
    itkFactorylessNewMacro(Self)
    itkCloneMacro(Self)

    // Evaluate the network according to the set cost function
    double Evaluate( mitk::ConnectomicsNetwork::Pointer network, ToModuleMapType *vertexToModuleMap  ) const;

    // Will calculate and return the modularity of the network
    double CalculateModularity( mitk::ConnectomicsNetwork::Pointer network, ToModuleMapType *vertexToModuleMap  ) const;


  protected:

    // returns the number of modules
    int getNumberOfModules( ToModuleMapType *vertexToModuleMap ) const;

    ConnectomicsSimulatedAnnealingCostFunctionModularity();
    ~ConnectomicsSimulatedAnnealingCostFunctionModularity();

  };

}// end namespace mitk

#endif // mitkConnectomicsSimulatedAnnealingCostFunctionModularity_h