Point Cloud Library (PCL)  1.9.1-dev
organized_index_iterator.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2010, Willow Garage, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of Willow Garage, Inc. nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  */
35 
36 #pragma once
37 
38 namespace pcl
39 {
40 /** \brief base class for iterators on 2-dimensional maps like images/organized clouds etc.
41  * \author Suat Gedikli <gedikli@willowgarage.com>
42  * \ingroup geometry
43  */
45 {
46  public:
47  /** \brief constructor
48  * \param[in] width the width of the image/organized cloud
49  */
50  OrganizedIndexIterator (unsigned width);
51 
52  /** \brief virtual destructor*/
53  virtual ~OrganizedIndexIterator ();
54 
55  /** \brief go to next pixel/point in image/cloud*/
56  virtual void operator ++ () = 0;
57 
58  /** \brief go to next pixel/point in image/cloud*/
59  virtual void operator ++ (int);
60 
61  /** \brief returns the pixel/point index in the linearized memory of the image/cloud
62  * \return the pixel/point index in the linearized memory of the image/cloud
63  */
64  unsigned operator* () const;
65 
66  /** \brief returns the pixel/point index in the linearized memory of the image/cloud
67  * \return the pixel/point index in the linearized memory of the image/cloud
68  */
69  virtual unsigned getIndex () const;
70 
71  /** \brief returns the row index (y-coordinate) of the current pixel/point
72  * \return the row index (y-coordinate) of the current pixel/point
73  */
74  virtual unsigned getRowIndex () const;
75 
76  /** \brief returns the col index (x-coordinate) of the current pixel/point
77  * \return the col index (x-coordinate) of the current pixel/point
78  */
79  virtual unsigned getColumnIndex () const;
80 
81  /** \brief return whether the current visited pixel/point is valid or not.
82  * \return true if the current pixel/point is within the points to be iterated over, false otherwise
83  */
84  virtual bool isValid () const = 0;
85 
86  /** \brief resets the iterator to the beginning of the line
87  */
88  virtual void reset () = 0;
89 
90  protected:
91  /** \brief the width of the image/cloud*/
92  unsigned width_;
93 
94  /** \brief the index of the current pixel/point*/
95  unsigned index_;
96 };
97 
98 ////////////////////////////////////////////////////////////////////////////////
99 ////////////////////////////////////////////////////////////////////////////////
100 ////////////////////////////////////////////////////////////////////////////////
101 
102 ////////////////////////////////////////////////////////////////////////////////
104 : width_ (width)
105 , index_ (0)
106 {
107 }
108 
109 ////////////////////////////////////////////////////////////////////////////////
111 {
112 }
113 
114 ////////////////////////////////////////////////////////////////////////////////
115 inline void
117 {
118  return operator ++();
119 }
120 
121 ////////////////////////////////////////////////////////////////////////////////
122 inline unsigned
124 {
125  return index_;
126 }
127 
128 ////////////////////////////////////////////////////////////////////////////////
129 inline unsigned
131 {
132  return index_;
133 }
134 
135 ////////////////////////////////////////////////////////////////////////////////
136 /** \brief default implementation. Should be overloaded
137  */
138 inline unsigned
140 {
141  return index_ / width_;
142 }
143 
144 ////////////////////////////////////////////////////////////////////////////////
145 inline unsigned
147 {
148  return index_ % width_;
149 }
150 } // namespace pcl
virtual bool isValid() const =0
return whether the current visited pixel/point is valid or not.
unsigned operator*() const
returns the pixel/point index in the linearized memory of the image/cloud
unsigned index_
the index of the current pixel/point
virtual void operator++()=0
go to next pixel/point in image/cloud
virtual void reset()=0
resets the iterator to the beginning of the line
This file defines compatibility wrappers for low level I/O functions.
Definition: convolution.h:45
virtual unsigned getRowIndex() const
returns the row index (y-coordinate) of the current pixel/point
OrganizedIndexIterator(unsigned width)
constructor
virtual ~OrganizedIndexIterator()
virtual destructor
virtual unsigned getColumnIndex() const
returns the col index (x-coordinate) of the current pixel/point
base class for iterators on 2-dimensional maps like images/organized clouds etc.
virtual unsigned getIndex() const
returns the pixel/point index in the linearized memory of the image/cloud
unsigned width_
the width of the image/cloud