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

itk::FlatStructuringElement< NDimension > Class Template Reference

#include <itkFlatStructuringElement.h>

Inheritance diagram for itk::FlatStructuringElement< NDimension >:

Inheritance graph
[legend]
Collaboration diagram for itk::FlatStructuringElement< NDimension >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<unsigned int NDimension>
class itk::FlatStructuringElement< NDimension >

A class to support a variety of flat structuring elements, including versions created by decomposition of lines.

Definition at line 30 of file itkFlatStructuringElement.h.

Public Types

typedef NeighborhoodAllocator<
bool > 
AllocatorType
typedef Superclass::ConstIterator ConstIterator
typedef Superclass::Iterator Iterator
typedef Offset< VDimension > OffsetType
typedef Superclass::PixelType PixelType
typedef Superclass::RadiusType RadiusType
typedef FlatStructuringElement<
NDimension > 
Self
typedef Superclass::SizeType SizeType
typedef Superclass::SizeValueType SizeValueType
typedef Superclass::SliceIteratorType SliceIteratorType
typedef Neighborhood< bool,
NDimension > 
Superclass

Public Member Functions

ConstIterator Begin () const
Iterator Begin ()
ConstIterator End () const
Iterator End ()
 FlatStructuringElement ()
const AllocatorTypeGetBufferReference () const
AllocatorTypeGetBufferReference ()
unsigned int GetCenterNeighborhoodIndex () const
bool GetCenterValue () const
bool & GetElement (unsigned int i)
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)
 itkStaticConstMacro (Dimension, unsigned int, NDimension)
 itkStaticConstMacro (NeighborhoodDimension, unsigned int, NDimension)
bool operator!= (const Self &other) const
bool operator== (const Self &other) const
const bool & operator[] (const OffsetType &o) const
bool & operator[] (const OffsetType &o)
const bool & operator[] (unsigned int i) const
bool & operator[] (unsigned int i)
void Print (std::ostream &os) const
void SetRadius (const unsigned long)
void SetRadius (const unsigned long *rad)
void SetRadius (const SizeType &)
unsigned int Size () const
virtual ~FlatStructuringElement ()

Static Public Member Functions

static Self Ball (RadiusType radius)
static Self Box (RadiusType radius)

Protected Member Functions

virtual void Allocate (unsigned int i)
virtual void ComputeNeighborhoodOffsetTable ()
virtual void ComputeNeighborhoodStrideTable ()
virtual void PrintSelf (std::ostream &, Indent) const
void SetSize ()


Member Typedef Documentation

typedef NeighborhoodAllocator<bool > itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::AllocatorType [inherited]

External support for allocator type.

Definition at line 61 of file itkNeighborhood.h.

template<unsigned int NDimension>
typedef Superclass::ConstIterator itk::FlatStructuringElement< NDimension >::ConstIterator

Reimplemented from itk::Neighborhood< bool, NDimension >.

Definition at line 52 of file itkFlatStructuringElement.h.

template<unsigned int NDimension>
typedef Superclass::Iterator itk::FlatStructuringElement< NDimension >::Iterator

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 from itk::Neighborhood< bool, NDimension >.

Definition at line 51 of file itkFlatStructuringElement.h.

typedef Offset<VDimension> itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::OffsetType [inherited]

Offset type used to reference neighbor locations

Definition at line 83 of file itkNeighborhood.h.

template<unsigned int NDimension>
typedef Superclass::PixelType itk::FlatStructuringElement< NDimension >::PixelType

External support for pixel type.

Reimplemented from itk::Neighborhood< bool, NDimension >.

Definition at line 46 of file itkFlatStructuringElement.h.

template<unsigned int NDimension>
typedef Superclass::RadiusType itk::FlatStructuringElement< NDimension >::RadiusType

Radius typedef support.

Reimplemented from itk::Neighborhood< bool, NDimension >.

Definition at line 59 of file itkFlatStructuringElement.h.

template<unsigned int NDimension>
typedef FlatStructuringElement< NDimension > itk::FlatStructuringElement< NDimension >::Self

Standard class typedefs.

Reimplemented from itk::Neighborhood< bool, NDimension >.

Definition at line 42 of file itkFlatStructuringElement.h.

template<unsigned int NDimension>
typedef Superclass::SizeType itk::FlatStructuringElement< NDimension >::SizeType

Size and value typedef support.

Reimplemented from itk::Neighborhood< bool, NDimension >.

Definition at line 55 of file itkFlatStructuringElement.h.

template<unsigned int NDimension>
typedef Superclass::SizeValueType itk::FlatStructuringElement< NDimension >::SizeValueType

Reimplemented from itk::Neighborhood< bool, NDimension >.

Definition at line 56 of file itkFlatStructuringElement.h.

template<unsigned int NDimension>
typedef Superclass::SliceIteratorType itk::FlatStructuringElement< NDimension >::SliceIteratorType

External slice iterator type typedef support.

Reimplemented from itk::Neighborhood< bool, NDimension >.

Definition at line 62 of file itkFlatStructuringElement.h.

template<unsigned int NDimension>
typedef Neighborhood<bool, NDimension > itk::FlatStructuringElement< NDimension >::Superclass

Definition at line 43 of file itkFlatStructuringElement.h.


Constructor & Destructor Documentation

