itkFastMarchingUpwindGradientImageFilterBase.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 itkFastMarchingUpwindGradientImageFilterBase_h
#define itkFastMarchingUpwindGradientImageFilterBase_h

#include "itkFastMarchingImageFilterBase.h"
#include "itkImage.h"

namespace itk
{
template< typename TInput, typename TOutput >
class FastMarchingUpwindGradientImageFilterBase:
  public FastMarchingImageFilterBase< TInput, TOutput >
{
public:
  typedef FastMarchingUpwindGradientImageFilterBase       Self;
  typedef FastMarchingImageFilterBase< TInput, TOutput >  Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;
  typedef typename Superclass::Traits                     Traits;

  itkNewMacro(Self);

  itkTypeMacro(FastMarchingUpwindGradientImageFilterBase,
               FastMarchingImageFilterBase);

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

  typedef typename Superclass::NodeType           NodeType;
  typedef typename Superclass::OutputImageType    OutputImageType;
  typedef typename Superclass::OutputPixelType    OutputPixelType;
  typedef typename Superclass::OutputSpacingType  OutputSpacingType;

  typedef CovariantVector< OutputPixelType,
                           ImageDimension > GradientPixelType;

  typedef Image< GradientPixelType,
                 ImageDimension > GradientImageType;

  typedef typename GradientImageType::Pointer GradientImagePointer;

  GradientImageType* GetGradientImage();

protected:
  FastMarchingUpwindGradientImageFilterBase();
  ~FastMarchingUpwindGradientImageFilterBase(){}

  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  virtual void InitializeOutput( OutputImageType* oImage ) ITK_OVERRIDE;

  virtual void UpdateNeighbors( OutputImageType* oImage,
                               const NodeType& iNode ) ITK_OVERRIDE;

  virtual void ComputeGradient(OutputImageType* oImage,
                               const NodeType& iNode );

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

/* this class was made in the case where isotropic and anisotropic fast
    marching would be implemented in this effort. As of now, we focus only
    in the isotropic case. Let's keep it for reference (just as a reminder).
*/
//template< unsigned int VDimension,
//         typename TInputPixel,
//         typename TOutputPixel >
//class IsotropicFastMarchingUpwindGradientImageFilterBase:
//    public FastMarchingUpwindGradientImageFilterBase< VDimension, TInputPixel,
//    TOutputPixel,
//    FastMarchingImageFilterBase< VDimension, TInputPixel, TOutputPixel >
//    >
//  {
//public:
//  typedef FastMarchingImageFilterBase< VDimension, TInputPixel,
//    TOutputPixel > GrandParentClassType;

//  typedef IsotropicFastMarchingUpwindGradientImageFilterBase             Self;
//  typedef FastMarchingUpwindGradientImageFilterBase< VDimension, TInputPixel,
//    TOutputPixel, GrandParentClassType > Superclass;
//  typedef SmartPointer< Self >                              Pointer;
//  typedef SmartPointer< const Self >                        ConstPointer;

//  itkNewMacro(Self);

//  itkTypeMacro(IsotropicFastMarchingUpwindGradientImageFilterBase,
//               FastMarchingUpwindGradientImageFilterBase );

//  itkStaticConstMacro(ImageDimension, unsigned int,
//                      Superclass::ImageDimension );

//  typedef typename Superclass::NodeType        NodeType;
//  typedef typename Superclass::OutputImageType OutputImageType;
//  typedef typename Superclass::OutputPixelType OutputPixelType;
//  typedef typename Superclass::OutputSpacingType OutputSpacingType;

//  typedef CovariantVector< OutputPixelType,
//                           ImageDimension > GradientPixelType;

//  typedef Image< GradientPixelType,
//                 ImageDimension > GradientImageType;

//  typedef typename GradientImageType::Pointer GradientImagePointer;

//protected:
//  IsotropicFastMarchingUpwindGradientImageFilterBase() : Superclass() {}
//  ~IsotropicFastMarchingUpwindGradientImageFilterBase() {}

//private:
//  void operator = ( const Self& );
//  IsotropicFastMarchingUpwindGradientImageFilterBase( const Self& );
//  };
} // namespace itk

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

#endif