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, TDimension, TAllocator >:

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

List of all members.

Public Types
typedef TAllocator	AllocatorType
typedef AllocatorType::const_iterator	ConstIterator
typedef AllocatorType::iterator	Iterator
typedef Superclass::OffsetType	OffsetType
typedef NumericTraits< TPixel > ::RealType	PixelRealType
typedef ::itk::Size< VDimension >	RadiusType
typedef AnnulusOperator	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef SliceIterator< TPixel, Self >	SliceIteratorType
typedef Vector< double, TDimension >	SpacingType
typedef NeighborhoodOperator < TPixel, TDimension, TAllocator >	Superclass

Public Member Functions
	AnnulusOperator ()
	AnnulusOperator (const Self &other)
Iterator	Begin ()
ConstIterator	Begin () const
void	BrightCenterOff ()
void	BrightCenterOn ()
virtual void	CreateDirectional ()
void	CreateOperator ()
virtual void	CreateToRadius (const SizeType &)
virtual void	CreateToRadius (const unsigned long)
Iterator	End ()
ConstIterator	End () const
virtual void	FlipAxes ()
TPixel	GetAnnulusValue () const
bool	GetBrightCenter () const
AllocatorType &	GetBufferReference ()
const AllocatorType &	GetBufferReference () const
unsigned int	GetCenterNeighborhoodIndex () const
TPixel	GetCenterValue () const
unsigned long	GetDirection () const
TPixel &	GetElement (unsigned int i)
TPixel	GetExteriorValue () const
double	GetInnerRadius () const
TPixel	GetInteriorValue () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNeighborhoodIndex (const OffsetType &) const
bool	GetNormalize () const
OffsetType	GetOffset (unsigned int i) const
const SizeType	GetRadius () const
unsigned long	GetRadius (const unsigned long n) const
unsigned long	GetSize (const unsigned long n) const
SizeType	GetSize () const
std::slice	GetSlice (unsigned int) const
const SpacingType &	GetSpacing () const
unsigned	GetStride (const unsigned axis) const
double	GetThickness () const
void	NormalizeOff ()
void	NormalizeOn ()
bool	operator!= (const Self &other) const
Self &	operator= (const Self &other)
bool	operator== (const Self &other) const
TPixel &	operator[] (unsigned int i)
const TPixel &	operator[] (unsigned int i) const
TPixel &	operator[] (const OffsetType &o)
const TPixel &	operator[] (const OffsetType &o) const
void	Print (std::ostream &os) const
virtual void	PrintSelf (std::ostream &os, Indent i) const
void	ScaleCoefficients (PixelRealType)
void	SetAnnulusValue (TPixel v)
void	SetBrightCenter (bool b)
void	SetDirection (const unsigned long &direction)
void	SetExteriorValue (TPixel v)
void	SetInnerRadius (double r)
void	SetInteriorValue (TPixel v)
void	SetNormalize (bool b)
void	SetRadius (const SizeType &)
void	SetRadius (const unsigned long *rad)
void	SetRadius (const unsigned long)
void	SetSpacing (SpacingType &s)
void	SetThickness (double t)
unsigned int	Size () const

Static Public Attributes
static const unsigned int	NeighborhoodDimension = VDimension

Protected Types
typedef Superclass::CoefficientVector	CoefficientVector
typedef Superclass::PixelType	PixelType

Protected Member Functions
virtual void	Allocate (unsigned int i)
virtual void	ComputeNeighborhoodOffsetTable ()
virtual void	ComputeNeighborhoodStrideTable ()
void	Fill (const CoefficientVector &c)
virtual void	FillCenteredDirectional (const CoefficientVector &)
CoefficientVector	GenerateCoefficients ()
void	InitializeToZero ()
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

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.

Member Typedef Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef TAllocator itk::Neighborhood< TPixel, VDimension, TAllocator >::AllocatorType

inherited

External support for allocator type.

Reimplemented in itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >, and itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >.

Definition at line 63 of file itkNeighborhood.h.

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++.

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

Definition at line 206 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef AllocatorType::const_iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::ConstIterator

inherited

Definition at line 75 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef AllocatorType::iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Iterator

inherited

Iterator typedef support. Note the naming is intentional, i.e., ::iterator and ::const_iterator, because the allocator may be a vnl object or other type, which uses this form.

Definition at line 74 of file itkNeighborhood.h.

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

typedef Superclass::OffsetType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::OffsetType

Offset type used to reference neighbor locations

Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.

