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< typename TInputImage, typename TOperatorValueType = float,
  class TOutputValueType = float >
class HigherOrderAccurateGradientImageFilter: public ImageToImageFilter< TInputImage,
  Image< CovariantVector< TOutputValueType, TInputImage::ImageDimension >, TInputImage::ImageDimension > >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(HigherOrderAccurateGradientImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using Self = HigherOrderAccurateGradientImageFilter;

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

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

  itkNewMacro(Self);

  itkTypeMacro(HigherOrderAccurateGradientImageFilter, ImageToImageFilter);

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

  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();
  ~HigherOrderAccurateGradientImageFilter() override {}
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void GenerateInputRequestedRegion() override;

  void DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;

private:
  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