ImageDescriber_AKAZE.hpp

// This file is part of the AliceVision project.
// Copyright (c) 2016 AliceVision contributors.
// Copyright (c) 2012 openMVG 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/config.hpp>
#include <aliceVision/feature/ImageDescriber.hpp>
#include <aliceVision/feature/imageDescriberCommon.hpp>
#include <aliceVision/feature/regionsFactory.hpp>
#include <aliceVision/feature/akaze/AKAZE.hpp>
#include <aliceVision/feature/akaze/descriptorLIOP.hpp>
#include <aliceVision/feature/akaze/descriptorMLDB.hpp>
#include <aliceVision/feature/akaze/descriptorMSURF.hpp>
 
namespace aliceVision {
namespace feature {
 
enum EAKAZE_DESCRIPTOR
{
    AKAZE_MSURF,
    AKAZE_LIOP,
    AKAZE_MLDB
};
 
struct AKAZEParams
{
    AKAZEParams(AKAZEOptions akazeOptions = AKAZEOptions(), EAKAZE_DESCRIPTOR eAkazeDescriptor = AKAZE_MSURF)
      : options(akazeOptions),
        akazeDescriptorType(eAkazeDescriptor)
    {}
 
    // parameters
    AKAZEOptions options;
    EAKAZE_DESCRIPTOR akazeDescriptorType;
};
 
class ImageDescriber_AKAZE : public ImageDescriber
{
  public:
    explicit ImageDescriber_AKAZE(const AKAZEParams& params = AKAZEParams(), bool isOriented = true)
      : ImageDescriber(),
        _params(params),
        _isOriented(isOriented)
    {}
 
    bool useCuda() const override { return false; }
 
    bool useFloatImage() const override { return true; }
 
    EImageDescriberType getDescriberType() const override
    {
        switch (_params.akazeDescriptorType)
        {
            case AKAZE_MSURF:
                return EImageDescriberType::AKAZE;
            case AKAZE_LIOP:
                return EImageDescriberType::AKAZE_LIOP;
            case AKAZE_MLDB:
                return EImageDescriberType::AKAZE_MLDB;
        }
        throw std::logic_error("Unknown AKAZE type.");
    }
 
    std::size_t getMemoryConsumption(std::size_t width, std::size_t height) const override
    {
        std::size_t fullImgSize = width * height;
        std::size_t memoryConsuption = 0;
        double downscale = 1.0;
        for (int octave = 0; octave < _params.options.nbOctaves; ++octave)
        {
            memoryConsuption += fullImgSize / (downscale * downscale);
            downscale *= 2.0;
        }
        memoryConsuption *= _params.options.nbSlicePerOctave * sizeof(float);
        return 4 * memoryConsuption + (3 * width * height * sizeof(float)) + 1.5 * std::pow(2, 30);  // add arbitrary 1.5 GB
    }
 
    void setUpRight(bool upRight) override { _isOriented = !upRight; }
 
    void setConfigurationPreset(ConfigurationPreset preset) override
    {
        switch (preset.descPreset)
        {
            case EImageDescriberPreset::LOW:
            {
                _params.options.maxTotalKeypoints = 5000;
                break;
            }
            case EImageDescriberPreset::MEDIUM:
            {
                _params.options.maxTotalKeypoints = 10000;
                break;
            }
            case EImageDescriberPreset::NORMAL:
            {
                _params.options.maxTotalKeypoints = 20000;
                _params.options.threshold = AKAZEOptions().threshold;
                break;
            }
            case EImageDescriberPreset::HIGH:
            {
                _params.options.maxTotalKeypoints = 50000;
                _params.options.threshold = AKAZEOptions().threshold / 10.f;
                break;
            }
            case EImageDescriberPreset::ULTRA:
            {
                _params.options.maxTotalKeypoints = 100000;
                _params.options.threshold = AKAZEOptions().threshold / 100.f;
                break;
            }
            default:
                throw std::out_of_range("Invalid image describer preset enum");
        }
        if (!preset.gridFiltering)
        {
            // disable grid filtering
            _params.options.maxTotalKeypoints = 0;
        }
    }
 
    bool describe(const image::Image<float>& image, std::unique_ptr<Regions>& regions, const image::Image<unsigned char>* mask = nullptr) override;
 
    void allocate(std::unique_ptr<Regions>& regions) const override
    {
        switch (_params.akazeDescriptorType)
        {
            case AKAZE_MSURF:
                regions.reset(new AKAZE_Float_Regions);
                break;
            case AKAZE_LIOP:
                regions.reset(new AKAZE_Liop_Regions);
                break;
            case AKAZE_MLDB:
                regions.reset(new AKAZE_BinaryRegions);
                break;
        }
    }
 
    ~ImageDescriber_AKAZE() override = default;
 
  private:
    AKAZEParams _params;
    bool _isOriented = true;
};
 
}  // namespace feature
}  // namespace aliceVision