sim2.h

// -*- c++ -*-

// Copyright (C) 2011 Tom Drummond (twd20@cam.ac.uk),
// Ed Rosten (er258@cam.ac.uk), Gerhard Reitmayr (gr281@cam.ac.uk)
//
// This file is part of the TooN Library.  This library 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 2, or (at your option)
// any later version.

// This library 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 GNU General Public License along
// with this library; see the file COPYING.  If not, write to the Free
// Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
// USA.

// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.

/* This code mostly made by copying from sim3.h !! */

#ifndef TOON_INCLUDE_SIM2_H
#define TOON_INCLUDE_SIM2_H

#include <TooN/se2.h>
#include <TooN/sim3.h>

namespace TooN {

/// Represent a two-dimensional Similarity transformation (a rotation, a uniform scale and a translation). 
/// This can be represented by a \f$2\times 3\f$ matrix operating on a homogeneous co-ordinate, 
/// so that a vector \f$\underline{x}\f$ is transformed to a new location \f$\underline{x}'\f$
/// by
/// \f[\begin{aligned}\underline{x}' &= E\times\underline{x}\\ \begin{bmatrix}x'\\y'\end{bmatrix} &= \begin{pmatrix}r_{11} & r_{12} & t_1\\r_{21} & r_{22} & t_2\end{pmatrix}\begin{bmatrix}x\\y\\1\end{bmatrix}\end{aligned}\f]
/// 
/// This transformation is a member of the Lie group SIM2. These can be parameterised with
/// four numbers (in the space of the Lie Algebra). In this class, the first two parameters are a
/// translation vector while the third is the amount of rotation in the plane as for SO2. The forth is the logarithm of the scale factor.
/// @ingroup gTransforms
template <typename Precision = DefaultPrecision>
class SIM2 {
public:
    /// Default constructor. Initialises the the rotation to zero (the identity), the scale factor to one and the translation to zero
    SIM2() : my_scale(1) {}
    template <class A> SIM2(const SO2<Precision>& R, const Vector<2,Precision,A>& T, const Precision s) : my_se2(R,T), my_scale(s) {}
    template <int S, class P, class A> SIM2(const Vector<S, P, A> & v) { *this = exp(v); }

    /// Returns the rotation part of the transformation as a SO2
    SO2<Precision> & get_rotation(){return my_se2.get_rotation();}
    /// @overload
    const SO2<Precision> & get_rotation() const {return my_se2.get_rotation();}
    /// Returns the translation part of the transformation as a Vector
    Vector<2, Precision> & get_translation() {return my_se2.get_translation();}
    /// @overload
    const Vector<2, Precision> & get_translation() const {return my_se2.get_translation();}

    /// Returns the scale factor of the transformation
    Precision & get_scale() {return my_scale;}
    /// @overload
    const Precision & get_scale() const {return my_scale;}

    /// Exponentiate a Vector in the Lie Algebra to generate a new SIM2.
    /// See the Detailed Description for details of this vector.
    /// @param vect The Vector to exponentiate
    template <int S, typename P, typename A>
    static inline SIM2 exp(const Vector<S,P, A>& vect);
    
    /// Take the logarithm of the matrix, generating the corresponding vector in the Lie Algebra.
    /// See the Detailed Description for details of this vector.
    static inline Vector<4, Precision> ln(const SIM2& se2);
    /// @overload
    Vector<4, Precision> ln() const { return SIM2::ln(*this); }

    /// compute the inverse of the transformation
    SIM2 inverse() const {
        const SO2<Precision> & rinv = get_rotation().inverse();
        const Precision inv_scale = 1/get_scale();
        return SIM2(rinv, -(rinv*(inv_scale*get_translation())), inv_scale);
    };

