Numerics/Statistics/itkNeighborhoodSampler.h

Go to the documentation of this file.

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

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

  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 __itkNeighborhoodSampler_h
#define __itkNeighborhoodSampler_h

#include "itkMacro.h"
#include "itkObject.h"
#include "itkSample.h"
#include "itkSubsample.h"
#include "itkArray.h"
#include "itkSampleAlgorithmBase.h"

namespace itk { 
namespace Statistics {

template < class TSample >
class ITK_EXPORT NeighborhoodSampler : public SampleAlgorithmBase< TSample >
{
public:
  typedef NeighborhoodSampler            Self;
  typedef SampleAlgorithmBase< TSample > Superclass;
  typedef SmartPointer< Self >           Pointer;
  typedef SmartPointer< const Self >     ConstPointer;

  itkTypeMacro(NeighborhoodSampler, SampleAlgorithmBase);

  itkNewMacro(Self);

  typedef TSample SampleType;


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

  typedef typename Superclass::InputSampleType InputSampleType;

  typedef Subsample< TSample > SubsampleType;

  typedef double RadiusType;

  typedef Array< double > CenterType;

  void SetCenter(CenterType* center)
    {
    if( this->GetMeasurementVectorSize() && 
      ( center->Size() != this->GetMeasurementVectorSize() ) )
      {
      itkExceptionMacro( << "Size of measurement vectors in the sample is: " <<
         this->GetMeasurementVectorSize() << " but size of center is: " <<
         center->Size() );
      }

    if ( m_Center != center )
      {
      m_Center = center;
      this->Modified();
      }
    }

  CenterType* GetCenter() 
    { return m_Center; }

  void SetRadius(RadiusType* radius)
    { 
    if ( m_Radius != radius )
      {
      m_Radius = radius;
      this->Modified();
      }
    }

  RadiusType* GetRadius()
    { return m_Radius; } 

  typedef SubsampleType OutputType;

  typedef typename SubsampleType::Pointer OutputPointer;

  OutputPointer GetOutput();

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

  void GenerateData();

private:
  NeighborhoodSampler(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  CenterType*                     m_Center;
  RadiusType*                     m_Radius;
  typename SubsampleType::Pointer m_Subsample;
}; // end of class

} // end of namespace Statistics 
} // end of namespace itk

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

#endif