template<unsigned int NDimension>
virtual itk::FlatStructuringElement< NDimension >::~FlatStructuringElement (  )  [inline, virtual]

Default destructor.

Definition at line 65 of file itkFlatStructuringElement.h.

template<unsigned int NDimension>
itk::FlatStructuringElement< NDimension >::FlatStructuringElement (  )  [inline]

Default consructor.

Definition at line 68 of file itkFlatStructuringElement.h.


Member Function Documentation

virtual void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::Allocate ( unsigned int  i  )  [inline, protected, virtual, inherited]

Allocates the neighborhood's memory buffer.

Definition at line 228 of file itkNeighborhood.h.

template<unsigned int NDimension>
static Self itk::FlatStructuringElement< NDimension >::Ball ( RadiusType  radius  )  [static]

ConstIterator itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::Begin ( void   )  const [inline, inherited]

Definition at line 148 of file itkNeighborhood.h.

Iterator itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::Begin ( void   )  [inline, inherited]

Definition at line 144 of file itkNeighborhood.h.

template<unsigned int NDimension>
static Self itk::FlatStructuringElement< NDimension >::Box ( RadiusType  radius  )  [static]

Various constructors

virtual void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::ComputeNeighborhoodOffsetTable (  )  [protected, virtual, inherited]

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

virtual void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::ComputeNeighborhoodStrideTable (  )  [protected, virtual, inherited]

Computes the entries for the stride table

ConstIterator itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::End ( void   )  const [inline, inherited]

Definition at line 146 of file itkNeighborhood.h.

Iterator itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::End ( void   )  [inline, inherited]

STL-style iterator support.

Definition at line 142 of file itkNeighborhood.h.

const AllocatorType& itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetBufferReference (  )  const [inline, inherited]

Definition at line 195 of file itkNeighborhood.h.

AllocatorType& itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetBufferReference (  )  [inline, inherited]

Returns a reference to the data buffer structure.

Definition at line 193 of file itkNeighborhood.h.

unsigned int itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetCenterNeighborhoodIndex (  )  const [inline, inherited]

Definition at line 213 of file itkNeighborhood.h.

bool itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetCenterValue (  )  const [inline, inherited]

Returns the element at the center of the neighborhood.

Definition at line 166 of file itkNeighborhood.h.

bool & itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetElement ( unsigned int  i  )  [inline, inherited]

Definition at line 161 of file itkNeighborhood.h.

virtual unsigned int itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetNeighborhoodIndex ( const OffsetType  )  const [virtual, inherited]

OffsetType itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::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.

unsigned long itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::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.

const SizeType itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetRadius ( void   )  const [inline, inherited]

Returns the radius of the neighborhood.

Definition at line 118 of file itkNeighborhood.h.

SizeType itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetSize ( void   )  const [inline, inherited]

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

Definition at line 132 of file itkNeighborhood.h.

unsigned long itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::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.

std::slice itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::GetSlice ( unsigned  int  )  const [inherited]

unsigned itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::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.

itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::itkStaticConstMacro ( NeighborhoodDimension  ,
unsigned  int,
VDimension   
) [inherited]

External support for dimensionality.

template<unsigned int NDimension>
itk::FlatStructuringElement< NDimension >::itkStaticConstMacro ( Dimension  ,
unsigned  int,
NDimension   
)

External support for dimensionality.

template<unsigned int NDimension>
itk::FlatStructuringElement< NDimension >::itkStaticConstMacro ( NeighborhoodDimension  ,
unsigned  int,
NDimension   
)

External support for dimensionality.

bool itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::operator!= ( const Self other  )  const [inline, inherited]

Not Equal operator.

Definition at line 110 of file itkNeighborhood.h.

bool itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::operator== ( const Self other  )  const [inline, inherited]

Comparison operator.

Definition at line 102 of file itkNeighborhood.h.

const bool & itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::operator[] ( const OffsetType o  )  const [inline, inherited]

Definition at line 202 of file itkNeighborhood.h.

bool & itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::operator[] ( const OffsetType o  )  [inline, inherited]

Get pixel value by offset

Definition at line 200 of file itkNeighborhood.h.

const bool & itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::operator[] ( unsigned int  i  )  const [inline, inherited]

Definition at line 159 of file itkNeighborhood.h.

bool & itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::operator[] ( unsigned int  i  )  [inline, inherited]

Pass-through data access methods to the buffer.

Definition at line 157 of file itkNeighborhood.h.

void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::Print ( std::ostream &  os  )  const [inline, inherited]

Standard itk object method.

Definition at line 189 of file itkNeighborhood.h.

virtual void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::PrintSelf ( std::ostream &  ,
Indent   
) const [protected, virtual, inherited]

Standard itk object method.

void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::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).

void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::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.

void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::SetRadius ( const SizeType  )  [inherited]

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

void itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::SetSize (  )  [inline, protected, inherited]

Sets the length along each dimension.

Definition at line 220 of file itkNeighborhood.h.

unsigned int itk::Neighborhood< bool , VDimension, NeighborhoodAllocator<bool > >::Size ( void   )  const [inline, inherited]

More STL-style support.

Definition at line 153 of file itkNeighborhood.h.


The documentation for this class was generated from the following file:
Generated at Sun Sep 23 17:00:57 2007 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000