Axes.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_Axes_h_INCLUDED
#define LSST_AFW_GEOM_ELLIPSES_Axes_h_INCLUDED

/*
 * Definitions and inlines for Axes.
 *
 * Note: do not include directly; use the main ellipse header file.
 */

#include "lsst/afw/geom/ellipses/BaseCore.h"
#include "lsst/afw/geom/ellipses/Convolution.h"
#include "lsst/afw/geom/ellipses/Transformer.h"
#include "lsst/afw/geom/ellipses/GridTransform.h"

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

class Axes : public BaseCore {
public:
    enum ParameterEnum { A = 0, B = 1, THETA = 2 };  

    double const getA() const { return _vector[A]; }
    void setA(double a) { _vector[A] = a; }

    double const getB() const { return _vector[B]; }
    void setB(double b) { _vector[B] = b; }

    double const getTheta() const { return _vector[THETA]; }
    void setTheta(double theta) { _vector[THETA] = theta; }

    std::shared_ptr<Axes> clone() const { return std::static_pointer_cast<Axes>(_clone()); }

    std::string getName() const override;

    void normalize() override;

    void readParameters(double const* iter) override;

    void writeParameters(double* iter) const override;

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

    Axes& operator=(BaseCore const& other) {
        BaseCore::operator=(other);
        return *this;
    }

    explicit Axes(double a = 1.0, double b = 1.0, double theta = 0.0, bool normalize = false)
            : _vector(a, b, theta) {
        if (normalize) this->normalize();
    }

    explicit Axes(BaseCore::ParameterVector const& vector, bool normalize = false) : _vector(vector) {
        if (normalize) this->normalize();
    }

    Axes(Axes const& other) : _vector(other._vector) {}
    // Delegate to copy-constructor for backwards compatibility
    Axes(Axes&& other) : Axes(other) {}
    ~Axes() override = default;

    Axes(BaseCore const& other) { *this = other; }

    Axes(BaseCore::Transformer const& transformer) { transformer.apply(*this); }

    Axes(BaseCore::Convolution const& convolution) { convolution.apply(*this); }

protected:
    std::shared_ptr<BaseCore> _clone() const override { return std::make_shared<Axes>(*this); }

    void _assignToQuadrupole(double& ixx, double& iyy, double& ixy) const override;
    void _assignFromQuadrupole(double ixx, double iyy, double ixy) override;

    void _assignToAxes(double& a, double& b, double& theta) const override;
    void _assignFromAxes(double a, double b, double theta) override;

    Jacobian _dAssignToQuadrupole(double& ixx, double& iyy, double& ixy) const override;
    Jacobian _dAssignFromQuadrupole(double ixx, double iyy, double ixy) override;

    Jacobian _dAssignToAxes(double& a, double& b, double& theta) const override;
    Jacobian _dAssignFromAxes(double a, double b, double theta) override;

private:
    static Registrar<Axes> registrar;

    ParameterVector _vector;
};
}  // namespace ellipses
}  // namespace geom
}  // namespace afw
}  // namespace lsst

#endif  // !LSST_AFW_GEOM_ELLIPSES_Axes_h_INCLUDED