ITK  4.1.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Private Attributes
itk::ContourExtractor2DImageFilter< TInputImage > Class Template Reference

#include <itkContourExtractor2DImageFilter.h>

+ Inheritance diagram for itk::ContourExtractor2DImageFilter< TInputImage >:
+ Collaboration diagram for itk::ContourExtractor2DImageFilter< TInputImage >:

List of all members.

Classes

class  ContourType
struct  VertexHash

Public Types

typedef SmartPointer< const SelfConstPointer
typedef InputImageType::Pointer InputImagePointer
typedef TInputImage InputImageType
typedef InputImageType::IndexType InputIndexType
typedef InputImageType::OffsetType InputOffsetType
typedef InputImageType::PixelType InputPixelType
typedef NumericTraits
< InputPixelType >::RealType 
InputRealType
typedef InputImageType::RegionType InputRegionType
typedef OutputPathType::Pointer OutputPathPointer
typedef PolyLineParametricPath< 2 > OutputPathType
typedef SmartPointer< SelfPointer
typedef
ContourExtractor2DImageFilter 
Self
typedef ImageToPathFilter
< InputImageType,
OutputPathType
Superclass
typedef
VertexListType::ConstPointer 
VertexListConstPointer
typedef
OutputPathType::VertexListType 
VertexListType
typedef OutputPathType::VertexType VertexType

Public Member Functions

void ClearRequestedRegion ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual const InputRegionTypeGetRequestedRegion ()
void SetRequestedRegion (const InputRegionType region)
 typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension), 2 >) DimensionShouldBe2
 typedef (Concept::Comparable< InputPixelType >) InputPixelTypeComparable
 typedef (Concept::HasPixelTraits< InputPixelType >) InputHasPixelTraitsCheck
 typedef (Concept::HasNumericTraits< InputPixelType >) InputHasNumericTraitsCheck
virtual void SetReverseContourOrientation (bool _arg)
virtual const bool & GetReverseContourOrientation ()
virtual void ReverseContourOrientationOn ()
virtual void ReverseContourOrientationOff ()
virtual void SetVertexConnectHighPixels (bool _arg)
virtual const bool & GetVertexConnectHighPixels ()
virtual void VertexConnectHighPixelsOn ()
virtual void VertexConnectHighPixelsOff ()
virtual void SetContourValue (InputRealType _arg)
virtual const InputRealTypeGetContourValue ()

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension

Protected Member Functions

 ContourExtractor2DImageFilter ()
void GenerateData ()
virtual void GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~ContourExtractor2DImageFilter ()

Private Types

typedef vcl_list< ContourTypeContourContainer
typedef ContourContainer::iterator ContourRef
typedef
VertexToContourMap::value_type 
VertexContourRefPair
typedef
VertexToContourMap::iterator 
VertexMapIterator
typedef itksys::hash_map
< VertexType, ContourRef,
VertexHash
VertexToContourMap

Private Member Functions

void AddSegment (const VertexType from, const VertexType to)
 ContourExtractor2DImageFilter (const Self &)
void FillOutputs ()
VertexType InterpolateContourPosition (InputPixelType fromValue, InputPixelType toValue, InputIndexType fromIndex, InputOffsetType toOffset)
void operator= (const Self &)

Private Attributes

VertexToContourMap m_ContourEnds
ContourContainer m_Contours
VertexToContourMap m_ContourStarts
InputRealType m_ContourValue
unsigned int m_NumberOfContoursCreated
InputRegionType m_RequestedRegion
bool m_ReverseContourOrientation
bool m_UseCustomRegion
bool m_VertexConnectHighPixels

Detailed Description

template<class TInputImage>
class itk::ContourExtractor2DImageFilter< TInputImage >

Computes a list of PolyLineParametricPath objects from the contours in a 2D image.

Uses the "marching squares" method to compute a the iso-valued contours of the input 2D image for a given intensity value. Multiple outputs may be produced because an image can have multiple contours at a given level, so it is advised to call GetNumberOfIndexedOutputs() and GetOutput(n) to retrieve all of the contours. The contour value to be extracted can be set with SetContourValue(). Image intensities will be linearly interpolated to provide sub-pixel resolution for the output contours.

