Detailed Description

template<typename 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.

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 Types inherited from itk::Path< TIndexValue, Index< VDimension >, VDimension >
typedef SmartPointer< const Self >	ConstPointer

typedef Index< VDimension >	IndexType

typedef TIndexValue	InputType

typedef Offset< VDimension >	OffsetType

typedef Index< VDimension >	OutputType

typedef SmartPointer< Self >	Pointer

typedef Path	Self

typedef DataObject	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual InputType	EndOfInput () const override

virtual OutputType	Evaluate (const PathIndexType &input) const override

virtual InputType	EvaluateInverse (const IndexType &input)

virtual OutputType	EvaluateToIndex (const PathIndexType &input) const override

virtual const char *	GetNameOfClass () const

virtual OffsetType	IncrementInput (InputType &) const override

virtual HilbertPathSizeType	NumberOfSteps () const

PathIndexType	TransformMultiDimensionalIndexToPathIndex (const IndexType &index)

IndexType	TransformPathIndexToMultiDimensionalIndex (const PathIndexType id)


virtual void	Clear ()


virtual void	Initialize (void) override


virtual void	SetHilbertOrder (HilbertOrderType _arg)

virtual HilbertOrderType	GetHilbertOrder () const

Public Member Functions inherited from itk::Path< TIndexValue, Index< VDimension >, VDimension >
virtual OutputType	Evaluate (const InputType &input) const =0

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

virtual OffsetType	IncrementInput (InputType &input) const =0

virtual InputType	StartOfInput () const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	Dimension = VDimension

Static Public Attributes inherited from itk::Path< TIndexValue, Index< VDimension >, VDimension >
static const unsigned int	PathDimension

Protected Member Functions
	HilbertPath ()

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

	~HilbertPath ()

Protected Member Functions inherited from itk::Path< TIndexValue, Index< VDimension >, VDimension >
virtual IndexType	GetZeroIndex () const

virtual OffsetType	GetZeroOffset () const

	Path ()

	~Path ()

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)

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

Private Attributes
HilbertOrderType	m_HilbertOrder

HilbertPathType	m_HilbertPath