Distortion.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_Distortion_h_INCLUDED
#define LSST_AFW_GEOM_ELLIPSES_Distortion_h_INCLUDED

#include "lsst/afw/geom/ellipses/EllipticityBase.h"

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

class ConformalShear;
class ReducedShear;

class Distortion : public detail::EllipticityBase {
public:
    explicit Distortion(std::complex<double> const& complex) : detail::EllipticityBase(complex) {}

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

    Distortion(Distortion const& other) : detail::EllipticityBase(other.getComplex()) {}
    // Delegate to copy-constructor for backwards compatibility
    Distortion(Distortion&& other) : Distortion(other) {}
    ~Distortion() = default;

    explicit Distortion(ConformalShear const& other) { this->operator=(other); }

    explicit Distortion(ReducedShear const& other) { this->operator=(other); }

    Distortion& operator=(Distortion const& other) {
        _complex = other._complex;
        return *this;
    }
    // Delegate to copy-assignment for backwards compatibility
    Distortion& operator=(Distortion&& other) { return *this = other; }

    Distortion& operator=(ConformalShear const& other);

    Distortion& operator=(ReducedShear const& other);

    Jacobian dAssign(Distortion const& other) {
        _complex = other._complex;
        return Jacobian::Identity();
    }

    Jacobian dAssign(ConformalShear const& other);

    Jacobian dAssign(ReducedShear const& other);

    double getAxisRatio() const;

    void normalize();

    static std::string getName() { return "Distortion"; }
};
}  // namespace ellipses
}  // namespace geom
}  // namespace afw
}  // namespace lsst

#endif  // !LSST_AFW_GEOM_ELLIPSES_Distortion_h_INCLUDED