GridTransform.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_GridTransform_h_INCLUDED
#define LSST_AFW_GEOM_ELLIPSES_GridTransform_h_INCLUDED

/*
 *  Definitions for Ellipse::GridTransform and BaseCore::GridTransform.
 *
 *  Note: do not include directly; use the main ellipse header file.
 */

#include "Eigen/Eigenvalues"

#include "lsst/afw/geom/ellipses/Ellipse.h"
#include "lsst/geom/AffineTransform.h"

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

class BaseCore::GridTransform final {
public:
    typedef Eigen::Matrix<double, 4, 3> DerivativeMatrix;

    explicit GridTransform(BaseCore const& input);

    operator lsst::geom::LinearTransform() const;

    lsst::geom::LinearTransform::Matrix getMatrix() const;

    DerivativeMatrix d() const;

    double getDeterminant() const;


    lsst::geom::LinearTransform inverted() const;
    [[deprecated("Use `inverted` instead. To be removed after 20.0.0.")]]  // DM-22276
            lsst::geom::LinearTransform
            invert() const {
        return inverted();
    };

private:
    BaseCore const& _input;  
    Eigen::SelfAdjointEigenSolver<Eigen::Matrix2d> _eig;
};

class Ellipse::GridTransform final {
public:
    typedef Eigen::Matrix<double, 6, 5> DerivativeMatrix;

    explicit GridTransform(Ellipse const& input);

    lsst::geom::AffineTransform::Matrix getMatrix() const;

    DerivativeMatrix d() const;

    double getDeterminant() const;

    operator lsst::geom::AffineTransform() const;

    lsst::geom::AffineTransform inverted() const;
    lsst::geom::AffineTransform invert() const { return inverted(); };

private:
    Ellipse const& _input;  
    BaseCore::GridTransform _coreGt;
};

inline BaseCore::GridTransform const BaseCore::getGridTransform() const {
    return BaseCore::GridTransform(*this);
}

inline Ellipse::GridTransform const Ellipse::getGridTransform() const {
    return Ellipse::GridTransform(*this);
}
}  // namespace ellipses
}  // namespace geom
}  // namespace afw
}  // namespace lsst

#endif  // !LSST_AFW_GEOM_ELLIPSES_GridTransform_h_INCLUDED