elxOpenCLFixedGenericPyramid.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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
 *
 *        http://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 elxOpenCLOpenCLFixedGenericPyramid_h
#define elxOpenCLOpenCLFixedGenericPyramid_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "elxFixedGenericPyramid.h"
#include "itkGPUImage.h"
 
namespace elastix
{

 
template <class TElastix>
class ITK_TEMPLATE_EXPORT OpenCLFixedGenericPyramid : public FixedGenericPyramid<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(OpenCLFixedGenericPyramid);

  using Self = OpenCLFixedGenericPyramid;
  using Superclass = FixedGenericPyramid<TElastix>;
  using Superclass1 = typename FixedGenericPyramid<TElastix>::Superclass1;
  using Superclass2 = typename FixedGenericPyramid<TElastix>::Superclass2;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  itkNewMacro(Self);

  itkTypeMacro(OpenCLFixedGenericPyramid, FixedGenericPyramid);

  elxClassNameMacro("OpenCLFixedGenericImagePyramid");

  itkStaticConstMacro(ImageDimension, unsigned int, Superclass1::ImageDimension);

  using typename Superclass1::InputImageType;
  using typename Superclass1::OutputImageType;
  using InputImagePixelType = typename Superclass1::InputImageType::PixelType;
  using OutputImagePixelType = typename Superclass1::OutputImageType::PixelType;

  using ObjectFactoryBasePointer = typename itk::ObjectFactoryBase::Pointer;

  using GPUInputImageType = itk::GPUImage<InputImagePixelType, InputImageType::ImageDimension>;
  using GPUInputImagePointer = typename GPUInputImageType::Pointer;
  using GPUOutputImageType = itk::GPUImage<OutputImagePixelType, OutputImageType::ImageDimension>;
 
  using GPUPyramidType = itk::GenericMultiResolutionPyramidImageFilter<GPUInputImageType, GPUOutputImageType, float>;
  using GPUPyramidPointer = typename GPUPyramidType::Pointer;

  void
  BeforeRegistration() override;

  virtual void
  ReadFromFile();
 
protected:
  void
  BeforeGenerateData();

  void
  GenerateData() override;

  OpenCLFixedGenericPyramid();
  ~OpenCLFixedGenericPyramid() override = default;
 
private:
  elxOverrideGetSelfMacro;

  void
  RegisterFactories();
 
  void
  UnregisterFactories();

  void
  SwitchingToCPUAndReport(const bool configError);

  void
  ReportToLog();
 
  GPUPyramidPointer                     m_GPUPyramid;
  bool                                  m_GPUPyramidReady;
  bool                                  m_GPUPyramidCreated;
  bool                                  m_ContextCreated;
  bool                                  m_UseOpenCL;
  std::vector<ObjectFactoryBasePointer> m_Factories;
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxOpenCLFixedGenericPyramid.hxx"
#endif
 
#endif // end #ifndef elxOpenCLOpenCLFixedGenericPyramid_h