itkObjectMorphologyImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkObjectMorphologyImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-04-25 12:27:45 $
  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 __itkObjectMorphologyImageFilter_h
#define __itkObjectMorphologyImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkNeighborhoodIterator.h"
#include "itkNeighborhood.h"
#include "itkConstSliceIterator.h"
#include "itkConstantBoundaryCondition.h"
#include "itkImageBoundaryCondition.h"
#include "itkImageRegionIterator.h"

namespace itk {

template<class TInputImage, class TOutputImage, class TKernel>
class ITK_EXPORT ObjectMorphologyImageFilter : 
    public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef ObjectMorphologyImageFilter                   Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage>  Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  itkTypeMacro(ObjectMorphologyImageFilter, ImageToImageFilter);

  typedef TInputImage                      InputImageType;
  typedef TOutputImage                     OutputImageType;
  typedef typename TInputImage::RegionType RegionType;
  typedef typename TInputImage::SizeType   SizeType;
  typedef typename TInputImage::IndexType  IndexType;
  typedef typename TInputImage::PixelType  PixelType;

  typedef typename Superclass::OutputImageRegionType OutputImageRegionType;

  typedef ImageBoundaryCondition<InputImageType> * 
               ImageBoundaryConditionPointerType;
  typedef ImageBoundaryCondition<InputImageType> const * 
               ImageBoundaryConditionConstPointerType;
  typedef ConstantBoundaryCondition<InputImageType> 
               DefaultBoundaryConditionType;
  
  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int,
                      TOutputImage::ImageDimension );
  itkStaticConstMacro(KernelDimension, unsigned int,
                      TKernel::NeighborhoodDimension);  

  typedef ConstNeighborhoodIterator<TInputImage> 
                                 InputNeighborhoodIteratorType;
  typedef NeighborhoodIterator<TOutputImage> 
                                 OutputNeighborhoodIteratorType;

  typedef TKernel KernelType;

  typedef typename KernelType::ConstIterator KernelIteratorType;

  typedef typename KernelType::SizeType RadiusType;

  itkSetMacro(Kernel, KernelType);

  itkGetConstReferenceMacro(Kernel, KernelType);

  itkGetConstMacro(ObjectValue, PixelType);

  itkSetMacro(ObjectValue, PixelType);

  void GenerateInputRequestedRegion();

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

  void ResetBoundaryCondition()
    { m_BoundaryCondition = &m_DefaultBoundaryCondition; }

  itkGetConstMacro(BoundaryCondition, ImageBoundaryConditionPointerType);

  itkSetMacro(UseBoundaryCondition, bool);

  itkGetConstMacro(UseBoundaryCondition, bool);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(SameDimensionCheck1,
    (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(SameDimensionCheck2,
    (Concept::SameDimension<ImageDimension, KernelDimension>));
  itkConceptMacro(OutputInputEqualityComparableCheck,
    (Concept::EqualityComparable<typename TOutputImage::PixelType,
                                 PixelType>));
  itkConceptMacro(InputConvertibleToOutputCheck,
    (Concept::Convertible<PixelType, typename TOutputImage::PixelType>));
  itkConceptMacro(IntConvertibleToOutputCheck,
    (Concept::Convertible<int, typename TOutputImage::PixelType>));
  itkConceptMacro(InputEqualityComparable,
    (Concept::EqualityComparable<PixelType>));
  itkConceptMacro(InputOStreamWritableCheck,
    (Concept::OStreamWritable<PixelType>));

#endif

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

  void  ThreadedGenerateData (const OutputImageRegionType& 
                              outputRegionForThread,
                              int threadId);

  virtual void Evaluate(OutputNeighborhoodIteratorType &nit,
                        const KernelType &kernel)=0;

  bool IsObjectPixelOnBoundary(const InputNeighborhoodIteratorType &nit);

  ImageBoundaryConditionPointerType m_BoundaryCondition;

  DefaultBoundaryConditionType m_DefaultBoundaryCondition;

  bool m_UseBoundaryCondition;

  KernelType m_Kernel;

  PixelType m_ObjectValue;

  void BeforeThreadedGenerateData();

private:
  ObjectMorphologyImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  

}; // end of class

} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkObjectMorphologyImageFilter.txx"
#endif

#endif