itkPath.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 __itkPath_h
#define __itkPath_h

#include "itkDataObject.h"
#include "itkIndex.h"
#include "itkNumericTraits.h"

namespace itk
{
template< class TInput, class TOutput, unsigned int VDimension >
class ITK_EXPORT Path: public DataObject
{
public:
  typedef Path                       Self;
  typedef DataObject                 Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkStaticConstMacro(PathDimension, unsigned int, VDimension);

  itkTypeMacro(Path, FunctionBase);

  typedef TInput InputType;

  typedef TOutput OutputType;

  typedef Index<  VDimension > IndexType;
  typedef Offset< VDimension > OffsetType;

  virtual inline InputType StartOfInput() const
  {
    return NumericTraits< InputType >::Zero;
  }

  virtual inline InputType EndOfInput() const
  {
    return NumericTraits< InputType >::One;
  }

  virtual OutputType Evaluate(const InputType & input) const = 0;

  virtual IndexType EvaluateToIndex(const InputType & input) const = 0;

  virtual OffsetType IncrementInput(InputType & input) const = 0;

protected:
  Path();
  ~Path(){}

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

  itkGetConstMacro(ZeroOffset, OffsetType);
  itkGetConstMacro(ZeroIndex, IndexType);
private:
  Path(const Self &);           //purposely not implemented
  void operator=(const Self &); //purposely not implemented

  // These "constants" are initialized in the constructor
  OffsetType m_ZeroOffset;  // = 0 for all dimensions
  IndexType  m_ZeroIndex;   // = 0 for all dimensions
};
} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_Path(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                        \
  {                                                    \
  _( 3 ( class EXPORT Path< ITK_TEMPLATE_3 TypeX > ) ) \
  namespace Templates                                  \
  {                                                    \
  typedef Path< ITK_TEMPLATE_3 TypeX > Path##TypeY;  \
  }                                                    \
  }

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

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

#endif