Const version of ShapedNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pixels across an itk::Image. More...

#include <itkConstShapedNeighborhoodIterator.h>

Inheritance diagram for itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >:

Collaboration diagram for itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >:

List of all members.

Classes
struct	ConstIterator

Public Types
typedef TBoundaryCondition	BoundaryConditionType
typedef ImageBoundaryCondition < ImageType > *	ImageBoundaryConditionPointerType
typedef TImage	ImageType
typedef std::list< unsigned int >	IndexListType
typedef Index < itkGetStaticConstMacro(Dimension)>	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef TImage::InternalPixelType	InternalPixelType
typedef Neighborhood < PixelType, itkGetStaticConstMacro(Dimension)>	NeighborhoodType
typedef Superclass::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef TImage::PixelType	PixelType
typedef Superclass::RadiusType	RadiusType
typedef TImage::RegionType	RegionType
typedef ConstShapedNeighborhoodIterator	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef NeighborhoodIterator < TImage, TBoundaryCondition >	Superclass

Public Member Functions
	ConstShapedNeighborhoodIterator ()
	ConstShapedNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
virtual	~ConstShapedNeighborhoodIterator ()
virtual void	ActivateOffset (const OffsetType &off)
const ConstIterator &	Begin () const
virtual void	ClearActiveList ()
virtual void	DeactivateOffset (const OffsetType &off)
const ConstIterator &	End () const
const IndexListType &	GetActiveIndexList () const
IndexListType::size_type	GetActiveIndexListSize () const
Self &	operator++ ()
Self &	operator+= (const OffsetType &)
Self &	operator-- ()
Self &	operator-= (const OffsetType &)
Self &	operator= (const Self &orig)
virtual void	PrintSelf (std::ostream &, Indent) const

Static Public Attributes
static const unsigned int	Dimension = TImage::ImageDimension

Protected Member Functions
	ConstShapedNeighborhoodIterator (const ConstShapedNeighborhoodIterator &)
virtual void	ActivateIndex (const unsigned int)
virtual void	DeactivateIndex (const unsigned int)

Protected Attributes
IndexListType	m_ActiveIndexList
bool	m_CenterIsActive
ConstIterator	m_ConstBeginIterator
ConstIterator	m_ConstEndIterator

Private Types
typedef NeighborhoodAllocator < TImage::InternalPixelType * >	AllocatorType
typedef ImageBoundaryCondition < ImageType > const *	ImageBoundaryConditionConstPointerType
typedef Superclass::Iterator	Iterator
typedef ImageType::NeighborhoodAccessorFunctorType	NeighborhoodAccessorFunctorType
typedef SliceIterator < TImage::InternalPixelType *, Self >	SliceIteratorType

Private Member Functions
virtual void	Allocate (unsigned int i)
Iterator	Begin ()
OffsetType	ComputeInternalIndex (unsigned int n) const
virtual void	ComputeNeighborhoodOffsetTable ()
virtual void	ComputeNeighborhoodStrideTable ()
Iterator	End ()
IndexType	GetBeginIndex () const
IndexType	GetBound () const
long	GetBound (unsigned int n) const
const BoundaryConditionType *	GetBoundaryCondition () const
RegionType	GetBoundingBoxAsImageRegion () const
AllocatorType &	GetBufferReference ()
const AllocatorType &	GetBufferReference () const
unsigned int	GetCenterNeighborhoodIndex () const
PixelType	GetCenterPixel () const
const InternalPixelType *	GetCenterPointer () const
InternalPixelType *	GetCenterPointer ()
TImage::InternalPixelType *	GetCenterValue () const
TImage::InternalPixelType *&	GetElement (unsigned int i)
const ImageType *	GetImagePointer (void) const
virtual IndexType	GetIndex (void) const
virtual IndexType	GetIndex (const OffsetType &o) const
virtual IndexType	GetIndex (const unsigned i) const
bool	GetNeedToUseBoundaryCondition () const
virtual NeighborhoodType	GetNeighborhood () const
virtual unsigned int	GetNeighborhoodIndex (const OffsetType &) const
virtual PixelType	GetNext (const unsigned axis, const unsigned i) const
virtual PixelType	GetNext (const unsigned axis) const
OffsetType	GetOffset (unsigned int i) const
virtual PixelType	GetPixel (const unsigned i) const
virtual PixelType	GetPixel (const unsigned i, bool &IsInBounds) const
virtual PixelType	GetPixel (const OffsetType &o) const
virtual PixelType	GetPixel (const OffsetType &o, bool &IsInBounds) const
virtual PixelType	GetPrevious (const unsigned axis, const unsigned i) const
virtual PixelType	GetPrevious (const unsigned axis) const
const SizeType	GetRadius () const
unsigned long	GetRadius (const unsigned long n) const
RegionType	GetRegion () const
unsigned long	GetSize (const unsigned long n) const
SizeType	GetSize () const
std::slice	GetSlice (unsigned int) const
unsigned	GetStride (const unsigned axis) const
OffsetType	GetWrapOffset () const
OffsetValueType	GetWrapOffset (unsigned int n) const
virtual void	GoToBegin ()
virtual void	GoToEnd ()
bool	InBounds () const
virtual void	Initialize (const SizeType &radius, const ImageType *ptr, const RegionType &region)
virtual bool	IsAtBegin () const
virtual bool	IsAtEnd () const
void	NeedToUseBoundaryConditionOff ()
void	NeedToUseBoundaryConditionOn ()
bool	operator!= (const Self &other) const
bool	operator!= (const Self &it) const
OffsetType	operator- (const Self &b)
bool	operator< (const Self &it) const
bool	operator<= (const Self &it) const
bool	operator== (const Self &other) const
bool	operator== (const Self &it) const
bool	operator> (const Self &it) const
bool	operator>= (const Self &it) const
TImage::InternalPixelType *&	operator[] (unsigned int i)
const TImage::InternalPixelType *&	operator[] (unsigned int i) const
TImage::InternalPixelType *&	operator[] (const OffsetType &o)
const TImage::InternalPixelType *&	operator[] (const OffsetType &o) const
virtual void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
void	Print (std::ostream &os) const
virtual void	ResetBoundaryCondition ()
virtual void	SetBeginIndex (const IndexType &start)
virtual void	SetBound (const SizeType &)
void	SetBoundaryCondition (const TBoundaryCondition &c)
virtual void	SetCenterPixel (const PixelType &p)
virtual void	SetEndIndex ()
void	SetLocation (const IndexType &position)
virtual void	SetLoop (const IndexType &p)
void	SetNeedToUseBoundaryCondition (bool b)
virtual void	SetNeighborhood (const NeighborhoodType &)
virtual void	SetNext (const unsigned axis, const unsigned i, const PixelType &v)
virtual void	SetNext (const unsigned axis, const PixelType &v)
virtual void	SetPixel (const unsigned i, const PixelType &v, bool &status)
virtual void	SetPixel (const unsigned i, const PixelType &v)
virtual void	SetPixel (const OffsetType o, const PixelType &v)
virtual void	SetPixelPointers (const IndexType &)
virtual void	SetPrevious (const unsigned axis, const unsigned i, const PixelType &v)
virtual void	SetPrevious (const unsigned axis, const PixelType &v)
void	SetRadius (const SizeType &)
void	SetRadius (const unsigned long *rad)
void	SetRadius (const unsigned long)
void	SetSize ()
unsigned int	Size () const

