itkMultiOutputNaryFunctorImageFilter.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef __itkMultiOutputNaryFunctorImageFilter_h
#define __itkMultiOutputNaryFunctorImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkImageIterator.h"
#include "itkArray.h"

namespace itk
{
template< class TInputImage, class TOutputImage, class TFunction, class TMaskImage = ::itk::Image<unsigned char, TInputImage::ImageDimension> >
class ITK_EXPORT MultiOutputNaryFunctorImageFilter:
  public ImageToImageFilter< TInputImage, TOutputImage >

{
public:
  typedef MultiOutputNaryFunctorImageFilter                          Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;
  itkNewMacro(Self);

  itkTypeMacro(MultiOutputNaryFunctorImageFilter, ImageToImageFilter);

  typedef TFunction                            FunctorType;
  typedef TInputImage                          InputImageType;
  typedef typename InputImageType::Pointer     InputImagePointer;
  typedef typename InputImageType::RegionType  InputImageRegionType;
  typedef typename InputImageType::PixelType   InputImagePixelType;
  typedef TOutputImage                         OutputImageType;
  typedef typename OutputImageType::Pointer    OutputImagePointer;
  typedef typename OutputImageType::RegionType OutputImageRegionType;
  typedef typename OutputImageType::PixelType  OutputImagePixelType;
  typedef typename FunctorType::InputPixelArrayType     NaryInputArrayType;
  typedef typename FunctorType::OutputPixelArrayType    NaryOutputArrayType;
  typedef TMaskImage MaskImageType;
  typedef typename MaskImageType::Pointer     MaskImagePointer;
  typedef typename MaskImageType::RegionType  MaskImageRegionType;

  FunctorType & GetFunctor() { return m_Functor; }

  void SetFunctor(FunctorType & functor)
  {
    if ( m_Functor != functor )
      {
      m_Functor = functor;
      this->ActualizeOutputs();
      this->Modified();
      }
  }

  itkSetObjectMacro(Mask, MaskImageType);
  itkGetConstObjectMacro(Mask, MaskImageType);

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

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( SameDimensionCheck,
                   ( Concept::SameDimension< InputImageDimension, OutputImageDimension > ) );
  itkConceptMacro( OutputHasZeroCheck,
                   ( Concept::HasZero< OutputImagePixelType > ) );
#endif
protected:
  MultiOutputNaryFunctorImageFilter();
  ~MultiOutputNaryFunctorImageFilter() override {}

  void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
                            ThreadIdType threadId) override;

  void ActualizeOutputs();

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

  FunctorType m_Functor;
  MaskImagePointer m_Mask;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMultiOutputNaryFunctorImageFilter.tpp"
#endif

#endif