ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::ChainCodePath< VDimension > Class Template Reference

#include <itkChainCodePath.h>

+ Inheritance diagram for itk::ChainCodePath< VDimension >:
+ Collaboration diagram for itk::ChainCodePath< VDimension >:

Detailed Description

template<unsigned int VDimension>
class itk::ChainCodePath< VDimension >

Represent a path as a sequence of connected image index offsets.

This class is intended to represent sequences of connected indices in an image. It does so by storing the offset of each index from its immediately preceding, connected, index. The only image index stored directly is that of the first index. ChainCodePath maps a 1D integer input (step number) to an ND integer output (either an offset or an image index, depending on whether Evaluate or EvaluateToIndex is called).

See Also
ChainCodePath2D
ParametricPath
Path
Index
Offset

Definition at line 49 of file itkChainCodePath.h.

Public Types

typedef ChainCodeType::size_type ChainCodeSizeType
 
typedef std::vector< OffsetTypeChainCodeType
 
typedef SmartPointer< const SelfConstPointer
 
typedef Index< VDimension > IndexType
 
typedef Superclass::InputType InputType
 
typedef OutputType OffsetType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef ChainCodePath< VDimension > Self
 
typedef Path< unsigned int,
Offset< VDimension >
, VDimension > 
Superclass
 
- Public Types inherited from itk::Path< unsigned int, Offset< VDimension >, VDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef Index< VDimension > IndexType
 
typedef unsigned int InputType
 
typedef Offset< VDimension > OffsetType
 
typedef Offset< VDimension > OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Path Self
 
typedef DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual InputType EndOfInput () const override
 
virtual OutputType Evaluate (const InputType &input) const override
 
virtual IndexType EvaluateToIndex (const InputType &input) const override
 
virtual const char * GetNameOfClass () const
 
virtual OffsetType IncrementInput (InputType &input) const override
 
virtual ChainCodeSizeType NumberOfSteps () const
 
virtual void SetStart (IndexType _arg)
 
virtual const IndexTypeGetStart () const
 
virtual void InsertStep (InputType position, OffsetType step)
 
virtual void ChangeStep (InputType position, OffsetType step)
 
virtual void Clear ()
 
virtual void Initialize (void) override
 
- Public Member Functions inherited from itk::Path< unsigned int, Offset< 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
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () 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 ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 const unsigned int Dimension = VDimension
 
- Static Public Attributes inherited from itk::Path< unsigned int, Offset< VDimension >, VDimension >
static const unsigned int PathDimension
 

Protected Member Functions

 ChainCodePath ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ChainCodePath () override
 
- Protected Member Functions inherited from itk::Path< unsigned int, Offset< VDimension >, VDimension >
virtual IndexType GetZeroIndex () const
 
virtual OffsetType GetZeroOffset () const
 
 Path ()
 
 ~Path () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
virtual ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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 Attributes

ChainCodeType m_Chain
 
IndexType m_Start
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<unsigned int VDimension>
typedef ChainCodeType::size_type itk::ChainCodePath< VDimension >::ChainCodeSizeType

Definition at line 76 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef std::vector< OffsetType > itk::ChainCodePath< VDimension >::ChainCodeType

Definition at line 74 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef SmartPointer< const Self > itk::ChainCodePath< VDimension >::ConstPointer

Definition at line 61 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef Index< VDimension > itk::ChainCodePath< VDimension >::IndexType

Definition at line 72 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef Superclass::InputType itk::ChainCodePath< VDimension >::InputType

Definition at line 68 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef OutputType itk::ChainCodePath< VDimension >::OffsetType

The output type of this function is an Index

Definition at line 71 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef Superclass::OutputType itk::ChainCodePath< VDimension >::OutputType

OutputType typedef support.

Definition at line 64 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef SmartPointer< Self > itk::ChainCodePath< VDimension >::Pointer

Definition at line 60 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef ChainCodePath< VDimension > itk::ChainCodePath< VDimension >::Self

Standard class typedefs.

Definition at line 57 of file itkChainCodePath.h.

template<unsigned int VDimension>
typedef Path< unsigned int, Offset< VDimension >, VDimension > itk::ChainCodePath< VDimension >::Superclass

Definition at line 58 of file itkChainCodePath.h.

Constructor & Destructor Documentation