Private Attributes
const InternalPixelType *	m_Begin
IndexType	m_BeginIndex
IndexType	m_Bound
ImageBoundaryConditionPointerType	m_BoundaryCondition
ImageType::ConstWeakPointer	m_ConstImage
const InternalPixelType *	m_End
IndexType	m_EndIndex
bool	m_InBounds [Dimension]
IndexType	m_InnerBoundsHigh
IndexType	m_InnerBoundsLow
TBoundaryCondition	m_InternalBoundaryCondition
bool	m_IsInBounds
bool	m_IsInBoundsValid
IndexType	m_Loop
bool	m_NeedToUseBoundaryCondition
NeighborhoodAccessorFunctorType	m_NeighborhoodAccessorFunctor
RegionType	m_Region
OffsetType	m_WrapOffset

Static Private Attributes
static const unsigned int	NeighborhoodDimension

Friends
struct	ConstIterator

Detailed Description

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
class itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >

Const version of ShapedNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pixels across an itk::Image.

ConstShapedNeighborhoodIterator implements the read-only methods of ShapedNeighborhoodIterator. A "shaped" neighborhood iterator is one that allows you to specify which neighbor elements are active and which are inactive. See ShapedNeighborhoodIterator for more information.

See also:: Neighborhood

MORE INFORMATION: For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from http://www.itk.org.

See also:: ImageConstIterator; ConditionalConstIterator; ConstNeighborhoodIterator; ConstShapedNeighborhoodIterator; ConstSliceIterator; CorrespondenceDataStructureIterator; FloodFilledFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalIterator; FloodFilledSpatialFunctionConditionalConstIterator; FloodFilledSpatialFunctionConditionalIterator; ImageConstIterator; ImageConstIteratorWithIndex; ImageIterator; ImageIteratorWithIndex; ImageLinearConstIteratorWithIndex; ImageLinearIteratorWithIndex; ImageRandomConstIteratorWithIndex; ImageRandomIteratorWithIndex; ImageRegionConstIterator; ImageRegionConstIteratorWithIndex; ImageRegionExclusionConstIteratorWithIndex; ImageRegionExclusionIteratorWithIndex; ImageRegionIterator; ImageRegionIteratorWithIndex; ImageRegionReverseConstIterator; ImageRegionReverseIterator; ImageReverseConstIterator; ImageReverseIterator; ImageSliceConstIteratorWithIndex; ImageSliceIteratorWithIndex; NeighborhoodIterator; PathConstIterator; PathIterator; ShapedNeighborhoodIterator; SliceIterator; ImageConstIteratorWithIndex

Definition at line 70 of file itkConstShapedNeighborhoodIterator.h.

Member Typedef Documentation

typedef NeighborhoodAllocator<TImage::InternalPixelType * > itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::AllocatorType

inherited

