EllipticityBase.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_EllipticityBase_h_INCLUDED
#define LSST_AFW_GEOM_ELLIPSES_EllipticityBase_h_INCLUDED

#include "Eigen/Core"
#include <complex>

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

namespace detail {

class EllipticityBase {
public:
    typedef Eigen::Matrix2d Jacobian;

    enum ParameterEnum { E1 = 0, E2 = 1 };

    std::complex<double>& getComplex() { return _complex; }

    std::complex<double> const& getComplex() const { return _complex; }

    void setComplex(std::complex<double> const& v) { _complex = v; }

    double getE1() const { return _complex.real(); }
    void setE1(double e1) {
#if __cplusplus < 201103L
        _complex = std::complex<double>(e1, _complex.imag());
#else
        _complex.real(e1);
#endif
    }

    double getE2() const { return _complex.imag(); }
    void setE2(double e2) {
#if __cplusplus < 201103L
        _complex = std::complex<double>(_complex.real(), e2);
#else
        _complex.imag(e2);
#endif
    }

    double getE() const { return std::sqrt(std::norm(_complex)); }
    void setE(double e) { _complex *= e / getE(); }

    double getTheta() const { return 0.5 * std::arg(_complex); }

    EllipticityBase(EllipticityBase const&) = default;
    EllipticityBase(EllipticityBase&&) = default;
    EllipticityBase& operator=(EllipticityBase const&) = default;
    EllipticityBase& operator=(EllipticityBase&&) = default;
    ~EllipticityBase() = default;

protected:
    explicit EllipticityBase(std::complex<double> const& complex) : _complex(complex) {}

    explicit EllipticityBase(double e1 = 0.0, double e2 = 0.0) : _complex(e1, e2) {}

    std::complex<double> _complex;
};

}  // namespace detail
}  // namespace ellipses
}  // namespace geom
}  // namespace afw
}  // namespace lsst

#endif  // !LSST_AFW_GEOM_ELLIPSES_EllipticityBase_h_INCLUDED