ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Attributes | List of all members
itk::AnnulusOperator< TPixel, TDimension, TAllocator > Class Template Reference

#include <itkAnnulusOperator.h>

+ Inheritance diagram for itk::AnnulusOperator< TPixel, TDimension, TAllocator >:
+ Collaboration diagram for itk::AnnulusOperator< TPixel, TDimension, TAllocator >:

Detailed Description

template<class TPixel, unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
class itk::AnnulusOperator< TPixel, TDimension, TAllocator >

A NeighborhoodOperator for performing a matched filtering with an annulus (two concentric circles, spheres, hyperspheres, etc.)

AnnulusOperator defines a non-directional NeighborhoodOperator representing two concentric circles, spheres, hyperspheres, etc. The inner radius and the thickness of the annulus can be specified.

The values for the annulus can be specified in a variety of manners:

1) The values for the interior of the annulus (interior of inner circle), the values for annulus (the region between the inner and outer circle), and the values for the exterior of the annulus can be specified. This mode is useful in correlation based matched filter applications. For instance, defining a hollow (or even filled) circle.

2) The values can defined automatically for normalized correlation. The values in the kernel will be defined to have mean zero and norm 1. The area outside the annulus will have values of zero. In this mode, you can also specify whether you want the center of the annulus to be bright (intensity > 0) or dark (intensity < 0).

1) Set the annulus parameters: InnerRadius and Thickness 2) Set the intensities to use for interior, wall, and exterior kernel positions for correlation based operations or call NormalizeOn() to define kernel values automatically for use in normalized correlation. 3) If NormalizedOn(), indicate whether you want the center of the annulus to be bright or dark. 4) call CreateOperator()

See Also
NeighborhoodOperator
Neighborhood

Definition at line 70 of file itkAnnulusOperator.h.

Public Types

typedef Superclass::OffsetType OffsetType
 
typedef AnnulusOperator Self
 
typedef Superclass::SizeType SizeType
 
typedef Vector< double,
TDimension > 
SpacingType
 
typedef NeighborhoodOperator
< TPixel, TDimension,
TAllocator > 
Superclass
 
- Public Types inherited from itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >
typedef NumericTraits< TPixel >
::RealType 
PixelRealType
 
typedef TPixel PixelType
 
typedef NeighborhoodOperator Self
 
typedef Superclass::SizeType SizeType
 
typedef SliceIterator< TPixel,
Self
SliceIteratorType
 
typedef Neighborhood< TPixel,
VDimension, TAllocator > 
Superclass
 
- Public Types inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
typedef TAllocator AllocatorType
 
typedef
AllocatorType::const_iterator 
ConstIterator
 
typedef unsigned int DimensionValueType
 
typedef AllocatorType::iterator Iterator
 
typedef SizeValueType NeighborIndexType
 
typedef Offset< VDimension > OffsetType
 
typedef TPixel PixelType
 
typedef Neighborhood Self
 
typedef SizeType::SizeValueType SizeValueType
 
typedef SliceIterator< TPixel,
Self
SliceIteratorType
 

Public Member Functions

 AnnulusOperator ()
 
 AnnulusOperator (const Self &other)
 
void CreateOperator ()
 
virtual const char * GetNameOfClass () const
 
void SetInnerRadius (double r)
 
double GetInnerRadius () const
 
void SetThickness (double t)
 
double GetThickness () const
 
void SetSpacing (SpacingType &s)
 
const SpacingTypeGetSpacing () const
 
void SetNormalize (bool b)
 
bool GetNormalize () const
 
void NormalizeOn ()
 
void NormalizeOff ()
 
void SetBrightCenter (bool b)
 
bool GetBrightCenter () const
 
void BrightCenterOn ()
 
void BrightCenterOff ()
 
void SetInteriorValue (TPixel v)
 
TPixel GetInteriorValue () const
 
void SetAnnulusValue (TPixel v)
 
TPixel GetAnnulusValue () const
 
void SetExteriorValue (TPixel v)
 
TPixel GetExteriorValue () const
 
Selfoperator= (const Self &other)
 
virtual void PrintSelf (std::ostream &os, Indent i) const
 
- Public Member Functions inherited from itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >
virtual void CreateDirectional ()
 
virtual void CreateToRadius (const SizeType &)
 
virtual void CreateToRadius (const SizeValueType)
 
virtual void FlipAxes ()
 
