itkGPUMeanImageFilter.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 itkGPUMeanImageFilter_h
#define itkGPUMeanImageFilter_h
 
#include "itkMeanImageFilter.h"
#include "itkGPUBoxImageFilter.h"
#include "itkVersion.h"
#include "itkObjectFactoryBase.h"
#include "itkOpenCLUtil.h"
 
namespace itk
{

itkGPUKernelClassMacro(GPUMeanImageFilterKernel);
 
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT GPUMeanImageFilter
  : // public GPUImageToImageFilter<
    // TInputImage, TOutputImage,
    // MeanImageFilter< TInputImage,
    // TOutputImage > >
    public GPUBoxImageFilter<TInputImage, TOutputImage, MeanImageFilter<TInputImage, TOutputImage>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUMeanImageFilter);

  using Self = GPUMeanImageFilter;
  using Superclass = GPUBoxImageFilter<TInputImage, TOutputImage, MeanImageFilter<TInputImage, TOutputImage>>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GPUMeanImageFilter);

  using typename Superclass::OutputImageRegionType;
  using typename Superclass::OutputImagePixelType;

  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using InputImagePixelType = typename InputImageType::PixelType;

  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  itkGetOpenCLSourceFromKernelMacro(GPUMeanImageFilterKernel);
 
protected:
  GPUMeanImageFilter();
  ~GPUMeanImageFilter() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GPUGenerateData() override;
 
private:
  int m_MeanFilterGPUKernelHandle{};
};

class GPUMeanImageFilterFactory : public ObjectFactoryBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUMeanImageFilterFactory);
 
  using Self = GPUMeanImageFilterFactory;
  using Superclass = ObjectFactoryBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  const char *
  GetITKSourceVersion() const override
  {
    return ITK_SOURCE_VERSION;
  }
  const char *
  GetDescription() const override
  {
    return "A Factory for GPUMeanImageFilter";
  }


  itkFactorylessNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GPUMeanImageFilterFactory);

  static void
  RegisterOneFactory()
  {
    auto factory = GPUMeanImageFilterFactory::New();
 
    ObjectFactoryBase::RegisterFactory(factory);
  }
 
private:
#define OverrideMeanFilterTypeMacro(ipt, opt, dm)                                                             \
  {                                                                                                           \
    using InputImageType = Image<ipt, dm>;                                                                    \
    using OutputImageType = Image<opt, dm>;                                                                   \
    this->RegisterOverride(typeid(MeanImageFilter<InputImageType, OutputImageType>).name(),                   \
                           typeid(GPUMeanImageFilter<InputImageType, OutputImageType>).name(),                \
                           "GPU Mean Image Filter Override",                                                  \
                           true,                                                                              \
                           CreateObjectFunction<GPUMeanImageFilter<InputImageType, OutputImageType>>::New()); \
  }                                                                                                           \
  ITK_MACROEND_NOOP_STATEMENT
 
  GPUMeanImageFilterFactory()
  {
    if (IsGPUAvailable())
    {
      OverrideMeanFilterTypeMacro(unsigned char, unsigned char, 1);
      OverrideMeanFilterTypeMacro(char, char, 1);
      OverrideMeanFilterTypeMacro(float, float, 1);
      OverrideMeanFilterTypeMacro(int, int, 1);
      OverrideMeanFilterTypeMacro(unsigned int, unsigned int, 1);
      OverrideMeanFilterTypeMacro(double, double, 1);
 
      OverrideMeanFilterTypeMacro(unsigned char, unsigned char, 2);
      OverrideMeanFilterTypeMacro(char, char, 2);
      OverrideMeanFilterTypeMacro(float, float, 2);
      OverrideMeanFilterTypeMacro(int, int, 2);
      OverrideMeanFilterTypeMacro(unsigned int, unsigned int, 2);
      OverrideMeanFilterTypeMacro(double, double, 2);
 
      OverrideMeanFilterTypeMacro(unsigned char, unsigned char, 3);
      OverrideMeanFilterTypeMacro(char, char, 3);
      OverrideMeanFilterTypeMacro(float, float, 3);
      OverrideMeanFilterTypeMacro(int, int, 3);
      OverrideMeanFilterTypeMacro(unsigned int, unsigned int, 3);
      OverrideMeanFilterTypeMacro(double, double, 3);
    }
  }
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGPUMeanImageFilter.hxx"
#endif
 
#endif