Undistortion.hpp

// This file is part of the AliceVision project.
// Copyright (c) 2023 AliceVision contributors.
// This Source Code Form is subject to the terms of the Mozilla Public License,
// v. 2.0. If a copy of the MPL was not distributed with this file,
// You can obtain one at https://mozilla.org/MPL/2.0/.
 
#pragma once
 
#include <aliceVision/camera/cameraCommon.hpp>
 
#include <aliceVision/numeric/numeric.hpp>
 
#include <vector>
#include <string>
#include <memory>
 
namespace aliceVision {
namespace camera {
 
class Undistortion
{
  public:
    Undistortion(int width, int height)
    {
        _pixelAspectRatio = 1.0;
        _isDesqueezed = false;
        _isLocked = false;
 
        setSize(width, height);
        setOffset({0.0, 0.0});
    }
 
    virtual EUNDISTORTION getType() const = 0;
 
    virtual Undistortion* clone() const = 0;
 
    // not virtual as child classes do not hold any data
    bool operator==(const Undistortion& other) const { return _undistortionParams == other._undistortionParams; }
 
    void setDesqueezed(bool isDesqueezed)
    {
        _isDesqueezed = isDesqueezed;
 
        double hh = _size.y();
        if (!_isDesqueezed)
        {
            hh = _size.y() / _pixelAspectRatio;
        }
 
        _diagonal = sqrt(_size.x() * _size.x() + hh * hh) * 0.5;
    }
 
    bool isDesqueezed() const { return _isDesqueezed; }
 
    bool isLocked() const { return _isLocked; }
 
    void setLocked(bool lock) { _isLocked = lock; }
 
    void setOffset(const Vec2& offset) { _offset = offset; }
 
    void setSize(int width, int height)
    {
        double hh = height;
        if (!_isDesqueezed)
        {
            hh = height / _pixelAspectRatio;
        }
 
        _diagonal = sqrt(width * width + hh * hh) * 0.5;
        _center = {width / 2, height / 2};
        _size = {width, height};
    }
 
    void setDiagonal(double diagonal)
    {
        // May be used for plates with a different size than lens grid
        _diagonal = diagonal;
    }
 
    void setPixelAspectRatio(double pixelAspectRatio)
    {
        _pixelAspectRatio = pixelAspectRatio;
 
        double hh = _size.y();
        if (!_isDesqueezed)
        {
            hh = _size.y() / _pixelAspectRatio;
        }
 
        _diagonal = sqrt(_size.x() * _size.x() + hh * hh) * 0.5;
    }
 
    inline Vec2 getOffset() const { return _offset; }
 
    inline Vec2 getScaledOffset() const { return _offset / _diagonal; }
 
    Vec2 getSize() const { return _size; }
 
    Vec2 getCenter() const { return _center + _offset; }
 
    inline double getDiagonal() const { return _diagonal; }
 
    double getPixelAspectRatio() const { return _pixelAspectRatio; }
 
    const std::vector<double>& getParameters() const { return _undistortionParams; }
 
    void setParameters(const std::vector<double>& params)
    {
        if (_undistortionParams.size() != params.size())
        {
            return;
        }
 
        for (std::size_t i = 0; i < _undistortionParams.size(); i++)
        {
            _undistortionParams[i] = params[i];
        }
    }
 
    std::size_t getUndistortionParametersCount() const { return _undistortionParams.size(); }
 
    Vec2 undistort(const Vec2& p) const;
 
    Eigen::Matrix<double, 2, Eigen::Dynamic> getDerivativeUndistortWrtParameters(const Vec2& p);
 
    Eigen::Matrix<double, 2, 2> getDerivativeUndistortWrtOffset(const Vec2& p);
 
    Vec2 inverse(const Vec2& p) const;
 
    virtual Vec2 inverseNormalized(const Vec2& p) const = 0;
    virtual Vec2 undistortNormalized(const Vec2& p) const = 0;
    virtual Eigen::Matrix<double, 2, Eigen::Dynamic> getDerivativeUndistortNormalizedwrtParameters(const Vec2& p) const = 0;
    virtual Eigen::Matrix<double, 2, 2> getDerivativeUndistortNormalizedwrtPoint(const Vec2& p) const = 0;
 
    virtual ~Undistortion() = default;
 
  protected:
    Vec2 _size;
    Vec2 _center;
    Vec2 _offset;
    double _diagonal;
    double _pixelAspectRatio;
    bool _isDesqueezed;
    std::vector<double> _undistortionParams{};
    bool _isLocked;
};
 
}  // namespace camera
}  // namespace aliceVision