External support for allocator type.

Definition at line 63 of file itkNeighborhood.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TBoundaryCondition itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::BoundaryConditionType

Typedef for boundary condition type.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 106 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef ImageBoundaryCondition<ImageType> const* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionConstPointerType

inherited

Definition at line 98 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef ImageBoundaryCondition<ImageType>* itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionPointerType

Typedef for generic boundary condition pointer

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 109 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TImage itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType

Typedef support for common objects

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 94 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef std::list<unsigned int> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListType

An stl storage container type that can be sorted. The type used for the list of active offsets in the neighborhood.

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

Definition at line 103 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Index<itkGetStaticConstMacro(Dimension)> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexType

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 96 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef IndexType::IndexValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexValueType

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 97 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TImage::InternalPixelType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::InternalPixelType

Extract image type information.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 76 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::Iterator itk::NeighborhoodIterator< TImage, TBoundaryCondition >::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 from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

Definition at line 230 of file itkNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef ImageType::NeighborhoodAccessorFunctorType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodAccessorFunctorType

inherited

Typedef for the functor used to access neighborhoods of pixel pointers. This is obtained as a trait from the image and is different for Image and VectorImage.

Definition at line 90 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Neighborhood<PixelType, itkGetStaticConstMacro(Dimension)> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodType

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 99 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::OffsetType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetType

Inherit typedefs from superclass

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 87 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef OffsetType::OffsetValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetValueType

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 88 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TImage::PixelType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType

External support for pixel type.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 77 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::RadiusType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RadiusType

Radius typedef support.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 89 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef TImage::RegionType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 95 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef ConstShapedNeighborhoodIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Self

Standard class typedefs.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 83 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::SizeType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeType

Size and value typedef support.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 90 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef Superclass::SizeValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeValueType

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 91 of file itkConstShapedNeighborhoodIterator.h.

typedef SliceIterator<TImage::InternalPixelType * , Self> itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::SliceIteratorType

inherited

External slice iterator type typedef support.

Definition at line 88 of file itkNeighborhood.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

typedef NeighborhoodIterator<TImage, TBoundaryCondition> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 84 of file itkConstShapedNeighborhoodIterator.h.

Constructor & Destructor Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator ( )

inline

Default constructor

Definition at line 208 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::~ConstShapedNeighborhoodIterator ( )

inlinevirtual

Virtual destructor

Definition at line 217 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator	(	const SizeType &	radius,
		const ImageType *	ptr,
		const RegionType &	region
	)

inline

Constructor which establishes the region size, neighborhood, and image over which to walk.

Definition at line 221 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator ( const ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > & )

protected

Copy constructor

Member Function Documentation

template<class TImage , class TBoundaryCondition >

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateIndex ( const unsigned int n )

protectedvirtual

Class is protected here so that it is not publicly accessible, but can be accessed by subclasses.. Add/Remove a neighborhood index to/from the active. Locations in the active list are the only accessible elements in the neighborhood. The argument is an index location calculated as an offset into a linear array which represents the image region defined by the radius of this iterator, with the smallest dimension as the fastest increasing index.

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

Definition at line 45 of file itkConstShapedNeighborhoodIterator.txx.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateOffset ( const OffsetType & off )

inlinevirtual

Add/Remove a neighborhood offset (from the center of the neighborhood) to/from the active list. Active list offsets are the only locations updated and accessible through the iterator.

Definition at line 284 of file itkConstShapedNeighborhoodIterator.h.

Referenced by itk::Statistics::ImageToCooccurrenceListAdaptor< TImage >::Compute(), otb::LocalRxDetectorNonThreadFilter< TInputImage, TOutputImage >::GenerateData(), and otb::LocalRxDetectorFilter< TInputImage, TOutputImage >::ThreadedGenerateData().

virtual void itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::Allocate ( unsigned int i )

inlineprotectedvirtualinherited

Allocates the neighborhood's memory buffer.

Definition at line 236 of file itkNeighborhood.h.

Iterator itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::Begin ( void )

inlineinherited

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

Definition at line 154 of file itkNeighborhood.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const ConstIterator& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Begin ( void ) const

inline

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.

Definition at line 199 of file itkConstShapedNeighborhoodIterator.h.

Referenced by otb::LocalRxDetectorNonThreadFilter< TInputImage, TOutputImage >::GenerateData(), itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GenerateData(), and otb::LocalRxDetectorFilter< TInputImage, TOutputImage >::ThreadedGenerateData().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ClearActiveList ( )

inlinevirtual

Removes all active pixels from this neighborhood.

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

Definition at line 290 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ComputeInternalIndex ( unsigned int n ) const

inherited

Computes the internal, N-d offset of a pixel array position n from (0,0, ..., 0) in the "upper-left" corner of the neighborhood.

Definition at line 129 of file itkConstNeighborhoodIterator.txx.

virtual void itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::ComputeNeighborhoodOffsetTable ( )

protectedvirtualinherited

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

virtual void itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::ComputeNeighborhoodStrideTable ( )

protectedvirtualinherited

Computes the entries for the stride table

