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
using	ConstPointer = SmartPointer< const Self >

using	HilbertOrderType = unsigned int

using	HilbertPathSizeType = typename HilbertPathType::size_type

using	HilbertPathType = std::vector< IndexType >

using	IndexType = OutputType

using	InputType = typename Superclass::InputType

using	OffsetType = typename Superclass::OffsetType

using	OutputType = typename Superclass::OutputType

using	PathIndexType = InputType

using	Pointer = SmartPointer< Self >

using	Self = HilbertPath< TIndexValue, VDimension >

using	Superclass = Path< unsigned int, Index< VDimension >, VDimension >

Public Types inherited from itk::Path< TIndexValue, Index< VDimension >, VDimension >
using	ConstPointer = SmartPointer< const Self >

using	IndexType = Index< VDimension >

using	InputType = TIndexValue

using	OffsetType = Offset< VDimension >

using	OutputType = Index< VDimension >

using	Pointer = SmartPointer< Self >

using	Self = Path

using	Superclass = DataObject

Public Types inherited from itk::DataObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector< Pointer >::size_type

using	Pointer = SmartPointer< Self >

using	Self = DataObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

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

InputType	EndOfInput () const override

OutputType	Evaluate (const PathIndexType &input) const override

virtual InputType	EvaluateInverse (const IndexType &input)

OutputType	EvaluateToIndex (const PathIndexType &input) const override

virtual const char *	GetNameOfClass () const

OffsetType	IncrementInput (InputType &) const override

virtual HilbertPathSizeType	NumberOfSteps () const

PathIndexType	TransformMultiDimensionalIndexToPathIndex (const IndexType &index)

IndexType	TransformPathIndexToMultiDimensionalIndex (const PathIndexType id)


virtual void	Clear ()


void	Initialize () 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

Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)

virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

virtual void	SetRequestedRegion (const DataObject *)

virtual void	SetRequestedRegionToLargestPossibleRegion ()

bool	ShouldIReleaseData () const

virtual void	Update ()

virtual void	UpdateOutputData ()

virtual void	UpdateOutputInformation ()

virtual bool	VerifyRequestedRegion ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	Dimension = VDimension

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

Protected Member Functions
	HilbertPath ()

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

	~HilbertPath () override=default

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

virtual OffsetType	GetZeroOffset () const

	Path ()

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

	~Path () override=default

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~DataObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

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 { 1 }

HilbertPathType	m_HilbertPath

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount