#include <itkHilbertPath.h>

Inheritance diagram for itk::HilbertPath< TIndexValue, VDimension >:

Collaboration diagram for itk::HilbertPath< TIndexValue, VDimension >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef unsigned int	HilbertOrderType
typedef HilbertPathType::size_type	HilbertPathSizeType
typedef std::vector< IndexType >	HilbertPathType
typedef OutputType	IndexType
typedef Superclass::InputType	InputType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OutputType	OutputType
typedef InputType	PathIndexType
typedef SmartPointer< Self >	Pointer
typedef HilbertPath < TIndexValue, VDimension >	Self
typedef Path< unsigned int, Index< VDimension > , VDimension >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual InputType	EndOfInput () const
virtual OutputType	Evaluate (const PathIndexType &input) const
virtual InputType	EvaluateInverse (const IndexType &input)
virtual OutputType	EvaluateToIndex (const PathIndexType &input) const
virtual const char *	GetNameOfClass () const
virtual OffsetType	IncrementInput (InputType &) const
virtual HilbertPathSizeType	NumberOfSteps () const
PathIndexType	TransformMultiDimensionalIndexToPathIndex (const IndexType &index)
IndexType	TransformPathIndexToMultiDimensionalIndex (const PathIndexType id)

virtual void	Clear ()

virtual void	Initialize (void)

virtual void	SetHilbertOrder (HilbertOrderType _arg)
virtual HilbertOrderType	GetHilbertOrder () const
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	Dimension = VDimension
Protected Member Functions
	HilbertPath ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~HilbertPath ()
Private Member Functions
void	ConstructHilbertPath ()
PathIndexType	GetBitRange (const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType)
PathIndexType	GetDirection (const PathIndexType, const PathIndexType)
PathIndexType	GetEntry (const PathIndexType)
PathIndexType	GetGrayCode (const PathIndexType)
PathIndexType	GetInverseGrayCode (const PathIndexType)
PathIndexType	GetInverseTransform (const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType)
PathIndexType	GetLeftBitRotation (PathIndexType, PathIndexType, const PathIndexType)
PathIndexType	GetRightBitRotation (PathIndexType, PathIndexType, const PathIndexType)
PathIndexType	GetTrailingSetBits (const PathIndexType, const PathIndexType)
PathIndexType	GetTransform (const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType)
	HilbertPath (const Self &)
void	operator= (const Self &)
PathIndexType	SetBit (const PathIndexType, const PathIndexType, const PathIndexType, const PathIndexType)
Private Attributes
HilbertOrderType	m_HilbertOrder
HilbertPathType	m_HilbertPath

Detailed Description

template<class TIndexValue = unsigned int, unsigned int VDimension = 3>
class itk::HilbertPath< TIndexValue, VDimension >

Represent an n-dimensional Hilbert path for a given order.

This class is used to construct a Hilbert spacing-filling curve (or path) for a given order and given dimension. The locality- preserving properties make the Hilbert path an attractive option for mapping multi-dimensional data to a single array.

The path is defined by its dimensionality and order( >= 1 ) with its starting point at [0]^Dimension. The size of the path in each dimension is 2^order where each discrete location is visited by that path. For example, a 2-D Hilbert path of order 8 can map each pixel of a 256x256 image onto a single array. More properties and visualizations can be found in various places on the web.

The implementation is based on Chris Hamilton, "Compact Hilbert Indices", Technical Report CS-2006-07, July 24, 2006. and a direct porting of the Aldo Cortesi's python code found at https://github.com/cortesi/scurve

Author:: Nick Tustison

Definition at line 53 of file itkHilbertPath.h.