template<unsigned int VDimension>
itk::ChainCodePath< VDimension >::ChainCodePath ( )
protected
template<unsigned int VDimension>
itk::ChainCodePath< VDimension >::~ChainCodePath ( )
inlineoverrideprotected

Definition at line 149 of file itkChainCodePath.h.

Member Function Documentation

template<unsigned int VDimension>
virtual void itk::ChainCodePath< VDimension >::ChangeStep ( InputType  position,
OffsetType  step 
)
inlinevirtual

Change the direction of a step in the chaincode

Reimplemented in itk::ChainCodePath2D.

Definition at line 118 of file itkChainCodePath.h.

template<unsigned int VDimension>
virtual void itk::ChainCodePath< VDimension >::Clear ( void  )
inlinevirtual

Remove all steps from the chain code

Reimplemented in itk::ChainCodePath2D.

Definition at line 126 of file itkChainCodePath.h.

template<unsigned int VDimension>
virtual::itk::LightObject::Pointer itk::ChainCodePath< VDimension >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<unsigned int VDimension>
virtual InputType itk::ChainCodePath< VDimension >::EndOfInput ( ) const
inlineoverridevirtual

Where does the path end (what is the last valid input value)?

Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >.

Definition at line 96 of file itkChainCodePath.h.

template<unsigned int VDimension>
virtual OutputType itk::ChainCodePath< VDimension >::Evaluate ( const InputType input) const
inlineoverridevirtual

Evaluate the chaincode for the offset at the specified path-position.

Reimplemented in itk::ChainCodePath2D.

Definition at line 81 of file itkChainCodePath.h.

template<unsigned int VDimension>
virtual IndexType itk::ChainCodePath< VDimension >::EvaluateToIndex ( const InputType input) const
overridevirtual

Like Evaluate(), but returns the index at the specified path-position.

Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension>
virtual const char* itk::ChainCodePath< VDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >.

Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension>
virtual const IndexType& itk::ChainCodePath< VDimension >::GetStart ( ) const
virtual

Set/Get the index associated with the initial position of the path

template<unsigned int VDimension>
virtual OffsetType itk::ChainCodePath< VDimension >::IncrementInput ( InputType input) const
overridevirtual

Increment the input variable passed by reference and then return the offset stored at the new path-position. If the chaincode is unable to be incremented, input is not changed and an offset of zero is returned, which may be used to check for the end of the chain code.

Reimplemented in itk::ChainCodePath2D.

template<unsigned int VDimension>
virtual void itk::ChainCodePath< VDimension >::Initialize ( void  )
inlineoverridevirtual

Needed for Pipelining

Reimplemented from itk::DataObject.

Definition at line 140 of file itkChainCodePath.h.

template<unsigned int VDimension>
virtual void itk::ChainCodePath< VDimension >::InsertStep ( InputType  position,
OffsetType  step 
)
inlinevirtual

Insert a new step into the chaincode at a specified position

Reimplemented in itk::ChainCodePath2D.

Definition at line 110 of file itkChainCodePath.h.

template<unsigned int VDimension>
static Pointer itk::ChainCodePath< VDimension >::New ( )
static

New() method for dynamic construction

template<unsigned int VDimension>
virtual ChainCodeSizeType itk::ChainCodePath< VDimension >::NumberOfSteps ( ) const
inlinevirtual

How many steps in the chaincode?

Reimplemented in itk::ChainCodePath2D.

Definition at line 134 of file itkChainCodePath.h.

template<unsigned int VDimension>
void itk::ChainCodePath< VDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Path< unsigned int, Offset< VDimension >, VDimension >.

template<unsigned int VDimension>
virtual void itk::ChainCodePath< VDimension >::SetStart ( IndexType  _arg)
virtual

Set/Get the index associated with the initial position of the path

Member Data Documentation

template<unsigned int VDimension>
const unsigned int itk::ChainCodePath< VDimension >::Dimension = VDimension
static

Dimension underlying input image.

Definition at line 54 of file itkChainCodePath.h.

template<unsigned int VDimension>
ChainCodeType itk::ChainCodePath< VDimension >::m_Chain
private

Definition at line 156 of file itkChainCodePath.h.

template<unsigned int VDimension>
IndexType itk::ChainCodePath< VDimension >::m_Start
private

Definition at line 153 of file itkChainCodePath.h.


The documentation for this class was generated from the following file: