NifTK  16.4.1 - 0798f20
CMIC's Translational Medical Imaging Platform
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::NormaliseVectorFilter< TScalarType, NDimensions > Class Template Reference

This class takes a vector field and normalises each vector to unit length. More...

Inheritance diagram for itk::NormaliseVectorFilter< TScalarType, NDimensions >:
Inheritance graph
[legend]
Collaboration diagram for itk::NormaliseVectorFilter< TScalarType, NDimensions >:
Collaboration graph
[legend]

Public Types

typedef NormaliseVectorFilter Self
 
typedef ImageToImageFilter
< Image< Vector< TScalarType,
NDimensions >, NDimensions >
, Image< Vector< TScalarType,
NDimensions >, NDimensions > > 
Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef Vector< TScalarType,
NDimensions > 
InputPixelType
 
typedef Image< InputPixelType,
NDimensions > 
InputImageType
 
typedef Image< TScalarType,
NDimensions > 
InputScalarImageType
 
typedef InputImageType::IndexType InputImageIndexType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputPixelType OutputPixelType
 
typedef InputImageType OutputImageType
 

Public Member Functions

virtual const char * GetClassName () const
 
 itkStaticConstMacro (Dimension, unsigned int, NDimensions)
 
virtual void SetNormalise (bool _arg)
 
virtual bool GetNormalise ()
 
virtual void SetLengthTolerance (double _arg)
 
virtual double GetLengthTolerance ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 NormaliseVectorFilter ()
 
 ~NormaliseVectorFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void ThreadedGenerateData (const InputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 

Detailed Description

template<typename TScalarType, unsigned int NDimensions = 3>
class itk::NormaliseVectorFilter< TScalarType, NDimensions >

This class takes a vector field and normalises each vector to unit length.

Member Typedef Documentation

template<typename TScalarType , unsigned int NDimensions = 3>
typedef SmartPointer<const Self> itk::NormaliseVectorFilter< TScalarType, NDimensions >::ConstPointer
template<typename TScalarType , unsigned int NDimensions = 3>
typedef InputImageType::IndexType itk::NormaliseVectorFilter< TScalarType, NDimensions >::InputImageIndexType
template<typename TScalarType , unsigned int NDimensions = 3>
typedef InputImageType::RegionType itk::NormaliseVectorFilter< TScalarType, NDimensions >::InputImageRegionType
template<typename TScalarType , unsigned int NDimensions = 3>
typedef Image< InputPixelType, NDimensions > itk::NormaliseVectorFilter< TScalarType, NDimensions >::InputImageType
template<typename TScalarType , unsigned int NDimensions = 3>
typedef Vector< TScalarType, NDimensions > itk::NormaliseVectorFilter< TScalarType, NDimensions >::InputPixelType

Standard typedefs.

template<typename TScalarType , unsigned int NDimensions = 3>
typedef Image< TScalarType, NDimensions > itk::NormaliseVectorFilter< TScalarType, NDimensions >::InputScalarImageType
template<typename TScalarType , unsigned int NDimensions = 3>
typedef InputImageType itk::NormaliseVectorFilter< TScalarType, NDimensions >::OutputImageType
template<typename TScalarType , unsigned int NDimensions = 3>
typedef InputPixelType itk::NormaliseVectorFilter< TScalarType, NDimensions >::OutputPixelType
template<typename TScalarType , unsigned int NDimensions = 3>
typedef SmartPointer<Self> itk::NormaliseVectorFilter< TScalarType, NDimensions >::Pointer
template<typename TScalarType , unsigned int NDimensions = 3>
typedef NormaliseVectorFilter itk::NormaliseVectorFilter< TScalarType, NDimensions >::Self

Standard "Self" typedef.

template<typename TScalarType , unsigned int NDimensions = 3>
typedef ImageToImageFilter<Image< Vector<TScalarType, NDimensions>, NDimensions>, Image< Vector<TScalarType, NDimensions>, NDimensions> > itk::NormaliseVectorFilter< TScalarType, NDimensions >::Superclass

Constructor & Destructor Documentation

template<typename TScalarType , unsigned int NDimensions = 3>
itk::NormaliseVectorFilter< TScalarType, NDimensions >::NormaliseVectorFilter ( )
protected
template<typename TScalarType , unsigned int NDimensions = 3>
itk::NormaliseVectorFilter< TScalarType, NDimensions >::~NormaliseVectorFilter ( )
inlineprotected

Member Function Documentation

template<typename TScalarType , unsigned int NDimensions = 3>
virtual const char* itk::NormaliseVectorFilter< TScalarType, NDimensions >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

template<typename TScalarType , unsigned int NDimensions = 3>
virtual double itk::NormaliseVectorFilter< TScalarType, NDimensions >::GetLengthTolerance ( )
virtual
template<typename TScalarType , unsigned int NDimensions = 3>
virtual bool itk::NormaliseVectorFilter< TScalarType, NDimensions >::GetNormalise ( )
virtual
template<typename TScalarType , unsigned int NDimensions = 3>
itk::NormaliseVectorFilter< TScalarType, NDimensions >::itkStaticConstMacro ( Dimension  ,
unsigned  int,
NDimensions   
)

Get the number of dimensions we are working in.

template<typename TScalarType , unsigned int NDimensions = 3>
static Pointer itk::NormaliseVectorFilter< TScalarType, NDimensions >::New ( )
static

Method for creation through the object factory.

template<typename TScalarType , unsigned int NDimensions = 3>
void itk::NormaliseVectorFilter< TScalarType, NDimensions >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protected
template<typename TScalarType , unsigned int NDimensions = 3>
virtual void itk::NormaliseVectorFilter< TScalarType, NDimensions >::SetLengthTolerance ( double  _arg)
virtual

Set/Get the tolerance of the length. If the length of a vector is less than this tolerance, we just set the output to zero.

template<typename TScalarType , unsigned int NDimensions = 3>
virtual void itk::NormaliseVectorFilter< TScalarType, NDimensions >::SetNormalise ( bool  _arg)
virtual

Set/Get the normalise flag. If off/false, then filter simply passess vectors through. Default true.

template<typename TScalarType , unsigned int NDimensions = 3>
virtual void itk::NormaliseVectorFilter< TScalarType, NDimensions >::ThreadedGenerateData ( const InputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
protectedvirtual

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