Definition at line 81 of file itkAnnulusOperator.h.

typedef NumericTraits< TPixel >::RealType itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PixelRealType

inherited

Definition at line 136 of file itkNeighborhoodOperator.h.

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

typedef Superclass::PixelType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::PixelType

protected

External support for pixel type

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

Definition at line 207 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef ::itk::Size<VDimension> itk::Neighborhood< TPixel, VDimension, TAllocator >::RadiusType

inherited

Radius typedef support.

Definition at line 82 of file itkNeighborhood.h.

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

typedef AnnulusOperator itk::AnnulusOperator< TPixel, TDimension, TAllocator >::Self

Standard typedefs

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

Definition at line 75 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

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

Definition at line 79 of file itkAnnulusOperator.h.

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

typedef Superclass::SizeValueType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SizeValueType

Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.

Definition at line 80 of file itkAnnulusOperator.h.

typedef SliceIterator<TPixel, Self> itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SliceIteratorType

inherited

Slice iterator typedef support

Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.

Definition at line 79 of file itkNeighborhoodOperator.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

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

Definition at line 76 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

Definition at line 86 of file itkAnnulusOperator.h.

References itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::Fill().

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

itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator ( const Self & other )

inline

Definition at line 94 of file itkAnnulusOperator.h.

Member Function Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::Allocate ( unsigned int i )

inlineprotectedvirtualinherited

Allocates the neighborhood's memory buffer.

Definition at line 236 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( void )

inlineinherited

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 154 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), itk::FlatStructuringElement< VDimension >::Box(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::FlatStructuringElement< VDimension >::Cross(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood(), itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator()(), itk::VectorNeighborhoodInnerProduct< TImage >::operator()(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), and itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetNeighborhood().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( void ) const

inlineinherited

Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.

Definition at line 158 of file itkNeighborhood.h.

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

void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::BrightCenterOff ( )

inline

Definition at line 152 of file itkAnnulusOperator.h.

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

void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::BrightCenterOn ( )

inline

Definition at line 150 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int VDimension, class TContainer >

void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodOffsetTable ( )

protectedvirtualinherited

Fills entries into the offset lookup table. Called once on initialization.

Definition at line 49 of file itkNeighborhood.txx.

template<class TPixel , unsigned int VDimension, class TContainer >

void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodStrideTable ( )

protectedvirtualinherited

Computes the entries for the stride table

Definition at line 28 of file itkNeighborhood.txx.

virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateDirectional ( )

virtualinherited

Creates the operator with length only in the specified direction. The radius of the operator will be 0 except along the axis on which the operator will work.

See also:: CreateToRadius; FillCenteredDirectional; SetDirection(); GetDirection()

template<class TPixel , unsigned int TDimension, class TAllocator >

void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::CreateOperator ( )

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

Create the operator

Definition at line 32 of file itkAnnulusOperator.txx.

virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const SizeType & )

virtualinherited

Creates the operator with a specified radius. The spatial location of the coefficients within the operator is defined by the subclass implementation of the Fill method.

See also:: CreateDirectional; Fill

virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const unsigned long )

virtualinherited

Creates the operator with a specified radius ("square", same length on each side). The spatial location of the coefficients within the operator is defined by the subclass implementation of the Fill method.

See also:: CreateDirectional; Fill

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( void )

inlineinherited

