[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]

| RestrictedNeighborhoodCirculator [Image Iterator Adapters] |

Circulator that walks around a given location in a given image, unsing a restricted neighborhood. More...

`#include <vigra/pixelneighborhood.hxx>`

Inheritance diagram for RestrictedNeighborhoodCirculator:

List of all members.

## Public Types

typedef IMAGEITERATOR | base_type
typedef BaseType::difference_type | difference_type
typedef BaseType::Direction | Direction
typedef BaseType::index_reference | index_reference
typedef BaseType::iterator_category | iterator_category
typedef NEIGHBORCODE | NeighborCode
typedef BaseType::pointer | pointer
typedef BaseType::reference | reference
typedef BaseType::value_type | value_type

## Public Member Functions

base_type const & | base () const
base_type | center () const
Diff2D const & | diff () const
Direction | direction () const
unsigned int | directionBit () const
bool | isDiagonal () const
bool | operator!= (RestrictedNeighborhoodCirculator const &rhs) const
reference | operator* () const
RestrictedNeighborhoodCirculator | operator+ (difference_type d) const
RestrictedNeighborhoodCirculator | operator++ (int)
RestrictedNeighborhoodCirculator & | operator++ ()
RestrictedNeighborhoodCirculator & | operator+= (difference_type d)
difference_type | operator- (RestrictedNeighborhoodCirculator const &rhs) const
RestrictedNeighborhoodCirculator | operator- (difference_type d) const
RestrictedNeighborhoodCirculator | operator-- (int)
RestrictedNeighborhoodCirculator & | operator-- ()
RestrictedNeighborhoodCirculator & | operator-= (difference_type d)
pointer | operator-> () const
bool | operator== (RestrictedNeighborhoodCirculator const &rhs) const
| RestrictedNeighborhoodCirculator (IMAGEITERATOR const &center=IMAGEITERATOR(), AtImageBorder atBorder=NotAtBorder)

## Detailed Description

### template<class IMAGEITERATOR, class NEIGHBORCODE>
class vigra::RestrictedNeighborhoodCirculator< IMAGEITERATOR, NEIGHBORCODE >

Circulator that walks around a given location in a given image, unsing a restricted neighborhood.

This circulator behaves essentially like vigra::NeighborhoodCirculator, but can also be used near the image border, where some of the neighbor points would be outside the image und must not be accessed. The template parameters define the kind of neighborhood used (four or eight) and the underlying image, whereas the required neighbirhood restriction is given by the last constructur argument. This below for typical usage.

The access functions return the value of the current neighbor pixel. Use `center()` to access the center pixel of the neighborhood.

Usage:

#include <vigra/pixelneighborhood.hxx>
Namespace: vigra

        BImage::traverser upperleft(...), lowerright(...);

        int width  = lowerright.x - upperleft.x;
        int height = lowerright.y - upperleft.y;

        for(int y=0; y<height; ++y, ++upperleft.y)
        {
            BImage::traverser ix = upperleft;
            for(int x=0; x<width; ++x, ++ix.x)
            {
                // use FourNeighborCode instead of EightNeighborCode for 4-neighborhood
                RestrictedNeighborhoodCirculator<BImage::traverser, EightNeighborCode>
                               circulator(ix, isAtImageBorder(x, y, width, height)),
                               end(circulator);
                do
                {
                    ... // do something with the circulator
                }
                while(++circulator != end); // out-of-range pixels will be automatically skipped
            }
        }

## Member Typedef Documentation

typedef IMAGEITERATOR base_type

type of the underlying image iterator

Reimplemented from NeighborhoodCirculator.

typedef BaseType::difference_type difference_type

the circulator's difference type (argument type of `circ[diff]`)

Reimplemented from NeighborhoodCirculator.

typedef BaseType::Direction Direction

type of the direction code

Reimplemented from NeighborhoodCirculator.

typedef BaseType::index_reference index_reference