unsigned long GetDirection () const
 
 NeighborhoodOperator ()
 
 NeighborhoodOperator (const Self &orig)
 
void ScaleCoefficients (PixelRealType)
 
void SetDirection (const unsigned long &direction)
 
Selfoperator= (const Self &orig)
 
- Public Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
NeighborIndexType GetCenterNeighborhoodIndex () const
 
TPixel GetCenterValue () const
 
virtual NeighborIndexType GetNeighborhoodIndex (const OffsetType &) const
 
OffsetType GetOffset (NeighborIndexType i) const
 
const SizeType GetRadius () const
 
SizeValueType GetRadius (DimensionValueType n) const
 
SizeValueType GetSize (DimensionValueType n) const
 
SizeType GetSize () const
 
std::slice GetSlice (unsigned int) const
 
OffsetValueType GetStride (DimensionValueType axis) const
 
 Neighborhood (const Self &other)
 
bool operator!= (const Self &other) const
 
Selfoperator= (const Self &other)
 
bool operator== (const Self &other) const
 
void Print (std::ostream &os) const
 
void SetRadius (const SizeType &)
 
void SetRadius (const SizeValueType *rad)
 
void SetRadius (const SizeValueType)
 
NeighborIndexType Size () const
 
virtual ~Neighborhood ()
 
 Neighborhood ()
 
Iterator End ()
 
Iterator Begin ()
 
ConstIterator End () const
 
ConstIterator Begin () const
 
TPixel & operator[] (NeighborIndexType i)
 
const TPixel & operator[] (NeighborIndexType i) const
 
TPixel & GetElement (NeighborIndexType i)
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () const
 
TPixel & operator[] (const OffsetType &o)
 
const TPixel & operator[] (const OffsetType &o) const
 

Protected Types

typedef
Superclass::CoefficientVector 
CoefficientVector
 
typedef Superclass::PixelType PixelType
 
- Protected Types inherited from itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >
typedef std::vector< double > CoefficientVector
 

Protected Member Functions

void Fill (const CoefficientVector &c)
 
CoefficientVector GenerateCoefficients ()
 
- Protected Member Functions inherited from itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >
virtual void FillCenteredDirectional (const CoefficientVector &)
 
void InitializeToZero ()
 
- Protected Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
virtual void Allocate (NeighborIndexType i)
 
virtual void ComputeNeighborhoodOffsetTable ()
 
virtual void ComputeNeighborhoodStrideTable ()
 
void SetSize ()
 

Private Attributes

PixelType m_AnnulusValue
 
bool m_BrightCenter
 
PixelType m_ExteriorValue
 
double m_InnerRadius
 
PixelType m_InteriorValue
 
bool m_Normalize
 
SpacingType m_Spacing
 
double m_Thickness
 

Additional Inherited Members

- Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
typedef::itk::Size< VDimension > RadiusType
 
typedef::itk::Size< VDimension > SizeType
 
- Static Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
static const unsigned int NeighborhoodDimension = VDimension
 

Member Typedef Documentation

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::CoefficientVector itk::AnnulusOperator< TPixel, TDimension, TAllocator >::CoefficientVector
protected

Typedef support for coefficient vector type. Necessary to work around compiler bug on VC++.

Definition at line 214 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::OffsetType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::OffsetType

Definition at line 81 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::PixelType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::PixelType
protected

Definition at line 215 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef AnnulusOperator itk::AnnulusOperator< TPixel, TDimension, TAllocator >::Self

Standard typedefs

Definition at line 76 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::SizeType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SizeType

Additional typedefs

Definition at line 80 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef Vector< double, TDimension > itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SpacingType

Definition at line 82 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
typedef NeighborhoodOperator< TPixel, TDimension, TAllocator > itk::AnnulusOperator< TPixel, TDimension, TAllocator >::Superclass

Definition at line 77 of file itkAnnulusOperator.h.

Constructor & Destructor Documentation

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator ( )
inline
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator ( const Self other)
inline

Member Function Documentation

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::BrightCenterOff ( )
inline

If Normalize is on, you define the annulus to have a bright center or a dark center.

Definition at line 156 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::BrightCenterOn ( )
inline

If Normalize is on, you define the annulus to have a bright center or a dark center.

Definition at line 154 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::CreateOperator ( )

This function is called to create the operator. The radius of the operator is determine automatically.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::Fill ( const CoefficientVector c)
protectedvirtual