The marching squares algorithm is a special case of the marching cubes algorithm (Lorensen, William and Harvey E. Cline. Marching Cubes: A High Resolution 3D Surface Construction Algorithm. Computer Graphics (SIGGRAPH 87 Proceedings) 21(4) July 1987, p. 163-170). A simple explanation is available here: http://users.polytech.unice.fr/~lingrand/MarchingCubes/algo.html

There is a single ambiguous case in the marching squares algorithm: if a given 2x2-pixel square has two high-valued and two low-valued pixels, each pair diagonally adjacent. (Where high- and low-valued is with respect to the contour value sought.) In this case, either the high-valued pixels can be connected into the same "object" (where groups of pixels encircled by a given contour are considered an object), or the low-valued pixels can be connected. This is the "face connected" versus "face + vertex connected" (or 4- versus 4-connected) distinction: high-valued pixels most be treated as one, and low-valued as the other. By default, high-valued pixels are treated as "face-connected" and low-valued pixels are treated as "face + vertex" connected. To reverse this, call VertexConnectHighPixelsOn();

Outputs are not guaranteed to be closed paths: contours which intersect the image edge will be left open. All other paths will be closed. (The closed-ness of a path can be tested by checking whether the beginning point is the same as the end point.)

Produced paths are oriented. Following the path from beginning to end, image intensity values lower than the contour value are to the left of the path and intensity values grater than the contour value are to the right. In other words, the image gradient at a path segment is (approximately) in the direct of that segment rotated right by 90 degrees, because the image intensity values increase from left-to-right across the segment. This means that the generated contours will circle clockwise around "hills" of above-contour-value intensity, and counter-clockwise around "depressions" of below-contour-value intensity. This convention can be reversed by calling ReverseContourOrientationOn().

By default the input image's largest possible region will be processed; call SetRequestedRegion() to process a different region, or ClearRequestedRegion() to revert to the default value. Note that the requested regions are usually set on the output; however since paths have no notion of a "region", this must be set at the filter level.

This class was contributed to the Insight Journal by Zachary Pincus. http://hdl.handle.net/1926/165

See also:
Image
Path
PolyLineParametricPath
Wiki Examples:

Definition at line 96 of file itkContourExtractor2DImageFilter.h.


Member Typedef Documentation

template<class TInputImage >
typedef SmartPointer< const Self > itk::ContourExtractor2DImageFilter< TInputImage >::ConstPointer
template<class TInputImage >
typedef vcl_list< ContourType > itk::ContourExtractor2DImageFilter< TInputImage >::ContourContainer [private]

Definition at line 234 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef ContourContainer::iterator itk::ContourExtractor2DImageFilter< TInputImage >::ContourRef [private]

Definition at line 235 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef InputImageType::Pointer itk::ContourExtractor2DImageFilter< TInputImage >::InputImagePointer

Image and path typedef support.

Reimplemented from itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >.

Definition at line 118 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef TInputImage itk::ContourExtractor2DImageFilter< TInputImage >::InputImageType

Convenient typedefs for simplifying declarations.

Reimplemented from itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >.

Definition at line 105 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef InputImageType::IndexType itk::ContourExtractor2DImageFilter< TInputImage >::InputIndexType

Definition at line 123 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef InputImageType::OffsetType itk::ContourExtractor2DImageFilter< TInputImage >::InputOffsetType

Definition at line 124 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef InputImageType::PixelType itk::ContourExtractor2DImageFilter< TInputImage >::InputPixelType

Definition at line 122 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef NumericTraits< InputPixelType >::RealType itk::ContourExtractor2DImageFilter< TInputImage >::InputRealType

Real type associated to the input pixel type.

Definition at line 131 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef InputImageType::RegionType itk::ContourExtractor2DImageFilter< TInputImage >::InputRegionType

Definition at line 125 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef PolyLineParametricPath< 2 > itk::ContourExtractor2DImageFilter< TInputImage >::OutputPathType

Some convenient typedefs.

Reimplemented from itk::PathSource< PolyLineParametricPath< 2 > >.

Definition at line 106 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef SmartPointer< Self > itk::ContourExtractor2DImageFilter< TInputImage >::Pointer
template<class TInputImage >
typedef ContourExtractor2DImageFilter itk::ContourExtractor2DImageFilter< TInputImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >.