template<class TImage , class TBoundaryCondition >

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateIndex ( const unsigned int n )

protectedvirtual

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

Definition at line 97 of file itkConstShapedNeighborhoodIterator.txx.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateOffset ( const OffsetType & off )

inlinevirtual

Definition at line 286 of file itkConstShapedNeighborhoodIterator.h.

Iterator itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::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.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const ConstIterator& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::End ( void ) const

inline

Returns a const iterator for the neighborhood which points to the last pixel in the neighborhood.

Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.

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

Definition at line 204 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const IndexListType& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::GetActiveIndexList ( ) const

inline

Returns the list of active indicies in the neighborhood

Definition at line 299 of file itkConstShapedNeighborhoodIterator.h.

Referenced by itk::ReconstructionImageFilter< TInputImage, TOutputImage, TCompare >::GenerateData(), and itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >::GenerateData().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexListType::size_type itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::GetActiveIndexListSize ( ) const

inline

Returns the size of the list of active neighborhood indicies.

Definition at line 303 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBeginIndex ( ) const

inlineinherited

Returns the N-dimensional starting index of the iterator's position on the image.

Definition at line 243 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBound ( ) const

inlineinherited

Returns the array of upper loop bounds used during iteration.

Definition at line 134 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

long itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBound ( unsigned int n ) const

inlineinherited

Returns the loop bound used to define the edge of a single dimension in the itk::Image region.

Definition at line 139 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const BoundaryConditionType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBoundaryCondition ( ) const

inlineinherited

Definition at line 396 of file itkConstNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

ConstNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetBoundingBoxAsImageRegion ( ) const

inherited

Returns a bounding box for the region spanned by this neighborhood represented by an itk::ImageRegion

Definition at line 147 of file itkConstNeighborhoodIterator.txx.

AllocatorType& itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetBufferReference ( )

inlineinherited

Returns a reference to the data buffer structure.

Definition at line 200 of file itkNeighborhood.h.

const AllocatorType& itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetBufferReference ( ) const

inlineinherited

Definition at line 202 of file itkNeighborhood.h.

unsigned int itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetCenterNeighborhoodIndex ( ) const

inlineinherited

Definition at line 218 of file itkNeighborhood.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPixel ( ) const

inlineinherited

Returns the pixel referenced at the center of the ConstNeighborhoodIterator.

Definition at line 148 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPointer ( ) const

inlineinherited

Returns the pointer to the center pixel of the neighborhood.

Definition at line 143 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::operator!=(), itk::ConstNeighborhoodIterator< TSparseImageType >::operator<(), itk::ConstNeighborhoodIterator< TSparseImageType >::operator<=(), itk::ConstNeighborhoodIterator< TSparseImageType >::operator==(), itk::ConstNeighborhoodIterator< TSparseImageType >::operator>(), and itk::ConstNeighborhoodIterator< TSparseImageType >::operator>=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

InternalPixelType* itk::NeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPointer ( )

inlineinherited

Returns the central memory pointer of the neighborhood.

Definition at line 258 of file itkNeighborhoodIterator.h.

Referenced by itk::watershed::Segmenter< TInputImage >::GradientDescent().

TImage::InternalPixelType * itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetCenterValue ( ) const

inlineinherited

Returns the element at the center of the neighborhood.

Definition at line 174 of file itkNeighborhood.h.

TImage::InternalPixelType * & itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetElement ( unsigned int i )

inlineinherited

Definition at line 170 of file itkNeighborhood.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const ImageType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetImagePointer ( void ) const

inlineinherited

Returns a smartpointer to the image on which this iterator operates.

Definition at line 152 of file itkConstNeighborhoodIterator.h.

Referenced by itk::PeriodicBoundaryCondition< TImage >::operator()().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( void ) const

inlinevirtualinherited

Returns the N-dimensional index of the iterator's position in the image.

Definition at line 157 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( const OffsetType & o ) const

inlinevirtualinherited

Returns the image index for neighbor pixel at offset o from the center of the neighborhood.

Definition at line 229 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::GetIndex().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex ( const unsigned i ) const

inlinevirtualinherited

Returns the image index for neighbor pixel at index i in the neighborhood.

Definition at line 234 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::GetIndex().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeedToUseBoundaryCondition ( ) const

inlineinherited

Definition at line 412 of file itkConstNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood ( ) const

virtualinherited

Virtual function that "dereferences" a ConstNeighborhoodIterator, returning a Neighborhood of pixel values.

Definition at line 248 of file itkConstNeighborhoodIterator.txx.

References itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin(), and itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius().

