itkSmoothingRecursiveYvvGaussianImageFilter.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.
*
*=========================================================================*/
#pragma once

#ifndef _ITK_SMOOTHING_RECURSIVE_YVV_GAUSSIAN_IMAGE_FILTER_H_
#define _ITK_SMOOTHING_RECURSIVE_YVV_GAUSSIAN_IMAGE_FILTER_H_

#include "itkRecursiveLineYvvGaussianImageFilter.h"
#include "itkCastImageFilter.h"
#include "itkImage.h"
#include "itkPixelTraits.h"
#include "itkCommand.h"
#include "itkFixedArray.h"

namespace itk
{
template< typename TInputImage,
          typename TOutputImage = TInputImage >
class ITK_EXPORT SmoothingRecursiveYvvGaussianImageFilter:
  public         InPlaceImageFilter< TInputImage, TOutputImage >
{
public:

  typedef SmoothingRecursiveYvvGaussianImageFilter        Self;
  typedef InPlaceImageFilter< TInputImage, TOutputImage > Superclass;
  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

  itkTypeMacro(SmoothingRecursiveYvvGaussianImageFilter,
               InPlaceImageFilter);

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

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

  typedef typename NumericTraits< PixelType >::FloatType                     InternalRealType;
  typedef typename InputImageType::template Rebind< InternalRealType >::Type RealImageType;

  typedef RecursiveLineYvvGaussianImageFilter<
      InputImageType,
      RealImageType
      >    FirstGaussianFilterType;

  typedef RecursiveLineYvvGaussianImageFilter<
      RealImageType,
      RealImageType
      >    InternalGaussianFilterType;

  typedef CastImageFilter<
      RealImageType,
      OutputImageType
      >    CastingFilterType;

  typedef typename InternalGaussianFilterType::Pointer InternalGaussianFilterPointer;

  typedef typename FirstGaussianFilterType::Pointer FirstGaussianFilterPointer;

  typedef typename CastingFilterType::Pointer CastingFilterPointer;

  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);

  void SetNumberOfThreads(ThreadIdType nb);

  // See super class for doxygen documentation
  //
  virtual bool CanRunInPlace(void) const;

#ifdef ITK_USE_CONCEPT_CHECKING

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

#endif
protected:
  SmoothingRecursiveYvvGaussianImageFilter();
  virtual ~SmoothingRecursiveYvvGaussianImageFilter() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  void GenerateData(void);

  virtual void GenerateInputRequestedRegion() throw( InvalidRequestedRegionError );

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

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

  InternalGaussianFilterPointer m_SmoothingFilters[ImageDimension - 1];
  FirstGaussianFilterPointer    m_FirstSmoothingFilter;
  CastingFilterPointer          m_CastingFilter;

  bool m_NormalizeAcrossScale;

  SigmaArrayType m_Sigma;
  int            telltale; //TODO: REMOVE
};
} // end namespace itk

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

#endif