    /// Right-multiply by another SIM2 (concatenate the two transformations)
    /// @param rhs The multipier
    template <typename P>
    SIM2<typename Internal::MultiplyType<Precision,P>::type> operator *(const SIM2<P>& rhs) const { 
        return SIM2<typename Internal::MultiplyType<Precision,P>::type>(get_rotation()*rhs.get_rotation(), get_translation() + get_rotation() * (get_scale()*rhs.get_translation()), get_scale() * rhs.get_scale());
    }

    /// Self right-multiply by another SIM2 (concatenate the two transformations)
    /// @param rhs The multipier
    inline SIM2& operator *=(const SIM2& rhs) {
        *this = *this * rhs; 
        return *this; 
    }

    /// returns the generators for the Lie group. These are a set of matrices that
    /// form a basis for the vector space of the Lie algebra.
    /// - 0 is translation in x
    /// - 1 is translation in y
    /// - 2 is rotation in the plane
    /// - 3 is uniform scale
    static inline Matrix<3,3, Precision> generator(int i) {
        Matrix<3,3,Precision> result(Zeros);
        switch(i){
        case 0:
        case 1:
            result(i,2) = 1;
            break;
        case 2:
            result(0,1) = -1;
            result(1,0) = 1;
            break;
        case 3:
            result(0,0) = 1;
            result(1,1) = 1;
            break;
        }
        return result;
    }

    /// transfers a vector in the Lie algebra, from one coord frame to another
    /// so that exp(adjoint(vect)) = (*this) * exp(vect) * (this->inverse())
    template<typename Accessor>
    Vector<4, Precision> adjoint(const Vector<4,Precision, Accessor> & vect) const {
        Vector<4, Precision> result;
        result[2] = vect[2];
        result.template slice<0,2>() = get_rotation() * vect.template slice<0,2>();
        result[0] += vect[2] * get_translation()[1];
        result[1] -= vect[2] * get_translation()[0];
        return result;
    }

    template <typename Accessor>
    Matrix<4,4,Precision> adjoint(const Matrix<4,4,Precision,Accessor>& M) const {
        Matrix<4,4,Precision> result;
        for(int i=0; i<4; ++i)
            result.T()[i] = adjoint(M.T()[i]);
        for(int i=0; i<4; ++i)
            result[i] = adjoint(result[i]);
        return result;
    }

private:
    SE2<Precision> my_se2;
    Precision my_scale;
};

/// Write an SIM2 to a stream 
/// @relates SIM2
template <class Precision>
inline std::ostream& operator<<(std::ostream& os, const SIM2<Precision> & rhs){
    std::streamsize fw = os.width();
    for(int i=0; i<2; i++){
        os.width(fw);
        os << rhs.get_rotation().get_matrix()[i] * rhs.get_scale();
        os.width(fw);
        os << rhs.get_translation()[i] << '\n';
    }
    return os;
}

/// Read an SIM2 from a stream 
/// @relates SIM2
template <class Precision>
inline std::istream& operator>>(std::istream& is, SIM2<Precision>& rhs){
    for(int i=0; i<2; i++)
        is >> rhs.get_rotation().my_matrix[i].ref() >> rhs.get_translation()[i];
    rhs.get_scale() = (norm(rhs.get_rotation().my_matrix[0]) + norm(rhs.get_rotation().my_matrix[1]))/2;
    rhs.get_rotation().coerce();
    return is;
}


//////////////////
// operator *   //
// SIM2 * Vector //
//////////////////

namespace Internal {
template<int S, typename P, typename PV, typename A>
struct SIM2VMult;
}

template<int S, typename P, typename PV, typename A>
struct Operator<Internal::SIM2VMult<S,P,PV,A> > {
    const SIM2<P> & lhs;
    const Vector<S,PV,A> & rhs;
    
    Operator(const SIM2<P> & l, const Vector<S,PV,A> & r ) : lhs(l), rhs(r) {}
    
