itkParametricPath.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 __itkParametricPath_h
#define __itkParametricPath_h

#include "itkPath.h"
#include "itkContinuousIndex.h"
#include "itkOffset.h"
#include "itkVector.h"

namespace itk
{
template< unsigned int VDimension >
class ITK_EXPORT ParametricPath:public
  Path< double, ContinuousIndex< double, VDimension >, VDimension >
{
public:
  typedef ParametricPath                                                    Self;
  typedef Path< double, ContinuousIndex< double, VDimension >, VDimension > Superclass;
  typedef SmartPointer< Self >                                              Pointer;
  typedef SmartPointer< const Self >                                        ConstPointer;

  itkTypeMacro(ParametricPath, Path);

  typedef typename Superclass::InputType InputType;

  typedef typename Superclass::OutputType OutputType;

  typedef ContinuousIndex< double, VDimension > ContinuousIndexType;
  typedef Index<  VDimension >                  IndexType;
  typedef Offset< VDimension >                  OffsetType;
  typedef Vector< double, VDimension >          VectorType;

  virtual IndexType EvaluateToIndex(const InputType & input) const;

  virtual OffsetType IncrementInput(InputType & input) const;

  virtual VectorType EvaluateDerivative(const InputType & input) const;

  itkSetMacro(DefaultInputStepSize, InputType)
  itkGetConstReferenceMacro(DefaultInputStepSize, InputType)
protected:
  ParametricPath();
  ~ParametricPath(){}
  void PrintSelf(std::ostream & os, Indent indent) const;

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

} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ParametricPath(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                  \
  {                                                              \
  _( 1 ( class EXPORT ParametricPath< ITK_TEMPLATE_1 TypeX > ) ) \
  namespace Templates                                            \
  {                                                              \
  typedef ParametricPath< ITK_TEMPLATE_1 TypeX >                 \
  ParametricPath##TypeY;                                       \
  }                                                              \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkParametricPath+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkParametricPath.hxx"
#endif

#endif