itkHigherOrderAccurateGradientImageFilter.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.
 *
 *=========================================================================*/
#ifndef itkHigherOrderAccurateGradientImageFilter_h
#define itkHigherOrderAccurateGradientImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkCovariantVector.h"

namespace itk
{

template< class TInputImage, class TOperatorValueType = float,
  class TOutputValueType = float >
class HigherOrderAccurateGradientImageFilter: public ImageToImageFilter< TInputImage,
  Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
{
public:
  itkStaticConstMacro(ImageDimension, unsigned int,
    TInputImage::ImageDimension);

  typedef HigherOrderAccurateGradientImageFilter Self;

  typedef TInputImage                      InputImageType;
  typedef typename InputImageType::Pointer InputImagePointer;
  typedef Image< CovariantVector<
                   TOutputValueType, itkGetStaticConstMacro(OutputImageDimension) >,
                 itkGetStaticConstMacro(OutputImageDimension) >
  OutputImageType;
  typedef typename OutputImageType::Pointer OutputImagePointer;

  typedef ImageToImageFilter< InputImageType, OutputImageType > Superclass;
  typedef SmartPointer< Self >                                  Pointer;
  typedef SmartPointer< const Self >                            ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(HigherOrderAccurateGradientImageFilter, ImageToImageFilter);

  typedef typename InputImageType::PixelType InputPixelType;
  typedef TOperatorValueType                 OperatorValueType;
  typedef TOutputValueType                   OutputValueType;
  typedef CovariantVector<
    OutputValueType, itkGetStaticConstMacro(OutputImageDimension) >
  OutputPixelType;
  typedef typename OutputImageType::RegionType OutputImageRegionType;

  itkSetMacro(UseImageSpacing, bool);
  itkGetConstMacro(UseImageSpacing, bool);
  itkBooleanMacro(UseImageSpacing);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( InputConvertibleToOutputCheck,
                  ( Concept::Convertible< InputPixelType, OutputValueType > ) );
  itkConceptMacro( OutputHasNumericTraitsCheck,
                  ( Concept::HasNumericTraits< OutputValueType > ) );

#endif

  itkSetMacro(UseImageDirection, bool);
  itkGetConstMacro(UseImageDirection, bool);
  itkBooleanMacro(UseImageDirection);

  itkSetMacro( OrderOfAccuracy, unsigned int );
  itkGetConstMacro( OrderOfAccuracy, unsigned int )

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

  virtual void GenerateInputRequestedRegion();

  virtual void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId) ITK_OVERRIDE;

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

  bool m_UseImageSpacing;

  // flag to take or not the image direction into account
  // when computing the derivatives.
  bool m_UseImageDirection;

  unsigned int m_OrderOfAccuracy;
};

} // end namespace itk

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

#endif