    template <int S0, typename P0, typename A0>
    void eval(Vector<S0, P0, A0> & res ) const {
        SizeMismatch<3,S>::test(3, rhs.size());
        res.template slice<0,2>()=lhs.get_rotation()*(lhs.get_scale()*rhs.template slice<0,2>());
        res.template slice<0,2>()+=lhs.get_translation() * rhs[2];
        res[2] = rhs[2];
    }
    int size() const { return 3; }
};

/// Right-multiply with a Vector<3>
/// @relates SIM2
template<int S, typename P, typename PV, typename A>
inline Vector<3, typename Internal::MultiplyType<P,PV>::type> operator*(const SIM2<P> & lhs, const Vector<S,PV,A>& rhs){
    return Vector<3, typename Internal::MultiplyType<P,PV>::type>(Operator<Internal::SIM2VMult<S,P,PV,A> >(lhs,rhs));
}

/// Right-multiply with a Vector<2> (special case, extended to be a homogeneous vector)
/// @relates SIM2
template <typename P, typename PV, typename A>
inline Vector<2, typename Internal::MultiplyType<P,PV>::type> operator*(const SIM2<P>& lhs, const Vector<2,PV,A>& rhs){
    return lhs.get_translation() + lhs.get_rotation() * (lhs.get_scale() * rhs);
}

//////////////////
// operator *   //
// Vector * SIM2 //
//////////////////

namespace Internal {
template<int S, typename P, typename PV, typename A>
struct VSIM2Mult;
}

template<int S, typename P, typename PV, typename A>
struct Operator<Internal::VSIM2Mult<S,P,PV,A> > {
    const Vector<S,PV,A> & lhs;
    const SIM2<P> & rhs;
    
    Operator(const Vector<S,PV,A> & l, const SIM2<P> & r ) : lhs(l), rhs(r) {}
    
    template <int S0, typename P0, typename A0>
    void eval(Vector<S0, P0, A0> & res ) const {
        SizeMismatch<3,S>::test(3, lhs.size());
        res.template slice<0,2>() = (lhs.template slice<0,2>()* rhs.get_scale())*rhs.get_rotation();
        res[2] = lhs[2];
        res[2] += lhs.template slice<0,2>() * rhs.get_translation();
    }
    int size() const { return 3; }
};

/// Left-multiply with a Vector<3>
/// @relates SIM2
template<int S, typename P, typename PV, typename A>
inline Vector<3, typename Internal::MultiplyType<PV,P>::type> operator*(const Vector<S,PV,A>& lhs, const SIM2<P> & rhs){
    return Vector<3, typename Internal::MultiplyType<PV,P>::type>(Operator<Internal::VSIM2Mult<S, P,PV,A> >(lhs,rhs));
}

//////////////////
// operator *   //
// SIM2 * Matrix //
//////////////////

namespace Internal {
template <int R, int C, typename PM, typename A, typename P>
struct SIM2MMult;
}

template<int R, int Cols, typename PM, typename A, typename P>
struct Operator<Internal::SIM2MMult<R, Cols, PM, A, P> > {
    const SIM2<P> & lhs;
    const Matrix<R,Cols,PM,A> & rhs;
    
    Operator(const SIM2<P> & l, const Matrix<R,Cols,PM,A> & r ) : lhs(l), rhs(r) {}
    
