itkNeighborhoodOperator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkNeighborhoodOperator.h,v $
  Language:  C++
  Date:      $Date: 2009-02-06 20:53:13 $
  Version:   $Revision: 1.29 $

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

#include "itkNeighborhood.h"
#include "itkExceptionObject.h"
#include "itkNumericTraits.h"
#include <vector>

namespace itk {
template< class TPixel, unsigned int VDimension,
  class TAllocator = NeighborhoodAllocator<TPixel> >
class ITK_EXPORT NeighborhoodOperator
  : public Neighborhood<TPixel, VDimension, TAllocator>
{
public:
  typedef NeighborhoodOperator                         Self;
  typedef Neighborhood<TPixel, VDimension, TAllocator> Superclass;
    
  typedef typename Superclass::SizeType SizeType;

  typedef TPixel PixelType;

  typedef SliceIterator<TPixel, Self> SliceIteratorType;
 
  NeighborhoodOperator()
    {  m_Direction = 0;  }

  NeighborhoodOperator(const Self &orig)
    : Neighborhood<TPixel, VDimension, TAllocator>(orig) 
    {   m_Direction = orig.m_Direction;   }
  
  Self &operator=( const Self &orig )
    {
      Superclass::operator=(orig);
      m_Direction = orig.m_Direction;
      return *this;
    }
  
  void SetDirection(const unsigned long &direction)
    {  m_Direction = direction;   }

  unsigned long GetDirection() const
    {  return m_Direction;  }
  
  virtual void CreateDirectional();

  virtual void CreateToRadius(const SizeType &);

  virtual void CreateToRadius(const unsigned long);

  virtual void FlipAxes();
  
  virtual void PrintSelf(std::ostream& os, Indent i) const
    {
    os << i << "NeighborhoodOperator { this=" << this
       << " Direction = " << m_Direction << " }" << std::endl;
    Superclass::PrintSelf( os, i.GetNextIndent() );
    }

  typedef typename NumericTraits< TPixel >::RealType  PixelRealType;

  void ScaleCoefficients( PixelRealType );
  
protected:
  typedef std::vector<double>  CoefficientVector;

  virtual CoefficientVector GenerateCoefficients() = 0;

  virtual void Fill(const CoefficientVector &) = 0;
  
  virtual void FillCenteredDirectional(const CoefficientVector &);

  void InitializeToZero()
    {
    for (unsigned int i = 0; i< this->Size(); ++i)
      {
      this->operator[](i) = NumericTraits<PixelType>::Zero;
      }
    }
  
private:
  unsigned long  m_Direction;
};

} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_NeighborhoodOperator(_, EXPORT, x, y) namespace itk { \
  _(2(class EXPORT NeighborhoodOperator< ITK_TEMPLATE_2 x >)) \
  namespace Templates { typedef NeighborhoodOperator< ITK_TEMPLATE_2 x > \
                                                  NeighborhoodOperator##y; } \
  }

#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkNeighborhoodOperator+-.h"
#endif

#if ITK_TEMPLATE_TXX
# include "itkNeighborhoodOperator.txx"
#endif

/*
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkNeighborhoodOperator.txx"
#endif
*/
#endif