Referenced by otb::TextureImageFunction< TInputImage, TFunctor, TCoordRep >::EvaluateAtIndex(), itk::StochasticFractalDimensionImageFilter< TInputImage, TMaskImage, TOutputImage >::GenerateData(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::GenerateData(), and otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::ThreadedGenerateData().

virtual unsigned int itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetNeighborhoodIndex ( const OffsetType & ) const

virtualinherited

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext	(	const unsigned	axis,
		const unsigned	i
	)		const

inlinevirtualinherited

Returns the pixel value located i pixels distant from the neighborhood center in the positive specified ``axis'' direction. No bounds checking is done on the size of the neighborhood.

Definition at line 202 of file itkConstNeighborhoodIterator.h.

Referenced by itk::NormalVectorDiffusionFunction< TSparseImageType >::ComputeSparseUpdate(), itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood(), itk::WarpHarmonicEnergyCalculator< TInputImage >::EvaluateAtNeighborhood(), itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood(), itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood(), itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood3D(), itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood(), itk::NormalVectorDiffusionFunction< TSparseImageType >::PrecomputeSparseUpdate(), and itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateDataFull().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext ( const unsigned axis ) const

inlinevirtualinherited

Returns the pixel value located one pixel distant from the neighborhood center in the specifed positive axis direction. No bounds checking is done on the size of the neighborhood.

Definition at line 209 of file itkConstNeighborhoodIterator.h.

OffsetType itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::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 otb::RealMomentsImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex(), otb::ComplexMomentsImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex(), otb::FourierMellinDescriptorsImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex(), otb::HuMomentsImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex(), otb::FlusserMomentsImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex(), and itk::FastChamferDistanceImageFilter< TInputImage, TOutputImage >::GenerateDataND().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel ( const unsigned i ) const

inlinevirtualinherited

Returns the pixel value located at a linear array location i.

Definition at line 165 of file itkConstNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

ConstNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel	(	const unsigned	i,
		bool &	IsInBounds
	)		const

virtualinherited

Return the pixel value located at a linear array location i. Sets "IsInBounds" to true if the location is inside the image and the pixel value returned is an actual pixel in the image. Sets "IsInBounds" to false if the location is outside the image and the pixel value returned is a boundary condition.

Definition at line 53 of file itkConstNeighborhoodIterator.txx.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel ( const OffsetType & o ) const

inlinevirtualinherited

Returns the pixel value located at the itk::Offset o from the center of the neighborhood.

Definition at line 184 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel	(	const OffsetType &	o,
		bool &	IsInBounds
	)		const

inlinevirtualinherited

Returns the pixel value located at the itk::Offset o from the center of the neighborhood. Sets "IsInBounds" to true if the offset is inside the image and the pixel value returned is an actual pixel in the image. Sets "IsInBounds" to false if the offset is outside the image and the pixel value returned is a boundary condition.

Definition at line 195 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::GetPixel().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious	(	const unsigned	axis,
		const unsigned	i
	)		const

inlinevirtualinherited

Returns the pixel value located i pixels distant from the neighborhood center in the negative specified ``axis'' direction. No bounds checking is done on the size of the neighborhood.

Definition at line 216 of file itkConstNeighborhoodIterator.h.

Referenced by itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood(), itk::WarpHarmonicEnergyCalculator< TInputImage >::EvaluateAtNeighborhood(), itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood(), itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood(), itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood3D(), itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood(), itk::NormalVectorDiffusionFunction< TSparseImageType >::PrecomputeSparseUpdate(), and itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateDataFull().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual PixelType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious ( const unsigned axis ) const

inlinevirtualinherited

Returns the pixel value located one pixel distant from the neighborhood center in the specifed negative axis direction. No bounds checking is done on the size of the neighborhood.

Definition at line 223 of file itkConstNeighborhoodIterator.h.

const SizeType itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetRadius ( void ) const

inlineinherited

Returns the radius of the neighborhood.

Definition at line 128 of file itkNeighborhood.h.

unsigned long itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::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 TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetRegion ( void ) const

inlineinherited

Returns the region of iteration.

Definition at line 238 of file itkConstNeighborhoodIterator.h.

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

SizeType itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetSize ( void ) const

inlineinherited

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

Definition at line 142 of file itkNeighborhood.h.

std::slice itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::GetSlice ( unsigned int ) const

inherited

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

Referenced by itk::watershed::Segmenter< TInputImage >::GenerateConnectivity(), itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeActiveLayerValues(), and itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateDataFull().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetWrapOffset ( ) const

inlineinherited

Returns the offsets used to wrap across dimensional boundaries.

Definition at line 251 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

OffsetValueType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetWrapOffset ( unsigned int n ) const

inlineinherited

Returns the internal offset associated with wrapping around a single dimension's region boundary in the itk::Image. An offset for each dimension is necessary to shift pointers when wrapping around region edges because region memory is not necessarily contiguous within the buffer.

Definition at line 259 of file itkConstNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToBegin ( void )

virtualinherited

Virtual method for rewinding the iterator to its beginning pixel. This is useful for writing functions which take neighborhood iterators of arbitrary type and must use virtual functions.

Definition at line 332 of file itkConstNeighborhoodIterator.txx.

template<class TImage , class TBoundaryCondition >

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToEnd ( )

virtualinherited

Virtual method for sending the iterator to one past the last pixel in its region.

Definition at line 340 of file itkConstNeighborhoodIterator.txx.

Referenced by itk::ReconstructionImageFilter< TInputImage, TOutputImage, TCompare >::GenerateData(), and itk::FastChamferDistanceImageFilter< TInputImage, TOutputImage >::GenerateDataND().

template<class TImage , class TBoundaryCondition >

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::InBounds ( ) const

inherited

Returns false if the iterator overlaps region boundaries, true otherwise. Also updates an internal boolean array indicating which of the iterator's faces are out of bounds.

Definition at line 25 of file itkConstNeighborhoodIterator.txx.

Referenced by otb::ImageToSIFTKeyPointSetFilter< TInputImage, TOutputPointSet >::DetectKeyPoint(), and otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::GenerateData().

template<class TImage , class TBoundaryCondition >

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::Initialize	(	const SizeType &	radius,
		const ImageType *	ptr,
		const RegionType &	region
	)

virtualinherited

Initializes the iterator to walk a particular image and a particular region of that image.

Definition at line 347 of file itkConstNeighborhoodIterator.txx.

References itk::Index< VIndexDimension >::GetIndex(), and itk::Size< VDimension >::GetSize().

Referenced by otb::SubPixelDisparityImageFilter< TInputImage, TOutputMetricImage, TDisparityImage, TMaskImage, TBlockMatchingFunctor >::DichotomyRefinement(), otb::DisparityMapMedianFilter< TInputImage, TOutputImage, TMask >::GenerateData(), otb::SubPixelDisparityImageFilter< TInputImage, TOutputMetricImage, TDisparityImage, TMaskImage, TBlockMatchingFunctor >::ParabolicRefinement(), and otb::SubPixelDisparityImageFilter< TInputImage, TOutputMetricImage, TDisparityImage, TMaskImage, TBlockMatchingFunctor >::TriangularRefinement().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtBegin ( void ) const

inlinevirtualinherited

Virtual method for determining whether the iterator is at the beginning of its iteration region.

Definition at line 278 of file itkConstNeighborhoodIterator.h.

Referenced by itk::FastChamferDistanceImageFilter< TInputImage, TOutputImage >::GenerateDataND().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd ( void ) const

inlinevirtualinherited

Virtual method for determining whether the iterator has reached the end of its iteration region.

Definition at line 283 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeedToUseBoundaryConditionOff ( )

inlineinherited

Definition at line 404 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::NeedToUseBoundaryConditionOn ( )

inlineinherited

Definition at line 400 of file itkConstNeighborhoodIterator.h.

bool itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::operator!= ( const Self & other ) const

inlineinherited

Not Equal operator.

Definition at line 120 of file itkNeighborhood.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator!= ( const Self & it ) const

inlineinherited

Returns a boolean != comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 320 of file itkConstNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator++ ( )

Reimplements the operator++ method so that only active pixel locations are updated.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

Definition at line 133 of file itkConstShapedNeighborhoodIterator.txx.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator++().

template<class TImage , class TBoundaryCondition >

ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator+= ( const OffsetType & idx )

Addition of an itk::Offset. Note that this method does not do any bounds checking. Adding an offset that moves the iterator out of its assigned region will produce undefined results.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

Definition at line 258 of file itkConstShapedNeighborhoodIterator.txx.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator+=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator- ( const Self & b )

inlineinherited

Distance between two iterators

Definition at line 369 of file itkConstNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator-- ( )

Reimplements the operator– method so that only active pixel locations are updated.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

Definition at line 194 of file itkConstShapedNeighborhoodIterator.txx.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator--().

template<class TImage , class TBoundaryCondition >

ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator-= ( const OffsetType & idx )

Subtraction of an itk::Offset. Note that this method does not do any bounds checking. Subtracting an offset that moves the iterator out of its assigned region will produce undefined results.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

Definition at line 316 of file itkConstShapedNeighborhoodIterator.txx.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator-=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator< ( const Self & it ) const

inlineinherited

Returns a boolean < comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 326 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator<= ( const Self & it ) const

inlineinherited

Returns a boolean < comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 332 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator= ( const Self & orig )

inline

Assignment operator

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 266 of file itkConstShapedNeighborhoodIterator.h.

bool itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::operator== ( const Self & other ) const

inlineinherited

Comparison operator.

Definition at line 112 of file itkNeighborhood.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator== ( const Self & it ) const

inlineinherited

Returns a boolean == comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 314 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator> ( const Self & it ) const

inlineinherited

Returns a boolean > comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 338 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator>= ( const Self & it ) const

inlineinherited

Returns a boolean >= comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.

Definition at line 344 of file itkConstNeighborhoodIterator.h.

TImage::InternalPixelType * & itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::operator[] ( unsigned int i )

inlineinherited

Pass-through data access methods to the buffer.

Definition at line 166 of file itkNeighborhood.h.

const TImage::InternalPixelType * & itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::operator[] ( unsigned int i ) const

inlineinherited

Definition at line 168 of file itkNeighborhood.h.

TImage::InternalPixelType * & itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::operator[] ( const OffsetType & o )

inlineinherited

Get pixel value by offset

Definition at line 206 of file itkNeighborhood.h.

const TImage::InternalPixelType * & itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::operator[] ( const OffsetType & o ) const

inlineinherited

Definition at line 208 of file itkNeighborhood.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::OverrideBoundaryCondition ( const ImageBoundaryConditionPointerType i )

inlinevirtualinherited

Allows a user to override the internal boundary condition. Care should be taken to ensure that the overriding boundary condition is a persistent object during the time it is referenced. The overriding condition can be of a different type than the default type as long as it is a subclass of ImageBoundaryCondition.

Definition at line 382 of file itkConstNeighborhoodIterator.h.

void itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::Print ( std::ostream & os ) const

inlineinherited

Standard itk object method.

Definition at line 196 of file itkNeighborhood.h.

template<class TImage , class TBoundaryCondition >

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

virtual

Standard itk print method

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 26 of file itkConstShapedNeighborhoodIterator.txx.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::ResetBoundaryCondition ( )

inlinevirtualinherited

Resets the boundary condition to the internal, default conditions specified by the template parameter.

Definition at line 388 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBeginIndex ( const IndexType & start )

inlineprotectedvirtualinherited

Default method for setting the index of the first pixel in the iteration region.

Definition at line 437 of file itkConstNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBound ( const SizeType & size )

protectedvirtualinherited

Virtual method for setting internal loop boundaries. This method must be defined in each subclass because each subclass may handle loop boundaries differently.

Definition at line 554 of file itkConstNeighborhoodIterator.txx.

References itk::Index< VIndexDimension >::GetIndex(), and itk::Size< VDimension >::GetSize().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetBoundaryCondition ( const TBoundaryCondition & c )

inlineinherited

Sets the internal, default boundary condition.

Definition at line 392 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetCenterPixel ( const PixelType & p )

inlinevirtualinherited

Returns the central pixel of the neighborhood.

Definition at line 262 of file itkNeighborhoodIterator.h.

Referenced by itk::BinaryPruningImageFilter< TInputImage, TOutputImage >::ComputePruneImage(), itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ConstructActiveLayer(), itk::MRFImageFilter< TInputImage, TClassifiedImage >::DoNeighborhoodOperation(), itk::StochasticFractalDimensionImageFilter< TInputImage, TMaskImage, TOutputImage >::GenerateData(), otb::MarkovRandomFieldFilter< TInputImage, TClassifiedImage >::MinimizeOnce(), and itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PropagateLayerValues().

template<class TImage , class TBoundaryCondition >

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetEndIndex ( )

protectedvirtualinherited

Default method for setting the index of the first pixel in the iteration region.

Definition at line 230 of file itkConstNeighborhoodIterator.txx.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetLocation ( const IndexType & position )

inlineinherited

This method positions the iterator at an indexed location in the image. SetLocation should NOT be used to update the position of the iterator during iteration, only for initializing it to a position prior to iteration. This method is not optimized for speed.

Definition at line 351 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetLoop ( const IndexType & p )

inlineprotectedvirtualinherited

Default method for setting the coordinate location of the iterator. Loop indicies correspond to the actual Image region index.

Definition at line 421 of file itkConstNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetNeedToUseBoundaryCondition ( bool b )

inlineinherited

Definition at line 408 of file itkConstNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetNeighborhood ( const NeighborhoodType & N )

virtualinherited

Virtual function that replaces the pixel values in the image neighborhood that are pointed to by this NeighborhoodIterator with the pixel values contained in a Neighborhood.

Definition at line 150 of file itkNeighborhoodIterator.txx.

References itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetNext	(	const unsigned	axis,
		const unsigned	i,
		const PixelType &	v
	)

inlinevirtualinherited

Sets the pixel value located i pixels distant from the neighborhood center in the positive specified ``axis'' direction. No bounds checking is done on the size of the neighborhood.

Definition at line 287 of file itkNeighborhoodIterator.h.

Referenced by itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateDataFull().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetNext	(	const unsigned	axis,
		const PixelType &	v
	)

inlinevirtualinherited

Sets the pixel value located one pixel distant from the neighborhood center in the specifed positive axis direction. No bounds checking is done on the size of the neighborhood.

Definition at line 296 of file itkNeighborhoodIterator.h.

template<class TImage , class TBoundaryCondition >

void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPixel	(	const unsigned	i,
		const PixelType &	v,
		bool &	status
	)

virtualinherited

Special SetPixel method which quietly ignores out-of-bounds attempts. Sets status TRUE if pixel has been set, FALSE otherwise.

Definition at line 87 of file itkNeighborhoodIterator.txx.

Referenced by itk::MRFImageFilter< TInputImage, TClassifiedImage >::DoNeighborhoodOperation(), itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Evaluate(), itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Evaluate(), itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::GenerateData(), itk::FastChamferDistanceImageFilter< TInputImage, TOutputImage >::GenerateDataND(), itk::watershed::Segmenter< TInputImage >::LabelMinima(), and itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >::UpdatePixel().

template<class TImage , class TBoundaryCondition >

void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPixel	(	const unsigned	i,
		const PixelType &	v
	)

virtualinherited

Set the pixel at the ith location.

Definition at line 24 of file itkNeighborhoodIterator.txx.

References itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPixel	(	const OffsetType	o,
		const PixelType &	v
	)

inlinevirtualinherited

Set the pixel at offset o from the neighborhood center

Definition at line 280 of file itkNeighborhoodIterator.h.

Referenced by itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >::SetPixel().

template<class TImage , class TBoundaryCondition >

void itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetPixelPointers ( const IndexType & pos )

protectedvirtualinherited

Default method for setting the values of the internal pointers to itk::Image memory buffer locations. This method should generally only be called when the iterator is initialized.

See also:: SetLocation

Definition at line 581 of file itkConstNeighborhoodIterator.txx.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPrevious	(	const unsigned	axis,
		const unsigned	i,
		const PixelType &	v
	)

inlinevirtualinherited

Sets the pixel value located i pixels distant from the neighborhood center in the negative specified ``axis'' direction. No bounds checking is done on the size of the neighborhood.

Definition at line 303 of file itkNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

virtual void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPrevious	(	const unsigned	axis,
		const PixelType &	v
	)

inlinevirtualinherited

Sets the pixel value located one pixel distant from the neighborhood center in the specifed negative axis direction. No bounds checking is done on the size of the neighborhood.

Definition at line 312 of file itkNeighborhoodIterator.h.

void itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::SetRadius ( const SizeType & )

inherited

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

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

void itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::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< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::SetSize ( )

inlineprotectedinherited

Sets the length along each dimension.

Definition at line 227 of file itkNeighborhood.h.

Referenced by otb::LineDetectorImageFilterBase< TInputImage, TOutputImage, TOutputImageDirection, TInterpolator >::ThreadedGenerateData().

unsigned int itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::Size ( void ) const

inlineinherited

More STL-style support.

Definition at line 162 of file itkNeighborhood.h.

Friends And Related Function Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

friend struct ConstIterator

friend

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 333 of file itkConstShapedNeighborhoodIterator.h.

Member Data Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const unsigned int itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Dimension = TImage::ImageDimension

static

Save the image dimension.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

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

Definition at line 80 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexListType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ActiveIndexList

protected

Definition at line 349 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Begin

protectedinherited

A pointer to the first pixel in the iteration region.

Definition at line 452 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_BeginIndex

protectedinherited

The starting index for iteration within the itk::Image region on which this ConstNeighborhoodIterator is defined.

Definition at line 446 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Bound

protectedinherited

An array of upper looping boundaries used during iteration.

Definition at line 449 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

ImageBoundaryConditionPointerType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_BoundaryCondition

protectedinherited

Pointer to the actual boundary condition that will be used. By default this points to m_BoundaryCondition, but OverrideBoundaryCondition allows a user to point this variable an external boundary condition.

Definition at line 481 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_CenterIsActive

protected

Definition at line 348 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstBeginIterator

protected

Definition at line 351 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstEndIterator

protected

Definition at line 350 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

ImageType::ConstWeakPointer itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstImage

protectedinherited

The image on which iteration is defined.

Definition at line 455 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

const InternalPixelType* itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_End

protectedinherited

A pointer to one past the last pixel in the iteration region.

Definition at line 458 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_EndIndex

protectedinherited

The end index for iteration within the itk::Image region on which this ConstNeighborhoodIterator is defined.

Definition at line 462 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InBounds[Dimension]

mutableprotectedinherited

Denotes which of the iterators dimensional sides spill outside region of interest boundaries.

Definition at line 485 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InnerBoundsHigh

protectedinherited

Upper threshold of in-bounds loop counter values.

Definition at line 499 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InnerBoundsLow

protectedinherited

Lower threshold of in-bounds loop counter values.

Definition at line 496 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

TBoundaryCondition itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_InternalBoundaryCondition

protectedinherited

Default boundary condition.

Definition at line 502 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_IsInBounds

mutableprotectedinherited

Denotes if iterator is entirely within bounds

Definition at line 488 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_IsInBoundsValid

mutableprotectedinherited

Is the m_InBounds and m_IsInBounds variables up to date? Set to false whenever the iterator is repositioned. Set to true within InBounds().

Definition at line 493 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

IndexType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Loop

protectedinherited

Array of loop counters used during iteration.

Definition at line 465 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TSparseImageType >::operator-(), and itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

bool itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_NeedToUseBoundaryCondition

protectedinherited

Does the specified region need to worry about boundary conditions?

Definition at line 505 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

NeighborhoodAccessorFunctorType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_NeighborhoodAccessorFunctor

protectedinherited

Functor type used to access neighborhoods of pixel pointers

Definition at line 508 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

RegionType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_Region

protectedinherited

The region over which iteration is defined.

Definition at line 468 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

OffsetType itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::m_WrapOffset

protectedinherited

The internal array of offsets that provide support for regions of interest. An offset for each dimension is necessary to shift pointers when wrapping around region edges because region memory is not necessarily contiguous within the buffer.

Definition at line 475 of file itkConstNeighborhoodIterator.h.

Referenced by itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

const unsigned int itk::Neighborhood< TImage::InternalPixelType * , VDimension, NeighborhoodAllocator<TImage::InternalPixelType * > >::NeighborhoodDimension

staticinherited

External support for dimensionality.

Definition at line 66 of file itkNeighborhood.h.

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> class itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
class itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >