itkGPUNeighborhoodOperatorImageFilter.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 itkGPUNeighborhoodOperatorImageFilter_h
#define itkGPUNeighborhoodOperatorImageFilter_h
 
#include "itkGPUImage.h"
#include "itkGPUImageToImageFilter.h"
#include "itkImageToImageFilter.h"
#include "itkNeighborhoodOperator.h"
#include "itkImage.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"
#include "itkNeighborhoodOperatorImageFilter.h"
 
namespace itk
{
itkGPUKernelClassMacro(GPUNeighborhoodOperatorImageFilterKernel);
 
template <typename TInputImage,
          typename TOutputImage,
          typename TOperatorValueType = typename TOutputImage::PixelType,
          typename TParentImageFilter = NeighborhoodOperatorImageFilter<TInputImage, TOutputImage, TOperatorValueType>>
class ITK_TEMPLATE_EXPORT GPUNeighborhoodOperatorImageFilter
  : public GPUImageToImageFilter<TInputImage, TOutputImage, TParentImageFilter>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUNeighborhoodOperatorImageFilter);
 
  using Self = GPUNeighborhoodOperatorImageFilter;
  using CPUSuperclass = TParentImageFilter;
  using GPUSuperclass = GPUImageToImageFilter<TInputImage, TOutputImage, TParentImageFilter>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(GPUNeighborhoodOperatorImageFilter);
 
  using OutputPixelType = typename TOutputImage::PixelType;
  using OutputInternalPixelType = typename TOutputImage::InternalPixelType;
  using InputPixelType = typename TInputImage::PixelType;
  using InputInternalPixelType = typename TInputImage::InternalPixelType;
  using OperatorValueType = TOperatorValueType;
 
  using InputPixelValueType = typename NumericTraits<InputPixelType>::ValueType;
  using ComputingPixelType = typename NumericTraits<OutputPixelType>::RealType;
 
  using NeighborhoodGPUBufferType = GPUImage<TOperatorValueType, Self::ImageDimension>;
 
  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
 
  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using InputImagePointer = typename InputImageType::Pointer;
 
  using ImageBoundaryConditionPointerType = ImageBoundaryCondition<InputImageType> *;
 
  using DefaultBoundaryCondition = ZeroFluxNeumannBoundaryCondition<InputImageType>;
 
  using OutputImageRegionType = typename GPUSuperclass::OutputImageRegionType;
 
  using OutputNeighborhoodType = Neighborhood<OperatorValueType, Self::ImageDimension>;
 
  itkGetOpenCLSourceFromKernelMacro(GPUNeighborhoodOperatorImageFilterKernel);
 
  void
  SetOperator(const OutputNeighborhoodType & p);
 
#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  // itkConceptMacro( SameDimensionCheck,
  //                  ( Concept::SameDimension< InputImageDimension, ImageDimension > ) );
  // itkConceptMacro( OperatorConvertibleToOutputCheck,
  //                  ( Concept::Convertible< OperatorValueType, OutputPixelType > ) );
  // itkConceptMacro( InputConvertibleToOperatorCheck,
  //                  ( Concept::Convertible< InputPixelValueType, OperatorValueType > ) );
  // itkConceptMacro( OperatorMultiplyOperatorCheck,
  //                  ( Concept::MultiplyOperator< OperatorValueType > ) );
  // itkConceptMacro( OperatorAdditiveOperatorsCheck,
  //                  ( Concept::AdditiveOperators< OperatorValueType > ) );
  // End concept checking
#endif
 
protected:
  GPUNeighborhoodOperatorImageFilter();
  ~GPUNeighborhoodOperatorImageFilter() override = default;
 
  void
  GPUGenerateData() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    GPUSuperclass::PrintSelf(os, indent);
  }
 
private:
  int m_NeighborhoodOperatorFilterGPUKernelHandle{};
 
  typename NeighborhoodGPUBufferType::Pointer m_NeighborhoodGPUBuffer{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGPUNeighborhoodOperatorImageFilter.hxx"
#endif
 
#endif