Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

#include <itkAnnulusOperator.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::AnnulusOperator< TPixel, TDimension, TAllocator >:

Collaboration graph
[legend]
List of all members.

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

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 ()
virtual void Fill (const CoefficientVector &)=0
void Fill (const CoefficientVector &c)
virtual void FillCenteredDirectional (const CoefficientVector &)
CoefficientVector GenerateCoefficients ()
void InitializeToZero ()
void SetSize ()


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 61 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 215 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]

Reimplemented in itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >, itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >, itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::FlatStructuringElement< VDimension >.

Definition at line 73 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.

Reimplemented in itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >, itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >, itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, and itk::FlatStructuringElement< VDimension >.

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

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

Definition at line 138 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 216 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.

Reimplemented in itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >, itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >, itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::FlatStructuringElement< VDimension >.

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

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

Definition at line 80 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 81 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 83 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 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]

Definition at line 87 of file itkAnnulusOperator.h.

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

Definition at line 95 of file itkAnnulusOperator.h.

References itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_AnnulusValue, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_BrightCenter, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_ExteriorValue, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_InnerRadius, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_InteriorValue, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Normalize, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Spacing, and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Thickness.


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  )  [inline, protected, virtual, inherited]

Allocates the neighborhood's memory buffer.

Definition at line 228 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( void   )  const [inline, inherited]

Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >.

Definition at line 148 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( void   )  [inline, inherited]

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

Definition at line 144 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 157 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 155 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::ComputeNeighborhoodOffsetTable (  )  [protected, virtual, inherited]

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

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::ComputeNeighborhoodStrideTable (  )  [protected, virtual, inherited]

Computes the entries for the stride table

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

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

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

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

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

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

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( void   )  const [inline, inherited]

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

Definition at line 146 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( void   )  [inline, inherited]

STL-style iterator support.

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

Definition at line 142 of file itkNeighborhood.h.

virtual void itk::NeighborhoodOperator< TPixel , VDimension, TAllocator >::Fill ( const CoefficientVector  )  [protected, pure virtual, inherited]

A subclass-specific algorithm that positions the coefficients spatially in the operator.

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

Arranges coefficients spatially in the memory buffer.

virtual void itk::NeighborhoodOperator< TPixel , VDimension, TAllocator >::FillCenteredDirectional ( const CoefficientVector  )  [protected, virtual, inherited]

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 (  )  [virtual, inherited]

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

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

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]

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

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
const AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference (  )  const [inline, inherited]

Definition at line 195 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference (  )  [inline, inherited]

Returns a reference to the data buffer structure.

Definition at line 193 of file itkNeighborhood.h.

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

Definition at line 213 of file itkNeighborhood.h.

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

Returns the element at the center of the neighborhood.

Definition at line 166 of file itkNeighborhood.h.

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

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

Definition at line 104 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  )  [inline, inherited]

Definition at line 161 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 175 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 116 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 167 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 = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
virtual unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::GetNeighborhoodIndex ( const OffsetType  )  const [virtual, inherited]

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

Definition at line 141 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 [inline, inherited]

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

Definition at line 208 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 [inline, inherited]

Returns the radius of the neighborhood along a specified dimension.

Definition at line 123 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
const SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( void   )  const [inline, inherited]

Returns the radius of the neighborhood.

Definition at line 118 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSize ( void   )  const [inline, inherited]

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

Definition at line 132 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 [inline, inherited]

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

Definition at line 128 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
std::slice itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSlice ( unsigned  int  )  const [inherited]

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 133 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 [inline, inherited]

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

void itk::NeighborhoodOperator< TPixel , VDimension, TAllocator >::InitializeToZero (  )  [inline, protected, inherited]

Initializes all the coefficients in the neighborhood to zero values

Definition at line 164 of file itkNeighborhoodOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
itk::Neighborhood< TPixel, VDimension, TAllocator >::itkStaticConstMacro ( NeighborhoodDimension  ,
unsigned  int,
VDimension   
) [inherited]

External support for dimensionality.

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

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

Definition at line 145 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 143 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 [inline, inherited]

Not Equal operator.

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

References itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_AnnulusValue, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_BrightCenter, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_ExteriorValue, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_InnerRadius, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_InteriorValue, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Normalize, itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Spacing, and itk::AnnulusOperator< TPixel, TDimension, TAllocator >::m_Thickness.

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

Comparison operator.

Definition at line 102 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType o  )  const [inline, inherited]

Definition at line 202 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  )  [inline, inherited]

Get pixel value by offset

Definition at line 200 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 [inline, inherited]

Definition at line 159 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  )  [inline, inherited]

Pass-through data access methods to the buffer.

Definition at line 157 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::Print ( std::ostream &  os  )  const [inline, inherited]

Standard itk object method.

Definition at line 189 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 [inline, virtual]

Prints some debugging information

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

Definition at line 196 of file itkAnnulusOperator.h.

References itk::Indent::GetNextIndent(), and HardConnectedComponentImageFilter::PrintSelf().

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

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

Sets the dimensional direction of a directional operator.

Definition at line 100 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 173 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 114 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 165 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 139 of file itkAnnulusOperator.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const unsigned  long  )  [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).

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const unsigned long *  rad  )  [inline, inherited]

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

Definition at line 175 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const SizeType  )  [inherited]

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

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetSize (  )  [inline, protected, inherited]

Sets the length along each dimension.

Definition at line 220 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 131 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 123 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 [inline, inherited]

More STL-style support.

Definition at line 153 of file itkNeighborhood.h.

Referenced by itk::NeighborhoodInnerProduct< Superclass::ImageType >::operator()().


The documentation for this class was generated from the following file:
Generated at Thu Nov 6 01:37:54 2008 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000