the circulator's index reference type (return type of `circ[n]`)

Reimplemented from NeighborhoodCirculator.

typedef BaseType::iterator_category iterator_category

the circulator tag (random_access_circulator_tag)

Reimplemented from NeighborhoodCirculator.

typedef NEIGHBORCODE NeighborCode

type of the used neighbor code

Reimplemented from NeighborhoodCirculator.

typedef BaseType::pointer pointer

the circulator's pointer type (return type of `operator->`)

Reimplemented from NeighborhoodCirculator.

typedef BaseType::reference reference

the circulator's reference type (return type of `*circ`)

Reimplemented from NeighborhoodCirculator.

typedef BaseType::value_type value_type

the circulator's value type

Reimplemented from NeighborhoodCirculator.

## Constructor & Destructor Documentation

RestrictedNeighborhoodCirculator | ( | IMAGEITERATOR const & | center = `IMAGEITERATOR()`,
|  | AtImageBorder | atBorder = `NotAtBorder` |
| ) |  |  |

Construct circulator with given `center` pixel, using the restricted neighborhood given by atBorder.

## Member Function Documentation

base_type const& base | ( |  | ) | const

Get the base iterator for the current neighbor.

Reimplemented from NeighborhoodCirculator.

base_type center | ( |  | ) | const

Get the base iterator for the center of the circulator.

Reimplemented from NeighborhoodCirculator.

Diff2D const& diff | ( |  | ) | const

Get the difference vector (Diff2D) from the center to the current neighbor.

Reimplemented from NeighborhoodCirculator.

Direction direction | ( |  | ) | const

Get the current direction.

Reimplemented from NeighborhoodCirculator.

unsigned int directionBit | ( |  | ) | const

Get the current direction bit.

Reimplemented from NeighborhoodCirculator.

bool isDiagonal | ( |  | ) | const

Is the current neighbor a diagonal neighbor?

Reimplemented from NeighborhoodCirculator.

bool operator!= | ( | RestrictedNeighborhoodCirculator< IMAGEITERATOR, NEIGHBORCODE > const & | rhs | ) | const

inequality

reference operator* | ( |  | ) | const

dereference

Reimplemented from NeighborhoodCirculator.

RestrictedNeighborhoodCirculator operator+ | ( | difference_type | d | ) | const

addition

RestrictedNeighborhoodCirculator operator++ | ( | int |  | ) |

pre-decrement

Reimplemented from NeighborhoodCirculator.

RestrictedNeighborhoodCirculator& operator++ | ( |  | ) |

pre-increment

Reimplemented from NeighborhoodCirculator.

RestrictedNeighborhoodCirculator& operator+= | ( | difference_type | d | ) |

add-assignment

difference_type operator- | ( | RestrictedNeighborhoodCirculator< IMAGEITERATOR, NEIGHBORCODE > const & | rhs | ) | const

subtraction

RestrictedNeighborhoodCirculator operator- | ( | difference_type | d | ) | const

subtraction

RestrictedNeighborhoodCirculator operator-- | ( | int |  | ) |

post-decrement

Reimplemented from NeighborhoodCirculator.

RestrictedNeighborhoodCirculator& operator-- | ( |  | ) |

post-increment

Reimplemented from NeighborhoodCirculator.

RestrictedNeighborhoodCirculator& operator-= | ( | difference_type | d | ) |

subtract-assignment

pointer operator-> | ( |  | ) | const

member access

Reimplemented from NeighborhoodCirculator.

bool operator== | ( | RestrictedNeighborhoodCirculator< IMAGEITERATOR, NEIGHBORCODE > const & | rhs | ) | const

equality

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

- vigra/pixelneighborhood.hxx

© Ullrich Köthe (ullrich.koethe@iwr.uni-heidelberg.de) Heidelberg Collaboratory for Image Processing, University of Heidelberg, Germany | html generated using doxygen and Python VIGRA 1.6.0 (13 Aug 2008)