Arranges coefficients spatially in the memory buffer.

Implements itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
CoefficientVector itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GenerateCoefficients ( )
protectedvirtual

Calculates operator coefficients.

Implements itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
TPixel itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetAnnulusValue ( ) const
inline

If Normalize is off, the interior to annulus, the annulus (region between the two circles), and the region exterior to the annulus to be defined manually. Defauls are 0, 1, 0 respectively.

Definition at line 170 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
bool itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetBrightCenter ( ) const
inline

If Normalize is on, you define the annulus to have a bright center or a dark center.

Definition at line 152 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
TPixel itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetExteriorValue ( ) const
inline

If Normalize is off, the interior to annulus, the annulus (region between the two circles), and the region exterior to the annulus to be defined manually. Defauls are 0, 1, 0 respectively.

Definition at line 174 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetInnerRadius ( ) const
inline

Set/Get the inner radius of the annulus. Radius is specified in physical units (mm).

Definition at line 115 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
TPixel itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetInteriorValue ( ) const
inline

If Normalize is off, the interior to annulus, the annulus (region between the two circles), and the region exterior to the annulus to be defined manually. Defauls are 0, 1, 0 respectively.

Definition at line 166 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
virtual const char* itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetNameOfClass ( ) const
virtual
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
bool itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetNormalize ( ) const
inline

Set/Get whether kernel values are computed automatically or specified manually

Definition at line 140 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
const SpacingType& itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetSpacing ( ) const
inline

Set/Get the pixel spacings. Setting these ensures the annulus is round in physical space. Defaults to 1.

Definition at line 132 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetThickness ( ) const
inline

Set/Get the thickness of the annulus. The outer radius of the annulus is defined as r = InnerRadius + Thickness. Thickness is specified in physical units (mm).

Definition at line 124 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::NormalizeOff ( )
inline

Set/Get whether kernel values are computed automatically or specified manually

Definition at line 144 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::NormalizeOn ( )
inline

Set/Get whether kernel values are computed automatically or specified manually

Definition at line 142 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
Self& itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator= ( const Self other)
inline
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
virtual void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::PrintSelf ( std::ostream &  os,
Indent  i 
) const
inlinevirtual

Prints some debugging information

Reimplemented from itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >.

Definition at line 195 of file itkAnnulusOperator.h.

References itk::Indent::GetNextIndent().

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetAnnulusValue ( TPixel  v)
inline

If Normalize is off, the interior to annulus, the annulus (region between the two circles), and the region exterior to the annulus to be defined manually. Defauls are 0, 1, 0 respectively.

Definition at line 168 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetBrightCenter ( bool  b)
inline

If Normalize is on, you define the annulus to have a bright center or a dark center.

Definition at line 150 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetExteriorValue ( TPixel  v)
inline

If Normalize is off, the interior to annulus, the annulus (region between the two circles), and the region exterior to the annulus to be defined manually. Defauls are 0, 1, 0 respectively.

Definition at line 172 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetInnerRadius ( double  r)
inline

Set/Get the inner radius of the annulus. Radius is specified in physical units (mm).

Definition at line 113 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetInteriorValue ( TPixel  v)
inline

If Normalize is off, the interior to annulus, the annulus (region between the two circles), and the region exterior to the annulus to be defined manually. Defauls are 0, 1, 0 respectively.

Definition at line 164 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetNormalize ( bool  b)
inline

Set/Get whether kernel values are computed automatically or specified manually

Definition at line 138 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetSpacing ( SpacingType s)
inline

Set/Get the pixel spacings. Setting these ensures the annulus is round in physical space. Defaults to 1.

Definition at line 130 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetThickness ( double  t)
inline

Set/Get the thickness of the annulus. The outer radius of the annulus is defined as r = InnerRadius + Thickness. Thickness is specified in physical units (mm).

Definition at line 122 of file itkAnnulusOperator.h.

Member Data Documentation

template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
PixelType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_AnnulusValue
private
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
bool itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_BrightCenter
private
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
PixelType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_ExteriorValue
private
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_InnerRadius
private
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
PixelType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_InteriorValue
private
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
bool itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Normalize
private
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
SpacingType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Spacing
private
template<class TPixel , unsigned int TDimension = 2, class TAllocator = NeighborhoodAllocator< TPixel >>
double itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Thickness
private

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