iterators.cc

Go to the documentation of this file.

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

/*
 * A set of pseudo-code to permit me to document the Image iterator API.
 *
 * This is needed as the actual implementation is opaque, based on the boost::gil
 * libraries.
 */
namespace lsst { namespace afw { namespace image {
class imageIterator {
public:
    Image::Pixel& operator*();
    void operator++();
    void operator++(int);
    void operator+=(std::ptrdiff_t delta 
                   );
    void operator-=(std::ptrdiff_t delta 
                   );
    bool operator==(imageIterator const& rhs 
                   );
    bool operator!=(imageIterator const& rhs 
                   );
    bool operator<(imageIterator const& rhs); 
};

class imageLocator {
public:
    typedef void cached_location_t;
    Image::Pixel& operator*();
    Image::Pixel& operator()(int x, int y);
    xy_x_iterator x();
    xy_y_iterator y();

    struct xy_x_iterator {
        Image::Pixel& operator*();
        void operator++();
        void operator++(int);
    };

    struct xy_y_iterator {
        Image::Pixel& operator*();
        void operator++();
        void operator++(int);
    };

    cached_location_t cache_location(int x, int y);
    Image::Pixel& operator[](cached_location_t const&);
};

}}}