Span.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/* 
 * 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/>.
 */

#ifndef LSST_AFW_GEOM_Span_h_INCLUDED
#define LSST_AFW_GEOM_Span_h_INCLUDED

#include <string>
#include <iostream>

#include "boost/serialization/nvp.hpp"

#include "lsst/base.h"
#include "lsst/afw/geom/Point.h"
#include "lsst/afw/geom/Extent.h"
#include "lsst/afw/geom/SpanPixelIterator.h"

namespace boost{
namespace serialization{
    class access;
}}

namespace lsst {
namespace afw {

namespace detection {
class Footprint;
} // namespace detection

namespace geom {

class Span {
public:

    typedef boost::shared_ptr<Span> Ptr;
    typedef boost::shared_ptr<Span const> ConstPtr;

    typedef SpanPixelIterator Iterator;

    Span(int y,                         
         int x0,                        
         int x1)                        
        : _y(y), _x0(x0), _x1(x1) {}

    Span() : _y(0), _x0(0), _x1(-1) {}

    Iterator begin() const { return Iterator(Point2I(_x0, _y)); }

    Iterator end() const { return Iterator(Point2I(_x1+1, _y)); }

    int getX0() const { return _x0; }         
    int& getX0() { return _x0; }              
    int getX1() const { return _x1; }         
    int& getX1() { return _x1; }              
    int getY()  const { return _y; }          
    int& getY() { return _y; }                
    int getWidth() const { return _x1 - _x0 + 1; } 
    int getMinX() const { return _x0; }       
    int getMaxX() const { return _x1; }       
    int getBeginX() const { return _x0; }       
    int getEndX() const { return _x1+1; }       
    Point2I const getMin() const { return Point2I(_x0, _y); } 
    Point2I const getMax() const { return Point2I(_x1, _y); } 

    bool contains(int x) const { return (x >= _x0) && (x <= _x1); }
    bool contains(int x, int y) const { return (x >= _x0) && (x <= _x1) && (y == _y); }
    bool contains(Point2I const & point) const { return contains(point.getX(), point.getY()); }

    bool isEmpty() const { return _x1 < _x0; }

    std::string toString() const;

    void shift(int dx, int dy) { _x0 += dx; _x1 += dx; _y += dy; }

    friend std::ostream & operator<<(std::ostream & os, Span const & span) { return os << span.toString(); }

    bool operator==(Span const & other) const {
        return other.getY() == getY() && other.getMinX() == getMinX() && other.getMaxX() == getMaxX();
    }
    bool operator!=(Span const & other) const { return !(*this == other); }

    /* Required to make Span "LessThanComparable" so they can be used
     * in sorting, binary search, etc.
     * http://www.sgi.com/tech/stl/LessThanComparable.html
     */
    bool operator<(const Span& b) const;

    friend class detection::Footprint;
private:

    friend class boost::serialization::access;
    template <typename Archive>
    void serialize(Archive & ar, const unsigned int version) {
        ar & boost::serialization::make_nvp("y", _y)
            & boost::serialization::make_nvp("x0", _x0)
            & boost::serialization::make_nvp("x1", _x1);
    }

    int _y;                             
    int _x0;                            
    int _x1;                            
};

}}} // lsst::afw::geom

#endif // LSST_AFW_GEOM_Span_h_INCLUDED