itkImplicitManifoldNormalVectorFilter.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 itkImplicitManifoldNormalVectorFilter_h
#define itkImplicitManifoldNormalVectorFilter_h

#include "itkConstNeighborhoodIterator.h"
#include "itkNormalVectorFunctionBase.h"
#include "itkFiniteDifferenceSparseImageFilter.h"
#include "itkVector.h"

namespace itk
{
template< typename TInputImage, typename TSparseOutputImage >
class ITK_TEMPLATE_EXPORT ImplicitManifoldNormalVectorFilter:
  public FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImplicitManifoldNormalVectorFilter);

  using Self = ImplicitManifoldNormalVectorFilter;
  using Superclass = FiniteDifferenceSparseImageFilter<
    TInputImage,
    TSparseOutputImage >;

  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(ImplicitManifoldNormalVectorFilter,
               FiniteDifferenceSparseImageFilter);

  itkNewMacro(Self);

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using InputImageType = typename Superclass::InputImageType;
  using IndexType = typename Superclass::IndexType;
  using NormalVectorType = typename Superclass::NodeDataType;
  using NodeValueType = typename Superclass::NodeValueType;
  using FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType;

  using SparseOutputImageType = typename Superclass::SparseOutputImageType;
  using NormalBandNodeType = typename Superclass::OutputNodeType;
  using NodeListType = typename Superclass::NodeListType;

  using InputImageIteratorType = ConstNeighborhoodIterator< InputImageType >;

  using NormalFunctionType = NormalVectorFunctionBase< SparseOutputImageType >;

  using RadiusType = typename FiniteDifferenceFunctionType::RadiusType;

  void SetNormalFunction(NormalFunctionType *nf);

  itkSetMacro(MaxIteration, unsigned int);
  itkGetConstMacro(MaxIteration, unsigned int);
  itkSetMacro(IsoLevelLow,  NodeValueType);
  itkGetConstMacro(IsoLevelLow,  NodeValueType);
  itkSetMacro(IsoLevelHigh, NodeValueType);
  itkGetConstMacro(IsoLevelHigh, NodeValueType);
  itkSetMacro(MinVectorNorm, NodeValueType);
  itkGetConstMacro(MinVectorNorm, NodeValueType);
  itkSetMacro(UnsharpMaskingFlag, bool);
  itkGetConstMacro(UnsharpMaskingFlag, bool);
  itkSetMacro(UnsharpMaskingWeight, NodeValueType);
  itkGetConstMacro(UnsharpMaskingWeight, NodeValueType);

protected:
  ImplicitManifoldNormalVectorFilter();
  ~ImplicitManifoldNormalVectorFilter() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void Initialize() override;

  void SetNormalBand();

  void InitializeNormalBandNode(NormalBandNodeType *node,
                                const InputImageIteratorType & it);

  void CopyInputToOutput() override {}

  bool Halt() override
  {
    if ( this->GetElapsedIterations() == m_MaxIteration )
      {
      return true;
      }
    else
      {
      return false;
      }
  }

protected:
  NormalVectorType DataConstraint(const NormalVectorType & data) const override
  {
    return ( data / ( m_MinVectorNorm + data.GetNorm() ) );
  }

  void PostProcessOutput() override;

private:
  NormalFunctionType *m_NormalFunction;

  unsigned int m_MaxIteration;

  NodeValueType m_IsoLevelLow, m_IsoLevelHigh;

  NodeValueType m_MinVectorNorm;

  bool m_UnsharpMaskingFlag;

  NodeValueType m_UnsharpMaskingWeight;

  unsigned long m_Indicator[Self::ImageDimension];
  unsigned int  m_NumVertex;
  NodeValueType m_DimConst;
  NodeValueType m_DimConst2;
  RadiusType    m_ManifoldRadius;
};
} // end namespace itk

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

#endif