[ VIGRA Homepage | Function Index | Class Index | Namespaces | File List | Main Page ]
|   | NeighborOffsetCirculator [Utilities to manage pixel neighborhoods] |  | 
Circulator that walks around a given location. More...
#include <vigra/pixelneighborhood.hxx>
The template parameter defines the kind of neighborhood used, e.g.
    NeighborOffsetCirculator<EightNeighborCode> eight_circulator;
    NeighborOffsetCirculator<FourNeighborCode>  four_circulator;
Since this circulator doesn't now about the pixels in any particular image, you usually doesn't use it directly but rather as a base class or helper for neighborhood circulators refering to a particular image (e.g. NeighborhoodCirculator)
#include <vigra/pixelneighborhood.hxx>
 Namespace: vigra 
| typedef int difference_type | 
the circulator's difference type (argument type of circ[diff]) 
| typedef NEIGHBORCODE::Direction Direction | 
return type of direction()
| typedef value_type const& index_reference | 
the circulator's index reference type (return type of circ[n]) 
| typedef random_access_circulator_tag iterator_category | 
the circulator tag (random access iterator)
| typedef value_type const* pointer | 
the circulator's pointer type (return type of operator->) 
| typedef value_type const& reference | 
the circulator's reference type (return type of *circ) 
| typedef NEIGHBORCODE::difference_type value_type | 
the circulator's value type
| NeighborOffsetCirculator | ( | Direction | dir = NEIGHBORCODE::InitialDirection | ) | 
Create circulator refering to the given direction.
| reference diff | ( | ) | const | 
Get offset from center to current neighbor.
| Direction direction | ( | difference_type | offset | ) | const | 
Get direction code at offset of current direction.
| Direction direction | ( | ) | const | 
Get current direction.
| unsigned int directionBit | ( | ) | const | 
Get current direction bit.
| int dX | ( | ) | const | 
X-component of diff()
| int dY | ( | ) | const | 
Y-component of diff()
| bool isDiagonal | ( | ) | const | 
Check whether current direction is a diagonal one.
| bool operator!= | ( | NeighborOffsetCirculator< NEIGHBORCODE > const & | o | ) | const | 
unequality
| reference operator* | ( | ) | const | 
dereference
| NeighborOffsetCirculator operator+ | ( | difference_type | d | ) | const | 
addition
| NeighborOffsetCirculator operator++ | ( | int | ) | 
post-increment
| NeighborOffsetCirculator& operator++ | ( | ) | 
pre-increment
| NeighborOffsetCirculator& operator+= | ( | difference_type | d | ) | 
add-assignment
| difference_type operator- | ( | NeighborOffsetCirculator< NEIGHBORCODE > const & | o | ) | const | 
subtraction
| NeighborOffsetCirculator operator- | ( | difference_type | d | ) | const | 
subtraction
| NeighborOffsetCirculator operator-- | ( | int | ) | 
post-decrement
| NeighborOffsetCirculator& operator-- | ( | ) | 
pre-decrement
| NeighborOffsetCirculator& operator-= | ( | difference_type | d | ) | 
subtract-assignment
| pointer operator-> | ( | ) | const | 
member access
| bool operator== | ( | NeighborOffsetCirculator< NEIGHBORCODE > const & | o | ) | const | 
equality
| index_reference operator[] | ( | difference_type | d | ) | const | 
index
| Direction opposite | ( | ) | const | 
Get opposite of current direction.
| unsigned int oppositeDirectionBit | ( | ) | const | 
Get opposite bit of current direction.
| value_type relativeDiff | ( | difference_type | offset | ) | const | 
Get relative distance from current neighbor to neighbor at given offset.
| NeighborOffsetCirculator& turnLeft | ( | ) | 
Move to the direction that is 'left' relative to the current direction. This is equivalent to four_circulator++ and eight_circulator += 2 respectively. 
| NeighborOffsetCirculator& turnRight | ( | ) | 
Move to the direction that is 'right' relative to the current direction. This is equivalent to four_circulator-- and eight_circulator -= 2 respectively. 
| NeighborOffsetCirculator& turnRound | ( | ) | 
Move to the opposite direction of the current direction. This is equivalent to four_circulator += 2 and eight_circulator += 4 respectively. 
| NeighborOffsetCirculator& turnTo | ( | Direction | d | ) | 
Move to the given direction.
| 
© Ullrich Köthe     (ullrich.koethe@iwr.uni-heidelberg.de)  | 
html generated using doxygen and Python
 |