itkHilbertPath.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 __itkHilbertPath_h
#define __itkHilbertPath_h

#include "itkPath.h"

#include "itkNumericTraits.h"

namespace itk
{
template<class TIndexValue = unsigned int, unsigned int VDimension = 3>
class ITK_EXPORT HilbertPath
: public Path<TIndexValue, Index<VDimension>, VDimension>
{
public:

  typedef HilbertPath<TIndexValue, VDimension>               Self;
  typedef Path<unsigned int, Index<VDimension>, VDimension>  Superclass;
  typedef SmartPointer<Self>                                 Pointer;
  typedef SmartPointer<const Self>                           ConstPointer;

  itkTypeMacro( HilbertPath, Path );

  itkNewMacro( Self );

  itkStaticConstMacro( Dimension, unsigned int, VDimension );

  typedef typename Superclass::OutputType OutputType;
  typedef typename Superclass::InputType  InputType;

  typedef InputType                             PathIndexType;
  typedef OutputType                            IndexType;
  typedef unsigned int                          HilbertOrderType;
  typedef std::vector<IndexType>                HilbertPathType;
  typedef typename HilbertPathType::size_type   HilbertPathSizeType;
  typedef typename Superclass::OffsetType       OffsetType;

  // Functions inherited from Path

  virtual OutputType Evaluate( const PathIndexType & input ) const
    {
    return this->m_HilbertPath[input];
    }

  virtual OutputType EvaluateToIndex( const PathIndexType & input ) const
    {
    return this->m_HilbertPath[input];
    }

  virtual InputType EvaluateInverse( const IndexType & input )
    {
    return this->TransformMultiDimensionalIndexToPathIndex( input );
    }

  virtual inline InputType EndOfInput() const
    {
    return this->NumberOfSteps();  // 0 is before the first step, 1 is after it
    }

  virtual OffsetType IncrementInput( InputType & itkNotUsed( input ) ) const
    {
    itkExceptionMacro( "Not implemented." );
    }

  virtual inline void Clear()
    {
    this->m_HilbertPath.clear();
    this->Modified();
    }

  virtual inline HilbertPathSizeType NumberOfSteps() const
    {
    return m_HilbertPath.size();
    }

  virtual void Initialize( void )
    {
    this->Clear();
    this->ConstructHilbertPath();
    }

  itkSetClampMacro( HilbertOrder, HilbertOrderType, 1, NumericTraits<HilbertOrderType>::max() );
  itkGetConstMacro( HilbertOrder, HilbertOrderType );

  IndexType TransformPathIndexToMultiDimensionalIndex( const PathIndexType id );

  PathIndexType TransformMultiDimensionalIndexToPathIndex( const IndexType & index );

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

private:
  HilbertPath( const Self & );     //purposely not implemented
  void operator=( const Self & );  //purposely not implemented

  void ConstructHilbertPath();

  PathIndexType GetTransform( const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType );

  PathIndexType GetInverseTransform( const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType );

  PathIndexType GetGrayCode( const PathIndexType );

  PathIndexType GetInverseGrayCode( const PathIndexType );

  PathIndexType SetBit( const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType );

  PathIndexType GetRightBitRotation( PathIndexType, PathIndexType, const PathIndexType );

  PathIndexType GetLeftBitRotation( PathIndexType, PathIndexType, const PathIndexType );

  PathIndexType GetTrailingSetBits( const PathIndexType, const PathIndexType );

  PathIndexType GetDirection( const PathIndexType, const PathIndexType );

  PathIndexType GetEntry( const PathIndexType );

  PathIndexType GetBitRange( const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType );

  HilbertOrderType             m_HilbertOrder;
  HilbertPathType              m_HilbertPath;
};
} // end namespace itk

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

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

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

#endif