Ellipse.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_ELLIPSES_Ellipse_h_INCLUDED
#define LSST_AFW_GEOM_ELLIPSES_Ellipse_h_INCLUDED

/*
 *  Forward declarations, typedefs, and definitions for Ellipse.
 *
 *  Note: do not include directly; use the main ellipse header file.
 */

#include "lsst/afw/geom/ellipses/BaseCore.h"
#include "lsst/afw/geom/Box.h"
#include "lsst/afw/geom/AffineTransform.h"

namespace lsst {
namespace afw {
namespace geom {
namespace ellipses {

class Ellipse {
public:
    class Transformer;    
    class GridTransform;  
    class Convolution;    

    typedef Eigen::Matrix<double, 5, 1> ParameterVector;  

    enum ParameterEnum { X = 3, Y = 4 };  

    Point2D const& getCenter() const { return _center; }

    Point2D& getCenter() { return _center; }

    void setCenter(Point2D const& center) { _center = center; }

    BaseCore const& getCore() const { return *_core; }

    BaseCore& getCore() { return *_core; }

    std::shared_ptr<BaseCore const> getCorePtr() const { return _core; }

    std::shared_ptr<BaseCore> getCorePtr() { return _core; }

    void setCore(BaseCore const& core) { *_core = core; }

    void normalize() { _core->normalize(); }

    void grow(double buffer) { _core->grow(buffer); }

    void scale(double factor) { _core->scale(factor); }

    void shift(Extent2D const& offset) { _center += offset; }

    ParameterVector const getParameterVector() const;

    void setParameterVector(ParameterVector const& vector);

    void readParameters(double const* iter);

    void writeParameters(double* iter) const;

    Transformer transform(AffineTransform const& transform);
    Transformer const transform(AffineTransform const& transform) const;

    Convolution convolve(Ellipse const& other);
    Convolution const convolve(Ellipse const& other) const;

    GridTransform const getGridTransform() const;

    Box2D computeBBox() const;

    Ellipse& operator=(Ellipse const& other);
    Ellipse& operator=(Ellipse&& other);

    bool operator==(Ellipse const& other) const {
        return getCenter() == other.getCenter() && getCore() == other.getCore();
    }

    bool operator!=(Ellipse const& other) const { return !operator==(other); }

    virtual ~Ellipse() = default;

    explicit Ellipse(BaseCore const& core, Point2D const& center = Point2D())
            : _core(core.clone()), _center(center) {}

    explicit Ellipse(std::shared_ptr<BaseCore const> const& core, Point2D const& center = Point2D())
            : _core(core->clone()), _center(center) {}

    Ellipse(Transformer const& other);
    Ellipse(Convolution const& other);

    Ellipse(Ellipse const& other) : _core(other.getCore().clone()), _center(other.getCenter()) {}
    // Delegate to copy-constructor for backwards compatibility
    Ellipse(Ellipse&& other) : Ellipse(other) {}

private:
    std::shared_ptr<BaseCore> _core;
    Point2D _center;
};
}
}
}
}  // namespace lsst::afw::geom::ellipses

#endif  // !LSST_AFW_GEOM_ELLIPSES_Ellipse_h_INCLUDED