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< class TSparseImageType >
class ITK_EXPORT NormalVectorFunctionBase:
  public FiniteDifferenceSparseImageFunction< TSparseImageType >
{
public:
  typedef NormalVectorFunctionBase                                Self;
  typedef FiniteDifferenceSparseImageFunction< TSparseImageType > Superclass;
  typedef SmartPointer< Self >                                    Pointer;
  typedef SmartPointer< const Self >                              ConstPointer;

  itkTypeMacro(NormalVectorFunctionBase, FiniteDifferenceSparseImageFunction);

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

  typedef typename Superclass::TimeStepType     TimeStepType;
  typedef typename Superclass::RadiusType       RadiusType;
  typedef typename Superclass::NeighborhoodType NeighborhoodType;
  typedef typename Superclass::FloatOffsetType  FloatOffsetType;
  typedef typename Superclass::IndexType        IndexType;
  typedef typename Superclass::SparseImageType  SparseImageType;

  typedef typename SparseImageType::NodeType NodeType;

  typedef typename NodeType::NodeValueType NodeValueType;

  typedef typename NodeType::NodeDataType NormalVectorType;

  virtual void * GetGlobalDataPointer() const { return 0; }
  virtual void ReleaseGlobalDataPointer(void *) const {}

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

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

  TimeStepType GetTimeStep() const
  { return m_TimeStep; }

protected:
  NormalVectorFunctionBase();
  ~NormalVectorFunctionBase() {}
  virtual void PrintSelf(std::ostream & os, Indent indent) const;

private:
  TimeStepType m_TimeStep;

  NormalVectorFunctionBase(const Self &); //purposely not implemented
  void operator=(const Self &);           //purposely not implemented
};
} // end namespace itk

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

#endif