itkMeanShiftModeSeekerBase.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMeanShiftModeSeekerBase.h,v $
  Language:  C++
  Date:      $Date: 2009-03-04 15:24:01 $
  Version:   $Revision: 1.10 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

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

#ifndef __itkMeanShiftModeSeekerBase_h
#define __itkMeanShiftModeSeekerBase_h

#include "itkObject.h"
#include "itkVector.h"
#include "itkMatrix.h"
#include "itkNumericTraits.h"
#include "itkMeanShiftModeCacheMethod.h"

namespace itk { 
namespace Statistics {
  
template< class TSample >
class MeanShiftModeSeekerBase :
    public Object
{
public:
  typedef MeanShiftModeSeekerBase  Self;
  typedef Object                   Superclass;
  typedef SmartPointer<Self>       Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  itkTypeMacro(MeanShiftModeSeekerBase, Object);

  typedef typename TSample::MeasurementVectorType     MeasurementVectorType;
  typedef typename TSample::MeasurementVectorSizeType MeasurementVectorSizeType;
  typedef typename TSample::MeasurementType           MeasurementType;
  typedef typename TSample::InstanceIdentifier        InstanceIdentifier;

  typedef std::vector< InstanceIdentifier >                 SearchResultVectorType;
  typedef MeanShiftModeCacheMethod< MeasurementVectorType > CacheMethodType;

  void SetInputSample(const TSample* sample);

  const TSample* GetInputSample() const
    { return m_InputSample.GetPointer(); }

  void SetMaximumIteration(unsigned int number)
    { m_MaximumIteration = number; }

  unsigned int GetMaximumIteration()
    { return m_MaximumIteration; }

  void SetCacheMethod(CacheMethodType* method);

  CacheMethodType* GetCacheMethod()
    { return m_CacheMethod.GetPointer(); }

  MeasurementVectorType Evolve(MeasurementVectorType instance);

  virtual MeasurementVectorSizeType GetMeasurementVectorSize() const
    {
    if( m_InputSample.GetPointer() )
      {
      return m_InputSample.GetPointer()->GetMeasurementVectorSize();
      }
    else
      {
      return 0;
      }
    }

protected:
  MeanShiftModeSeekerBase();
  virtual ~MeanShiftModeSeekerBase();
  void PrintSelf(std::ostream& os, Indent indent) const;

  virtual bool ComputeMode(MeasurementVectorType queryPoint,
                           MeasurementVectorType& newPoint) = 0;

private:
  typename TSample::ConstPointer    m_InputSample;
  unsigned int                      m_MaximumIteration;
  typename CacheMethodType::Pointer m_CacheMethod;
}; // end of class
    
} // end of namespace Statistics 
} // end of namespace itk 

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMeanShiftModeSeekerBase.txx"
#endif

#endif