STL-style iterator support.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 152 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Box(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::FlatStructuringElement< VDimension >::Cross(), itk::VectorNeighborhoodInnerProduct< TImage >::operator()(), itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator()(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), and itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( void ) const

inlineinherited

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.

Definition at line 156 of file itkNeighborhood.h.

template<class TPixel , unsigned int TDimension, class TAllocator >

void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::Fill ( const CoefficientVector & coeff )

protectedvirtual

Arranges coefficients spatially in the memory buffer.

This function fills the coefficients into the corresponding neighborhood.

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

Definition at line 46 of file itkAnnulusOperator.txx.

virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FillCenteredDirectional ( const CoefficientVector & )

protectedvirtualinherited

A pre-defined Fill function that can be called by a subclass Fill function to center coefficients along the axis specified by the SetDirection method. Useful for creating directional operators, or centering coefficients in an N-dimensional neighborhood.

virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FlipAxes ( )

virtualinherited

Reverses the direction of all axes of the operator by reversing the order of the coefficients.

template<class TPixel , unsigned int TDimension, class TAllocator >

AnnulusOperator< TPixel, TDimension, TAllocator >::CoefficientVector itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GenerateCoefficients ( )

protectedvirtual

Calculates operator coefficients.

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

Definition at line 69 of file itkAnnulusOperator.txx.

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

TPixel itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetAnnulusValue ( ) const

inline

Definition at line 165 of file itkAnnulusOperator.h.

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

bool itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetBrightCenter ( ) const

inline

Definition at line 148 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( )

inlineinherited

Returns a reference to the data buffer structure.

Definition at line 200 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

const AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( ) const

inlineinherited

Definition at line 202 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterNeighborhoodIndex ( ) const

inlineinherited

Definition at line 218 of file itkNeighborhood.h.

Referenced by otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeDescriptor(), otb::MRFEnergy< TInput1, TInput2 >::GetValue(), otb::MRFEnergy< TInput2, TInput2 >::GetValue(), and otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::IsLocalExtremum().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

TPixel itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterValue ( ) const

inlineinherited

Returns the element at the center of the neighborhood.

Definition at line 174 of file itkNeighborhood.h.

Referenced by itk::MRFImageFilter< TInputImage, TClassifiedImage >::DoNeighborhoodOperation().

unsigned long itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::GetDirection ( void ) const

inlineinherited

Returns the direction (dimension number) of a directional operator.

Definition at line 103 of file itkNeighborhoodOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetElement ( unsigned int i )

inlineinherited

Definition at line 170 of file itkNeighborhood.h.

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

TPixel itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetExteriorValue ( ) const

inline

Definition at line 169 of file itkAnnulusOperator.h.

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

double itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetInnerRadius ( ) const

inline

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

Definition at line 161 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 VDimension, class TContainer >

unsigned int itk::Neighborhood< TPixel, VDimension, TContainer >::GetNeighborhoodIndex ( const OffsetType & o ) const

virtualinherited

Definition at line 147 of file itkNeighborhood.txx.

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

bool itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetNormalize ( ) const

inline

Definition at line 137 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

OffsetType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetOffset ( unsigned int i ) const

inlineinherited

Returns the itk::Offset from the center of the Neighborhood to the requested neighbor index.

Definition at line 213 of file itkNeighborhood.h.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >::FillWeightOffsetTable(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), and itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >::SetInputImage().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

const SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( void ) const

inlineinherited

Returns the radius of the neighborhood.

Definition at line 128 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

unsigned long itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( const unsigned long n ) const

inlineinherited

Returns the radius of the neighborhood along a specified dimension.

Definition at line 133 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

unsigned long itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSize ( const unsigned long n ) const

inlineinherited

Returns the size (total length) of the neighborhood along a specified dimension.

Definition at line 138 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), otb::LineSegmentDetector< TInputImage, TPrecision >::GrowRegion(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSize ( void ) const

inlineinherited

Returns the size (total length of sides) of the neighborhood.

Definition at line 142 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >

std::slice itk::Neighborhood< TPixel, VDimension, TContainer >::GetSlice ( unsigned int d ) const

inherited

Definition at line 134 of file itkNeighborhood.txx.

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

const SpacingType& itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetSpacing ( void ) const

inline

Definition at line 130 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

unsigned itk::Neighborhood< TPixel, VDimension, TAllocator >::GetStride ( const unsigned axis ) const

inlineinherited

Returns the stride length for the specified dimension. Stride length is the number of pixels between adjacent pixels along the given dimension.

Definition at line 148 of file itkNeighborhood.h.

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

double itk::AnnulusOperator< TPixel, TDimension, TAllocator >::GetThickness ( ) const

inline

Definition at line 123 of file itkAnnulusOperator.h.

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::InitializeToZero ( )

inlineprotectedinherited

Initializes all the coefficients in the neighborhood to zero values

Definition at line 162 of file itkNeighborhoodOperator.h.

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

void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::NormalizeOff ( )

inline

Definition at line 141 of file itkAnnulusOperator.h.

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

void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::NormalizeOn ( )

inline

Definition at line 139 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

bool itk::Neighborhood< TPixel, VDimension, TAllocator >::operator!= ( const Self & other ) const

inlineinherited

Not Equal operator.

Definition at line 120 of file itkNeighborhood.h.

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

Self& itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator= ( const Self & other )

inline

Assignment operator

Definition at line 173 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

bool itk::Neighborhood< TPixel, VDimension, TAllocator >::operator== ( const Self & other ) const

inlineinherited

Comparison operator.

Definition at line 112 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( unsigned int i )

inlineinherited

Pass-through data access methods to the buffer.

Definition at line 166 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( unsigned int i ) const

inlineinherited

Definition at line 168 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType & o )