Definition at line 109 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef VertexToContourMap::value_type itk::ContourExtractor2DImageFilter< TInputImage >::VertexContourRefPair [private]

Definition at line 283 of file itkContourExtractor2DImageFilter.h.

Definition at line 134 of file itkContourExtractor2DImageFilter.h.

Definition at line 128 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef VertexToContourMap::iterator itk::ContourExtractor2DImageFilter< TInputImage >::VertexMapIterator [private]

Definition at line 282 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
typedef itksys::hash_map< VertexType, ContourRef, VertexHash > itk::ContourExtractor2DImageFilter< TInputImage >::VertexToContourMap [private]

Definition at line 281 of file itkContourExtractor2DImageFilter.h.

Definition at line 127 of file itkContourExtractor2DImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage >
itk::ContourExtractor2DImageFilter< TInputImage >::ContourExtractor2DImageFilter ( ) [protected]

End concept checking

template<class TInputImage >
virtual itk::ContourExtractor2DImageFilter< TInputImage >::~ContourExtractor2DImageFilter ( ) [protected, virtual]
template<class TInputImage >
itk::ContourExtractor2DImageFilter< TInputImage >::ContourExtractor2DImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage >
void itk::ContourExtractor2DImageFilter< TInputImage >::AddSegment ( const VertexType  from,
const VertexType  to 
) [private]
template<class TInputImage >
void itk::ContourExtractor2DImageFilter< TInputImage >::ClearRequestedRegion ( )
template<class TInputImage >
virtual::itk::LightObject::Pointer itk::ContourExtractor2DImageFilter< TInputImage >::CreateAnother ( void  ) 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::PathSource< PolyLineParametricPath< 2 > >.

template<class TInputImage >
void itk::ContourExtractor2DImageFilter< TInputImage >::FillOutputs ( ) [private]
template<class TInputImage >
void itk::ContourExtractor2DImageFilter< TInputImage >::GenerateData ( void  ) [protected, virtual]

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<class TInputImage >
virtual void itk::ContourExtractor2DImageFilter< TInputImage >::GenerateInputRequestedRegion ( ) throw ( InvalidRequestedRegionError ) [protected, virtual]

ContourExtractor2DImageFilter manually controls the input requested region via SetRequestedRegion and ClearRequestedRegion, so it must override the superclass method.

Reimplemented from itk::ProcessObject.

template<class TInputImage >
virtual const InputRealType& itk::ContourExtractor2DImageFilter< TInputImage >::GetContourValue ( ) [virtual]

Set/Get the image intensity value that the contours should follow. This is the equivalent of an iso-value in Marching Squares.

template<class TInputImage >
virtual const char* itk::ContourExtractor2DImageFilter< TInputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >.

template<class TInputImage >
virtual const InputRegionType& itk::ContourExtractor2DImageFilter< TInputImage >::GetRequestedRegion ( ) [virtual]
template<class TInputImage >
virtual const bool& itk::ContourExtractor2DImageFilter< TInputImage >::GetReverseContourOrientation ( ) [virtual]

Control the orientation of the contours with reference to the image gradient. (See class documentation.)

template<class TInputImage >
virtual const bool& itk::ContourExtractor2DImageFilter< TInputImage >::GetVertexConnectHighPixels ( ) [virtual]

Control whether high- or low-valued pixels are vertex-connected. Default is for low-valued pixels to be vertex-connected. (See class documentation.)

template<class TInputImage >
VertexType itk::ContourExtractor2DImageFilter< TInputImage >::InterpolateContourPosition ( InputPixelType  fromValue,
InputPixelType  toValue,
InputIndexType  fromIndex,
InputOffsetType  toOffset 
) [private]
template<class TInputImage >
static Pointer itk::ContourExtractor2DImageFilter< TInputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::PathSource< PolyLineParametricPath< 2 > >.

