itk::AnnulusOperator< TPixel, VDimension, TAllocator > Class Template Reference
[Operators]

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

#include <itkAnnulusOperator.h>

Inheritance diagram for itk::AnnulusOperator< TPixel, VDimension, TAllocator >:

[legend]Collaboration diagram for itk::AnnulusOperator< TPixel, VDimension, TAllocator >:

[legend]List of all members.

Public Types
typedef AnnulusOperator	Self
typedef NeighborhoodOperator< TPixel, VDimension, TAllocator >	Superclass
typedef Superclass::SizeType	SizeType
typedef Superclass::OffsetType	OffsetType
typedef Vector< double, VDimension >	SpacingType
Public Member Functions
virtual const char *	GetNameOfClass () const
	AnnulusOperator ()
	AnnulusOperator (const Self &other)
void	CreateOperator ()
Self &	operator= (const Self &other)
void	SetInnerRadius (double r)
double	GetInnerRadius () const
void	SetThickness (double t)
double	GetThickness () const
void	SetSpacing (SpacingType &s)
const SpacingType &	GetSpacing () 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
virtual void	PrintSelf (std::ostream &os, Indent i) const
Protected Types
typedef Superclass::CoefficientVector	CoefficientVector
typedef Superclass::PixelType	PixelType
Protected Member Functions
CoefficientVector	GenerateCoefficients ()
void	Fill (const CoefficientVector &c)

---

Detailed Description

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
class itk::AnnulusOperator< TPixel, VDimension, 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 69 of file itkAnnulusOperator.h.

---

Member Typedef Documentation

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

Typedef support for coefficient vector type. Necessary to work around compiler bug on VC++. Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >. Definition at line 218 of file itkAnnulusOperator.h.

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

Offset type used to reference neighbor locations Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 80 of file itkAnnulusOperator.h.

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

External support for pixel type Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >. Definition at line 219 of file itkAnnulusOperator.h. Referenced by itk::AnnulusOperator< TPixel, VDimension, TAllocator >::AnnulusOperator().

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

Standard typedefs Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >. Definition at line 75 of file itkAnnulusOperator.h. Referenced by itk::AnnulusOperator< TPixel, VDimension, TAllocator >::GetExteriorValue().

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

Additional typedefs Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >. Definition at line 79 of file itkAnnulusOperator.h.

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

Definition at line 81 of file itkAnnulusOperator.h. Referenced by itk::AnnulusOperator< TPixel, VDimension, TAllocator >::GetThickness().

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

Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >. Definition at line 76 of file itkAnnulusOperator.h.

---

Constructor & Destructor Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> itk::AnnulusOperator< TPixel, VDimension, TAllocator >::AnnulusOperator (   )  [inline]

Definition at line 85 of file itkAnnulusOperator.h. References itk::AnnulusOperator< TPixel, VDimension, TAllocator >::PixelType.

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

Definition at line 93 of file itkAnnulusOperator.h.

---

Member Function Documentation

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

If Normalize is on, you define the annulus to have a bright center or a dark center. Definition at line 155 of file itkAnnulusOperator.h.

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

If Normalize is on, you define the annulus to have a bright center or a dark center. Definition at line 153 of file itkAnnulusOperator.h.

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

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

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> void itk::AnnulusOperator< TPixel, VDimension, TAllocator >::Fill (  const CoefficientVector &  c  )  [protected, virtual]

Arranges coefficients spatially in the memory buffer. Implements itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> CoefficientVector itk::AnnulusOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients (   )  [protected, virtual]

Calculates operator coefficients. Implements itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> TPixel itk::AnnulusOperator< TPixel, VDimension, 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 169 of file itkAnnulusOperator.h.

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

If Normalize is on, you define the annulus to have a bright center or a dark center. Definition at line 151 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> TPixel itk::AnnulusOperator< TPixel, VDimension, 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 173 of file itkAnnulusOperator.h. References itk::AnnulusOperator< TPixel, VDimension, TAllocator >::m_InnerRadius, itk::AnnulusOperator< TPixel, VDimension, TAllocator >::m_InteriorValue, itk::AnnulusOperator< TPixel, VDimension, TAllocator >::m_Spacing, itk::AnnulusOperator< TPixel, VDimension, TAllocator >::m_Thickness, and itk::AnnulusOperator< TPixel, VDimension, TAllocator >::Self.

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

Set/Get the inner radius of the annulus. Radius is specified in physical units (mm). Definition at line 114 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> TPixel itk::AnnulusOperator< TPixel, VDimension, 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 165 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> virtual const char* itk::AnnulusOperator< TPixel, VDimension, TAllocator >::GetNameOfClass (   )  const [virtual]

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> bool itk::AnnulusOperator< TPixel, VDimension, TAllocator >::GetNormalize (   )  const [inline]

Set/Get whether kernel values are computed automatically or specified manually Definition at line 139 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> const SpacingType& itk::AnnulusOperator< TPixel, VDimension, 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 131 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> double itk::AnnulusOperator< TPixel, VDimension, 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 123 of file itkAnnulusOperator.h. References itk::AnnulusOperator< TPixel, VDimension, TAllocator >::SpacingType.

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

Set/Get whether kernel values are computed automatically or specified manually Definition at line 143 of file itkAnnulusOperator.h.

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

Set/Get whether kernel values are computed automatically or specified manually Definition at line 141 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> Self& itk::AnnulusOperator< TPixel, VDimension, TAllocator >::operator= (  const Self &  other  )  [inline]

Assignment operator Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >. Definition at line 180 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> virtual void itk::AnnulusOperator< TPixel, VDimension, TAllocator >::PrintSelf (  std::ostream &  os, Indent  i )  const [inline, virtual]

Prints some debugging information Reimplemented from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >. Definition at line 197 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> void itk::AnnulusOperator< TPixel, VDimension, 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 167 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> void itk::AnnulusOperator< TPixel, VDimension, 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 149 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> void itk::AnnulusOperator< TPixel, VDimension, 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 171 of file itkAnnulusOperator.h.

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

Set/Get the inner radius of the annulus. Radius is specified in physical units (mm). Definition at line 112 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> void itk::AnnulusOperator< TPixel, VDimension, 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 163 of file itkAnnulusOperator.h.

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

Set/Get whether kernel values are computed automatically or specified manually Definition at line 137 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> void itk::AnnulusOperator< TPixel, VDimension, 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 129 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> void itk::AnnulusOperator< TPixel, VDimension, 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 121 of file itkAnnulusOperator.h.

---

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

• itkAnnulusOperator.h

---