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 ITK_TEMPLATE_EXPORT FastMarchingUpwindGradientImageFilterBase:
  public FastMarchingImageFilterBase< TInput, TOutput >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(FastMarchingUpwindGradientImageFilterBase);

  using Self = FastMarchingUpwindGradientImageFilterBase;
  using Superclass = FastMarchingImageFilterBase< TInput, TOutput >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
  using Traits = typename Superclass::Traits;

  itkNewMacro(Self);

  itkTypeMacro(FastMarchingUpwindGradientImageFilterBase,
               FastMarchingImageFilterBase);

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using NodeType = typename Superclass::NodeType;
  using OutputImageType = typename Superclass::OutputImageType;
  using OutputPixelType = typename Superclass::OutputPixelType;
  using OutputSpacingType = typename Superclass::OutputSpacingType;

  using GradientPixelType = CovariantVector< OutputPixelType,
                           ImageDimension >;

  using GradientImageType = Image< GradientPixelType,
                 ImageDimension >;

  using GradientImagePointer = typename GradientImageType::Pointer;

  GradientImageType* GetGradientImage();

protected:
  FastMarchingUpwindGradientImageFilterBase();
  ~FastMarchingUpwindGradientImageFilterBase() override = default;

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

  void InitializeOutput( OutputImageType* oImage ) override;

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

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

/* 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:
//  using GrandParentClassType = FastMarchingImageFilterBase< VDimension, TInputPixel,
//    TOutputPixel >;

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

//  itkNewMacro(Self);

//  itkTypeMacro(IsotropicFastMarchingUpwindGradientImageFilterBase,
//               FastMarchingUpwindGradientImageFilterBase );

//  static constexpr unsigned int ImageDimension = //                      Superclass::ImageDimension;

//  using NodeType = typename Superclass::NodeType;
//  using OutputImageType = typename Superclass::OutputImageType;
//  using OutputPixelType = typename Superclass::OutputPixelType;
//  using OutputSpacingType = typename Superclass::OutputSpacingType;

//  using GradientPixelType = CovariantVector< OutputPixelType,
//                           ImageDimension >;

//  using GradientImageType = Image< GradientPixelType,
//                 ImageDimension >;

//  using GradientImagePointer = typename GradientImageType::Pointer;

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

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

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

#endif