lsst.afw g4230fac9de+4fc97e16b9
Loading...
Searching...
No Matches
iterators.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2008, 2009, 2010 LSST Corporation.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <http://www.lsstcorp.org/LegalNotices/>.
21 */
22
23/*
24 * A set of pseudo-code to permit me to document the Image iterator API.
25 *
26 * This is needed as the actual implementation is opaque, based on the boost::gil
27 * libraries.
28 */
29namespace lsst { namespace afw { namespace image {
32public:
36 void operator++();
38 void operator++(int);
41 );
44 );
46 bool operator==(imageIterator const& rhs
47 );
49 bool operator!=(imageIterator const& rhs
50 );
52 bool operator<(imageIterator const& rhs);
53};
54
57public:
59 typedef void cached_location_t;
71
77 void operator++();
79 void operator++(int);
80 };
81
87 void operator++();
89 void operator++(int);
90 };
91
96};
97
98}}}
PixelT Pixel
A pixel in this ImageBase.
Definition: ImageBase.h:115
An ImageBase iterator.
Definition: iterators.cc:31
bool operator<(imageIterator const &rhs)
Return true if the lhs is less than the rhs.
void operator-=(std::ptrdiff_t delta)
Decrement the iterator by delta
void operator++()
Advance an iterator (prefix)
void operator++(int)
Advance an iterator (postfix)
bool operator==(imageIterator const &rhs)
Return true if the lhs equals the rhs.
Image::Pixel & operator*()
Dereference an iterator, returning a reference to a Pixel.
void operator+=(std::ptrdiff_t delta)
Increment the iterator by delta
bool operator!=(imageIterator const &rhs)
Return true if the lhs doesn't equal the rhs.
An ImageBase locator.
Definition: iterators.cc:56
Image::Pixel & operator[](cached_location_t const &)
Dereference a cached_location_t, returning a reference to a Pixel.
Image::Pixel & operator()(int x, int y)
Dereference a pixel offset by (x, y) from the current locator, returning a reference to a Pixel.
cached_location_t cache_location(int x, int y)
Store a relative location for faster repeated access.
Image::Pixel & operator*()
Dereference a locator, returning a reference to a Pixel.
xy_x_iterator x()
Return an x_iterator that can move an xy_locator
void cached_location_t
type to store relative location for efficient repeated access (not really void)
Definition: iterators.cc:59
xy_y_iterator y()
Return an y_iterator that can move an xy_locator
An x_iterator created from an xy_locator
Definition: iterators.cc:73
void operator++(int)
Advance the iterator (postfix)
void operator++()
Advance the iterator (prefix)
Image::Pixel & operator*()
Dereference an iterator, returning a reference to a Pixel.
An y_iterator created from an xy_locator
Definition: iterators.cc:83
void operator++()
Advance the iterator (prefix)
void operator++(int)
Advance the iterator (postfix)
Image::Pixel & operator*()
Dereference an iterator, returning a reference to a Pixel.