    template <int R0, int C0, typename P0, typename A0>
    void eval(Matrix<R0, C0, P0, A0> & res ) const {
        SizeMismatch<3,R>::test(3, rhs.num_rows());
        for(int i=0; i<rhs.num_cols(); ++i)
            res.T()[i] = lhs * rhs.T()[i];
    }
    int num_cols() const { return rhs.num_cols(); }
    int num_rows() const { return 3; }
};

/// Right-multiply with a Matrix<3>
/// @relates SIM2
template <int R, int Cols, typename PM, typename A, typename P> 
inline Matrix<3,Cols, typename Internal::MultiplyType<P,PM>::type> operator*(const SIM2<P> & lhs, const Matrix<R,Cols,PM, A>& rhs){
    return Matrix<3,Cols,typename Internal::MultiplyType<P,PM>::type>(Operator<Internal::SIM2MMult<R, Cols, PM, A, P> >(lhs,rhs));
}

//////////////////
// operator *   //
// Matrix * SIM2 //
//////////////////

namespace Internal {
template <int Rows, int C, typename PM, typename A, typename P>
struct MSIM2Mult;
}

template<int Rows, int C, typename PM, typename A, typename P>
struct Operator<Internal::MSIM2Mult<Rows, C, PM, A, P> > {
    const Matrix<Rows,C,PM,A> & lhs;
    const SIM2<P> & rhs;
    
    Operator( const Matrix<Rows,C,PM,A> & l, const SIM2<P> & r ) : lhs(l), rhs(r) {}
    
    template <int R0, int C0, typename P0, typename A0>
    void eval(Matrix<R0, C0, P0, A0> & res ) const {
        SizeMismatch<3, C>::test(3, lhs.num_cols());
        for(int i=0; i<lhs.num_rows(); ++i)
            res[i] = lhs[i] * rhs;
    }
    int num_cols() const { return 3; }
    int num_rows() const { return lhs.num_rows(); }
};

/// Left-multiply with a Matrix<3>
/// @relates SIM2
template <int Rows, int C, typename PM, typename A, typename P> 
inline Matrix<Rows,3, typename Internal::MultiplyType<PM,P>::type> operator*(const Matrix<Rows,C,PM, A>& lhs, const SIM2<P> & rhs ){
    return Matrix<Rows,3,typename Internal::MultiplyType<PM,P>::type>(Operator<Internal::MSIM2Mult<Rows, C, PM, A, P> >(lhs,rhs));
}

template <typename Precision>
template <int S, typename PV, typename Accessor>
inline SIM2<Precision> SIM2<Precision>::exp(const Vector<S, PV, Accessor>& mu){
    SizeMismatch<4,S>::test(4, mu.size());

    static const Precision one_6th = 1.0/6.0;
    static const Precision one_20th = 1.0/20.0;
  
    using std::exp;
  
    SIM2<Precision> result;
  
    // rotation
    const Precision theta = mu[2];
    result.get_rotation() = SO2<Precision>::exp(theta);

    // scale
    result.get_scale() = exp(mu[3]);

    // translation
    const Vector<3, Precision> coeff = Internal::compute_rodrigues_coefficients_sim3(mu[3], theta);
    const Vector<2, Precision> cross = makeVector( -theta * mu[1], theta * mu[0]);
    result.get_translation() = coeff[2] * mu.template slice<0,2>() + TooN::operator*(coeff[1], cross);

    return result;
}

template <typename Precision>
inline Vector<4, Precision> SIM2<Precision>::ln(const SIM2<Precision> & sim2) {
    using std::log;

    Vector<4, Precision> result;

    // rotation
    const Precision theta = sim2.get_rotation().ln();
    result[2] = theta;

    // scale 
    result[3] = log(sim2.get_scale());

    // translation
    const Vector<3, Precision> coeff = Internal::compute_rodrigues_coefficients_sim3(result[3], theta);
    Matrix<2,2, Precision> cross = Zeros; cross(0,1) = -theta; cross(1,0) = theta;
    const Matrix<2,2, Precision> W = coeff[2] * Identity + coeff[1] * cross;
    result.template slice<0,2>() = gaussian_elimination(W, sim2.get_translation());

    return result;
}

#if 0
/// Multiply a SO2 with and SE2
/// @relates SE2
/// @relates SO2
template <typename Precision>
inline SE2<Precision> operator*(const SO2<Precision> & lhs, const SE2<Precision>& rhs){
    return SE2<Precision>( lhs*rhs.get_rotation(), lhs*rhs.get_translation());
}
#endif

}
#endif