itkMIDASBaseConditionalMorphologyFilter.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

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

#ifndef itkMIDASBaseConditionalMorphologyFilter_h
#define itkMIDASBaseConditionalMorphologyFilter_h

#include <itkImageToImageFilter.h>
#include <itkImageDuplicator.h>
#include <itkConstNeighborhoodIterator.h>

namespace itk
{

  template <class TInputImage1, class TInputImage2, class TOutputImage>
  class ITK_EXPORT MIDASBaseConditionalMorphologyFilter : public ImageToImageFilter<TInputImage1, TOutputImage>
  {
  public:
    typedef MIDASBaseConditionalMorphologyFilter           Self;
    typedef ImageToImageFilter<TInputImage1, TOutputImage> SuperClass;
    typedef SmartPointer<Self>                             Pointer;
    typedef SmartPointer<const Self>                       ConstPointer;

    itkTypeMacro(MIDASBaseConditionalMorphologyFilter, ImageToImageFilter);

    typedef typename TInputImage1::PixelType PixelType1;

    typedef typename TInputImage2::PixelType PixelType2;

    typedef TInputImage1                              InputMaskImageType;
    typedef typename InputMaskImageType::Pointer      InputMaskImagePointer;
    typedef typename InputMaskImageType::SizeType     InputMaskImageSizeType;
    typedef typename InputMaskImageType::RegionType   InputMaskImageRegionType;
    typedef typename InputMaskImageType::IndexType    InputMaskImageIndexType;

    typedef TInputImage2                              InputMainImageType;
    typedef typename InputMainImageType::Pointer      InputMainImagePointer;
    typedef typename InputMainImageType::SizeType     InputMainImageSizeType;
    typedef typename InputMainImageType::RegionType   InputMainImageRegionType;

    typedef TOutputImage                              OutputImageType;
    typedef typename OutputImageType::Pointer         OutputImagePointer;
    typedef typename OutputImageType::RegionType      OutputImageRegionType;
    typedef typename OutputImageType::SizeType        OutputImageSizeType;
    typedef typename OutputImageType::IndexType       OutputImageIndexType;
    typedef typename itk::ConstNeighborhoodIterator<OutputImageType>::RadiusType  OutputImageRadiusType;

    typedef typename itk::ImageDuplicator<OutputImageType> MaskImageDuplicatorType;
    typedef typename MaskImageDuplicatorType::Pointer MaskImageDuplicatorPointer;

    void SetRegion(InputMaskImageRegionType region) { m_Region = region; m_UserSetRegion = true; this->Modified(); }
    InputMaskImageRegionType GetRegion() const { return m_Region; }

    itkSetMacro(NumberOfIterations, unsigned int);
    itkGetConstMacro(NumberOfIterations, unsigned int);

    itkSetMacro(InValue, PixelType1);
    itkGetConstMacro(InValue, PixelType1);

    itkSetMacro(OutValue, PixelType1);
    itkGetConstMacro(OutValue, PixelType1);

    void SetBinaryImageInput(const InputMaskImageType* image);

    void SetGreyScaleImageInput(const InputMainImageType* image);

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

    virtual void GenerateData();

    virtual void DoFilter(InputMainImageType* inGrey, OutputImageType* inMask, OutputImageType *out) = 0;

    virtual void BeforeFilter() {};

    virtual void AfterFilter() {};

    virtual void BeforeIteration() {};

    virtual void AfterIteration() {};

    void CopyImageData(OutputImageType* in, OutputImageType *out);
    bool IsOnBoundaryOfImage(const OutputImageIndexType &voxelIndex, const OutputImageSizeType &size);
    bool IsOnBoundaryOfRegion(const OutputImageIndexType &voxelIndex, const OutputImageRegionType& region);

    InputMaskImageRegionType m_Region;
    bool                     m_UserSetRegion;

  private:
    MIDASBaseConditionalMorphologyFilter(const Self&); //purposely not implemented
    void operator=(const Self&); //purposely not implemented
    void DoOneIterationOfFilter(InputMainImageType* inGrey, OutputImageType* inMask, OutputImageType *out);

    PixelType1               m_InValue;
    PixelType1               m_OutValue;
    unsigned int             m_NumberOfIterations;

    // This is a member variable, so we don't repeatedly create/destroy the memory if the main filter is called repeatedly.
    MaskImageDuplicatorPointer m_TempImage;
  };

}

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

#endif