itkTernaryFunctorImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkTernaryFunctorImageFilter_h
#define itkTernaryFunctorImageFilter_h
 
#include "itkInPlaceImageFilter.h"
#include "itkImageRegionIteratorWithIndex.h"
 
namespace itk
{
template <typename TInputImage1,
          typename TInputImage2,
          typename TInputImage3,
          typename TOutputImage,
          typename TFunction>
class ITK_TEMPLATE_EXPORT TernaryFunctorImageFilter : public InPlaceImageFilter<TInputImage1, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(TernaryFunctorImageFilter);

  using Self = TernaryFunctorImageFilter;
  using Superclass = InPlaceImageFilter<TInputImage1, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(TernaryFunctorImageFilter);

  using FunctorType = TFunction;
  using Input1ImageType = TInputImage1;
  using Input1ImagePointer = typename Input1ImageType::ConstPointer;
  using Input1ImageRegionType = typename Input1ImageType::RegionType;
  using Input1ImagePixelType = typename Input1ImageType::PixelType;
  using Input2ImageType = TInputImage2;
  using Input2ImagePointer = typename Input2ImageType::ConstPointer;
  using Input2ImageRegionType = typename Input2ImageType::RegionType;
  using Input2ImagePixelType = typename Input2ImageType::PixelType;
  using Input3ImageType = TInputImage3;
  using Input3ImagePointer = typename Input3ImageType::ConstPointer;
  using Input3ImageRegionType = typename Input3ImageType::RegionType;
  using Input3ImagePixelType = typename Input3ImageType::PixelType;
  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputImageRegionType = typename OutputImageType::RegionType;
  using OutputImagePixelType = typename OutputImageType::PixelType;

  void
  SetInput1(const TInputImage1 * image1);

  void
  SetInput2(const TInputImage2 * image2);

  void
  SetInput3(const TInputImage3 * image3);

  FunctorType &
  GetFunctor()
  {
    return m_Functor;
  }

  const FunctorType &
  GetFunctor() const
  {
    return m_Functor;
  }

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


  static constexpr unsigned int Input1ImageDimension = TInputImage1::ImageDimension;
  static constexpr unsigned int Input2ImageDimension = TInputImage2::ImageDimension;
  static constexpr unsigned int Input3ImageDimension = TInputImage3::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
 
  itkConceptMacro(SameDimensionCheck1, (Concept::SameDimension<Input1ImageDimension, Input2ImageDimension>));
  itkConceptMacro(SameDimensionCheck2, (Concept::SameDimension<Input1ImageDimension, Input3ImageDimension>));
  itkConceptMacro(SameDimensionCheck3, (Concept::SameDimension<Input1ImageDimension, OutputImageDimension>));
 
protected:
  TernaryFunctorImageFilter();
  ~TernaryFunctorImageFilter() override = default;

  void
  BeforeThreadedGenerateData() override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 
 
private:
  FunctorType m_Functor{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkTernaryFunctorImageFilter.hxx"
#endif
 
#endif