itkGPUSmoothingRecursiveYvvGaussianImageFilter.h

Go to the documentation of this file.

/*=========================================================================
*
* Copyright Insight Software Consortium
*
* 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.
*
*=========================================================================*/

#ifdef GPU

#ifndef _ITK_GPU_SMOOTHING_RECURSIVE_YVV_GAUSSIAN_IMAGE_FILTER_H_
#define _ITK_GPU_SMOOTHING_RECURSIVE_YVV_GAUSSIAN_IMAGE_FILTER_H_

#include "itkImage.h"
#include "itkPixelTraits.h"
#include "itkCommand.h"
#include "itkFixedArray.h"
#include "itkSmoothingRecursiveYvvGaussianImageFilter.h"
#include "itkOpenCLUtil.h"
#include "itkGPUImageToImageFilter.h"

namespace itk
{
itkGPUKernelClassMacro(GPUSmoothingRecursiveYvvGaussianImageFilterKernel);

template< typename TInputImage, typename TOutputImage = TInputImage >
class ITK_EXPORT GPUSmoothingRecursiveYvvGaussianImageFilter:
  public         GPUImageToImageFilter< TInputImage, TOutputImage,
                                        SmoothingRecursiveYvvGaussianImageFilter< TInputImage, TOutputImage > >
{
public:
  typedef GPUSmoothingRecursiveYvvGaussianImageFilter Self;
  //typedef SmoothingRecursiveYvvGaussianImageFilter<TInputImage,TOutputImage>
  //   CPUSuperclass;
  typedef GPUImageToImageFilter< TInputImage, TOutputImage,
                                 SmoothingRecursiveYvvGaussianImageFilter< TInputImage, TOutputImage > > Superclass;
  typedef GPUImageToImageFilter< TInputImage, TOutputImage,
                                 SmoothingRecursiveYvvGaussianImageFilter< TInputImage, TOutputImage > > GPUSuperclass;
  typedef SmartPointer< Self >
                                                                                                         Pointer;
  typedef SmartPointer< const Self >
                                                                                                         ConstPointer;

  typedef TInputImage                     InputImageType;
  typedef TOutputImage                    OutputImageType;
  typedef typename TInputImage::PixelType PixelType;
        #ifdef WITH_DOUBLE
  typedef typename NumericTraits< PixelType >::RealType       RealType;
  typedef typename NumericTraits< PixelType >::ScalarRealType ScalarRealType;
        #else
  typedef typename NumericTraits< PixelType >::FloatType RealType;
  typedef typename NumericTraits< PixelType >::FloatType ScalarRealType;
        #endif

  typedef typename itk::GPUTraits< TInputImage >::Type  GPUInputImage;
  typedef typename itk::GPUTraits< TOutputImage >::Type GPUOutputImage;

  itkTypeMacro(GPUSmoothingRecursiveYvvGaussianImageFilter,
               GPUImageToImageFilter);

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

  typedef FixedArray< ScalarRealType,
                      itkGetStaticConstMacro(ImageDimension) > SigmaArrayType;

  typedef typename NumericTraits< PixelType >::FloatType InternalRealType;
  typedef GPUImage< InternalRealType,
                    itkGetStaticConstMacro(ImageDimension) >   RealImageType;

  typedef typename OutputImageType::Pointer OutputImagePointer;

  itkNewMacro(Self);

  void SetSigmaArray(const SigmaArrayType & sigmas);

  void SetSigma(ScalarRealType sigma);

  SigmaArrayType GetSigmaArray() const;

  ScalarRealType GetSigma() const;

  void SetNormalizeAcrossScale(bool normalizeInScaleSpace);

  itkGetConstMacro(NormalizeAcrossScale, bool);

  virtual void SetUp(ScalarRealType spacing);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( InputHasNumericTraitsCheck,
                   ( Concept::HasNumericTraits< PixelType > ) );

#endif

  itkGetOpenCLSourceFromKernelMacro(GPUSmoothingRecursiveYvvGaussianImageFilterKernel);
  void SetInput(const TInputImage *input);
  using Superclass::SetInput;
protected:
  GPUSmoothingRecursiveYvvGaussianImageFilter();
  virtual ~GPUSmoothingRecursiveYvvGaussianImageFilter() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  void GPUGenerateData(void);

  virtual void GenerateInputRequestedRegion() throw( InvalidRequestedRegionError );

  // Override since the filter produces the entire dataset
  void EnlargeOutputRequestedRegion(DataObject *output);

  void AllocateGPUCoefficients();

  std::ostringstream defines;

  ScalarRealType  m_B1;
  ScalarRealType  m_B2;
  ScalarRealType  m_B3;
  ScalarRealType  m_B;
  ScalarRealType *m_Bvalues;

  // Initialization matrix for anti-causal pass
  ScalarRealType *m_CPUMatrix;

  typedef GPUDataManager::Pointer GPUDataPointer;

  GPUDataPointer m_GPUMMatrixDataManager;
  GPUDataPointer m_GPUBCoefficientsDataManager;
  GPUDataPointer m_GPULocalDataManager;
private:
  GPUSmoothingRecursiveYvvGaussianImageFilter(const Self &);      //purposely
                                                                  // not
                                                                  // implemented
  void BuildKernel();

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

  bool m_NormalizeAcrossScale;

  int m_FilterGPUKernelHandle;
  typename GPUInputImage::Pointer inPtr;
  typename GPUOutputImage::Pointer otPtr;
  typename GPUOutputImage::SizeType m_requestedSize;
  SigmaArrayType m_Sigma;
  int            telltale; //TODO: REMOVE
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
    #include "itkGPUSmoothingRecursiveYvvGaussianImageFilter.hxx"
#endif

#endif //_ITK_GPU_SMOOTHING_RECURSIVE_YVV_GAUSSIAN_IMAGE_FILTER_H_
#endif    //GPU