inlineinherited

Get pixel value by offset

Definition at line 206 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator[]().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType & o ) const

inlineinherited

Definition at line 208 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator[]().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

void itk::Neighborhood< TPixel, VDimension, TAllocator >::Print ( std::ostream & os ) const

inlineinherited

Standard itk object method.

Definition at line 196 of file itkNeighborhood.h.

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 188 of file itkAnnulusOperator.h.

References itk::Indent::GetNextIndent().

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::ScaleCoefficients ( PixelRealType )

inherited

Multiplies all of the coefficients of the kernel by a single scalar value.

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

void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetAnnulusValue ( TPixel v )

inline

Definition at line 163 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 146 of file itkAnnulusOperator.h.

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SetDirection ( const unsigned long & direction )

inlineinherited

Sets the dimensional direction of a directional operator.

Definition at line 99 of file itkNeighborhoodOperator.h.

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

void itk::AnnulusOperator< TPixel, TDimension, TAllocator >::SetExteriorValue ( TPixel v )

inline

Definition at line 167 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 159 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 135 of file itkAnnulusOperator.h.

template<class TPixel , unsigned int VDimension, class TContainer >

void itk::Neighborhood< TPixel, VDimension, TContainer >::SetRadius ( const SizeType & r )

inherited

Sets the radius for the neighborhood, calculates size from the radius, and allocates storage.

Definition at line 91 of file itkNeighborhood.txx.

References itk::Size< VDimension >::m_Size.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), itk::FlatStructuringElement< VDimension >::Box(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter(), itk::FlatStructuringElement< VDimension >::Cross(), itk::CurvatureNDAnisotropicDiffusionFunction< TImage >::CurvatureNDAnisotropicDiffusionFunction(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood(), itk::GradientNDAnisotropicDiffusionFunction< TImage >::GradientNDAnisotropicDiffusionFunction(), itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize(), itk::LevelSetFunction< TImageType >::Initialize(), itk::FlatStructuringElement< VDimension >::Poly(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), itk::Statistics::ScalarImageToGreyLevelRunLengthMatrixGenerator< TImageType, THistogramFrequencyContainer >::ScalarImageToGreyLevelRunLengthMatrixGenerator(), itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ThreadedGenerateData(), itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorCurvatureNDAnisotropicDiffusionFunction(), and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorGradientNDAnisotropicDiffusionFunction().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const unsigned long * rad )

inlineinherited

Sets the radius for the neighborhood. Overloaded to support an unsigned long array.

Definition at line 183 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >

void itk::Neighborhood< TPixel, VDimension, TContainer >::SetRadius ( const unsigned long s )

inherited

Overloads SetRadius to allow a single long integer argument that is used as the radius of all the dimensions of the Neighborhood (resulting in a "square" neighborhood).

Definition at line 78 of file itkNeighborhood.txx.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetSize ( )

inlineprotectedinherited

Sets the length along each dimension.

Definition at line 227 of file itkNeighborhood.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 128 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 121 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::Size ( void ) const

inlineinherited

More STL-style support.

Definition at line 162 of file itkNeighborhood.h.

Member Data Documentation

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

PixelType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_AnnulusValue

private

Definition at line 222 of file itkAnnulusOperator.h.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator(), and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator=().

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

bool itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_BrightCenter

private

Definition at line 220 of file itkAnnulusOperator.h.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator(), and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator=().

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

PixelType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_ExteriorValue

private

Definition at line 223 of file itkAnnulusOperator.h.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator(), and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator=().

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

double itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_InnerRadius

private

Definition at line 217 of file itkAnnulusOperator.h.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator(), and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator=().

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

PixelType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_InteriorValue

private

Definition at line 221 of file itkAnnulusOperator.h.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator(), and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator=().

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

bool itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Normalize

private

Definition at line 219 of file itkAnnulusOperator.h.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator(), and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator=().

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

SpacingType itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Spacing

private

Definition at line 224 of file itkAnnulusOperator.h.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator(), and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator=().

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

double itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Thickness

private

Definition at line 218 of file itkAnnulusOperator.h.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator(), and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::operator=().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>

const unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::NeighborhoodDimension = VDimension

staticinherited

External support for dimensionality.

Reimplemented in itk::FlatStructuringElement< VDimension >, itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >, and itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >.

Definition at line 66 of file itkNeighborhood.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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