template<class TInputImage >
void itk::ContourExtractor2DImageFilter< TInputImage >::operator= ( const Self ) [private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >.

template<class TInputImage >
void itk::ContourExtractor2DImageFilter< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >.

template<class TInputImage >
virtual void itk::ContourExtractor2DImageFilter< TInputImage >::ReverseContourOrientationOff ( ) [virtual]

Control the orientation of the contours with reference to the image gradient. (See class documentation.)

template<class TInputImage >
virtual void itk::ContourExtractor2DImageFilter< TInputImage >::ReverseContourOrientationOn ( ) [virtual]

Control the orientation of the contours with reference to the image gradient. (See class documentation.)

template<class TInputImage >
virtual void itk::ContourExtractor2DImageFilter< TInputImage >::SetContourValue ( InputRealType  _arg) [virtual]

Set/Get the image intensity value that the contours should follow. This is the equivalent of an iso-value in Marching Squares.

template<class TInputImage >
void itk::ContourExtractor2DImageFilter< TInputImage >::SetRequestedRegion ( const InputRegionType  region)

Control whether the largest possible input region is used, or if a custom requested region is to be used.

template<class TInputImage >
virtual void itk::ContourExtractor2DImageFilter< TInputImage >::SetReverseContourOrientation ( bool  _arg) [virtual]

Control the orientation of the contours with reference to the image gradient. (See class documentation.)

template<class TInputImage >
virtual void itk::ContourExtractor2DImageFilter< TInputImage >::SetVertexConnectHighPixels ( bool  _arg) [virtual]

Control whether high- or low-valued pixels are vertex-connected. Default is for low-valued pixels to be vertex-connected. (See class documentation.)

template<class TInputImage >
itk::ContourExtractor2DImageFilter< TInputImage >::typedef ( Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension), 2 >  )

Begin concept checking This class requires DimensionShouldBe2 in the form of ( Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension), 2 > )

template<class TInputImage >
itk::ContourExtractor2DImageFilter< TInputImage >::typedef ( Concept::Comparable< InputPixelType )

This class requires InputPixelTypeComparable in the form of ( Concept::Comparable< InputPixelType > )

template<class TInputImage >
itk::ContourExtractor2DImageFilter< TInputImage >::typedef ( Concept::HasPixelTraits< InputPixelType )

This class requires InputHasPixelTraitsCheck in the form of ( Concept::HasPixelTraits< InputPixelType > )

template<class TInputImage >
itk::ContourExtractor2DImageFilter< TInputImage >::typedef ( Concept::HasNumericTraits< InputPixelType )

This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< InputPixelType > )

template<class TInputImage >
virtual void itk::ContourExtractor2DImageFilter< TInputImage >::VertexConnectHighPixelsOff ( ) [virtual]

Control whether high- or low-valued pixels are vertex-connected. Default is for low-valued pixels to be vertex-connected. (See class documentation.)

template<class TInputImage >
virtual void itk::ContourExtractor2DImageFilter< TInputImage >::VertexConnectHighPixelsOn ( ) [virtual]

Control whether high- or low-valued pixels are vertex-connected. Default is for low-valued pixels to be vertex-connected. (See class documentation.)


Member Data Documentation

template<class TInputImage >
const unsigned int itk::ContourExtractor2DImageFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension [static]

Extract dimension from input and output image.

Reimplemented from itk::ImageToPathFilter< TInputImage, PolyLineParametricPath< 2 > >.

Definition at line 102 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
VertexToContourMap itk::ContourExtractor2DImageFilter< TInputImage >::m_ContourEnds [private]

Definition at line 290 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
ContourContainer itk::ContourExtractor2DImageFilter< TInputImage >::m_Contours [private]

Definition at line 286 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
VertexToContourMap itk::ContourExtractor2DImageFilter< TInputImage >::m_ContourStarts [private]

Definition at line 289 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
InputRealType itk::ContourExtractor2DImageFilter< TInputImage >::m_ContourValue [private]

Definition at line 203 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
unsigned int itk::ContourExtractor2DImageFilter< TInputImage >::m_NumberOfContoursCreated [private]

Definition at line 208 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
InputRegionType itk::ContourExtractor2DImageFilter< TInputImage >::m_RequestedRegion [private]

Definition at line 207 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
bool itk::ContourExtractor2DImageFilter< TInputImage >::m_ReverseContourOrientation [private]

Definition at line 204 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
bool itk::ContourExtractor2DImageFilter< TInputImage >::m_UseCustomRegion [private]

Definition at line 206 of file itkContourExtractor2DImageFilter.h.

template<class TInputImage >
bool itk::ContourExtractor2DImageFilter< TInputImage >::m_VertexConnectHighPixels [private]

Definition at line 205 of file itkContourExtractor2DImageFilter.h.


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