itkNeighborhoodOperatorImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkNeighborhoodOperatorImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2006-03-31 14:31:04 $
  Version:   $Revision: 1.33 $

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

#include "itkImageToImageFilter.h"
#include "itkNeighborhoodOperator.h"
#include "itkImage.h"
#include "itkImageBoundaryCondition.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"

namespace itk
{
template <class TInputImage, class TOutputImage, class TOperatorValueType=ITK_TYPENAME TOutputImage::PixelType>
class ITK_EXPORT NeighborhoodOperatorImageFilter :
    public ImageToImageFilter< TInputImage, TOutputImage > 
{
public:
  typedef NeighborhoodOperatorImageFilter Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
  typedef       SmartPointer<Self> Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(NeighborhoodOperatorImageFilter, ImageToImageFilter);

  typedef typename TOutputImage::PixelType         OutputPixelType;
  typedef typename TOutputImage::InternalPixelType OutputInternalPixelType;
  typedef typename  TInputImage::PixelType         InputPixelType;
  typedef typename  TInputImage::InternalPixelType InputInternalPixelType;
  typedef TOperatorValueType                       OperatorValueType;

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TOutputImage::ImageDimension);
  itkStaticConstMacro(InputImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  typedef TInputImage  InputImageType;
  typedef TOutputImage OutputImageType;
  typedef typename InputImageType::Pointer InputImagePointer;

  typedef ImageBoundaryCondition<InputImageType> *
  ImageBoundaryConditionPointerType;

  typedef ZeroFluxNeumannBoundaryCondition<InputImageType> DefaultBoundaryCondition;

  typedef typename Superclass::OutputImageRegionType OutputImageRegionType;

  typedef Neighborhood<OperatorValueType,
               itkGetStaticConstMacro(ImageDimension)> OutputNeighborhoodType;

  void SetOperator(const OutputNeighborhoodType &p)
  {
    m_Operator = p;
    this->Modified();
  }

  const OutputNeighborhoodType& GetOperator() const
    { return m_Operator; } 

  void OverrideBoundaryCondition(const ImageBoundaryConditionPointerType i)
  { m_BoundsCondition = i; }

  ImageBoundaryConditionPointerType GetBoundaryCondition()
    { return m_BoundsCondition; }

  virtual void GenerateInputRequestedRegion() throw (InvalidRequestedRegionError);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<InputImageDimension, ImageDimension>));
  itkConceptMacro(OperatorConvertibleToOutputCheck,
    (Concept::Convertible<OperatorValueType, OutputPixelType>));
  itkConceptMacro(InputConvertibleToOperatorCheck,
    (Concept::Convertible<InputPixelType, OperatorValueType>));
  itkConceptMacro(OperatorMultiplyOperatorCheck,
    (Concept::MultiplyOperator<OperatorValueType>));
  itkConceptMacro(OperatorAdditiveOperatorsCheck,
    (Concept::AdditiveOperators<OperatorValueType>));

#endif

protected:
  NeighborhoodOperatorImageFilter()
    { m_BoundsCondition = static_cast<ImageBoundaryConditionPointerType>(&m_DefaultBoundaryCondition); }
  virtual ~NeighborhoodOperatorImageFilter() {}
    
  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
                            int threadId );

  
  void PrintSelf(std::ostream& os, Indent indent) const
  {  Superclass::PrintSelf(os, indent); }
private:
  NeighborhoodOperatorImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  OutputNeighborhoodType m_Operator;

  ImageBoundaryConditionPointerType m_BoundsCondition;

  DefaultBoundaryCondition m_DefaultBoundaryCondition;

};
  
} // end namespace itk

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

#endif

---