itkNormalVectorFunctionBase.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 itkNormalVectorFunctionBase_h
#define itkNormalVectorFunctionBase_h

#include "itkFiniteDifferenceSparseImageFunction.h"

namespace itk
{
template< typename TSparseImageType >
class ITK_TEMPLATE_EXPORT NormalVectorFunctionBase:
  public FiniteDifferenceSparseImageFunction< TSparseImageType >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(NormalVectorFunctionBase);

  using Self = NormalVectorFunctionBase;
  using Superclass = FiniteDifferenceSparseImageFunction< TSparseImageType >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(NormalVectorFunctionBase, FiniteDifferenceSparseImageFunction);

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using TimeStepType = typename Superclass::TimeStepType;
  using RadiusType = typename Superclass::RadiusType;
  using NeighborhoodType = typename Superclass::NeighborhoodType;
  using FloatOffsetType = typename Superclass::FloatOffsetType;
  using IndexType = typename Superclass::IndexType;
  using SparseImageType = typename Superclass::SparseImageType;

  using NodeType = typename SparseImageType::NodeType;

  using NodeValueType = typename NodeType::NodeValueType;

  using NormalVectorType = typename NodeType::NodeDataType;

  void * GetGlobalDataPointer() const override { return nullptr; }
  void ReleaseGlobalDataPointer(void *) const override {}

  TimeStepType ComputeGlobalTimeStep(void *) const override
  { return m_TimeStep; }

  void SetTimeStep(const TimeStepType & ts)
  { m_TimeStep = ts; }

  TimeStepType GetTimeStep() const
  { return m_TimeStep; }

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

private:
  TimeStepType m_TimeStep;

};
} // end namespace itk

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

#endif