AliceVision
Photogrammetric Computer Vision Framework
ImageDescriber_SIFT_vlfeat.hpp
1 // This file is part of the AliceVision project.
2 // Copyright (c) 2016 AliceVision contributors.
3 // Copyright (c) 2012 openMVG contributors.
4 // This Source Code Form is subject to the terms of the Mozilla Public License,
5 // v. 2.0. If a copy of the MPL was not distributed with this file,
6 // You can obtain one at https://mozilla.org/MPL/2.0/.
7 
8 #pragma once
9 
10 #include <aliceVision/feature/Descriptor.hpp>
11 #include <aliceVision/feature/ImageDescriber.hpp>
12 #include <aliceVision/feature/regionsFactory.hpp>
13 #include <aliceVision/feature/sift/SIFT.hpp>
14 
15 extern "C"
16 {
17 #include <nonFree/sift/vl/sift.h>
18 }
19 
20 #include <iostream>
21 #include <numeric>
22 
23 namespace aliceVision {
24 namespace feature {
25 
30 {
31  public:
32  explicit ImageDescriber_SIFT_vlfeat(const SiftParams& params = SiftParams(), bool isOriented = true)
33  : ImageDescriber(),
34  _params(params),
35  _isOriented(isOriented)
36  {
37  // Configure VLFeat
38  VLFeatInstance::initialize();
39  }
40 
41  ~ImageDescriber_SIFT_vlfeat() override { VLFeatInstance::destroy(); }
42 
47  bool useCuda() const override { return false; }
48 
53  bool useFloatImage() const override { return true; }
54 
59  EImageDescriberType getDescriberType() const override
60  {
61  if (!_isOriented)
62  return EImageDescriberType::SIFT_UPRIGHT;
63  return EImageDescriberType::SIFT;
64  }
65 
73  std::size_t getMemoryConsumption(std::size_t width, std::size_t height) const override
74  {
75  return getMemoryConsumptionVLFeat(width, height, _params);
76  }
77 
82  void setUpRight(bool upRight) override { _isOriented = !upRight; }
83 
88  void setConfigurationPreset(ConfigurationPreset preset) override { _params.setPreset(preset); }
89 
98  bool describe(const image::Image<float>& image, std::unique_ptr<Regions>& regions, const image::Image<unsigned char>* mask = nullptr) override
99  {
100  return extractSIFT<unsigned char>(image, regions, _params, _isOriented, mask);
101  }
102 
107  void allocate(std::unique_ptr<Regions>& regions) const override { regions.reset(new SIFT_Regions); }
108 
109  private:
110  SiftParams _params;
111  bool _isOriented;
112 };
113 
114 } // namespace feature
115 } // namespace aliceVision
aliceVision::feature::ImageDescriber_SIFT_vlfeat::allocate
void allocate(std::unique_ptr< Regions > &regions) const override
Allocate Regions type depending of the ImageDescriber.
Definition: ImageDescriber_SIFT_vlfeat.hpp:107
aliceVision::feature::ImageDescriber_SIFT_vlfeat::useCuda
bool useCuda() const override
Check if the image describer use CUDA.
Definition: ImageDescriber_SIFT_vlfeat.hpp:47
aliceVision::feature::ImageDescriber_SIFT_vlfeat::useFloatImage
bool useFloatImage() const override
Check if the image describer use float image.
Definition: ImageDescriber_SIFT_vlfeat.hpp:53
aliceVision::feature::SiftParams
Definition: SIFT.hpp:35
aliceVision::feature::ImageDescriber_SIFT_vlfeat::getDescriberType
EImageDescriberType getDescriberType() const override
Get the corresponding EImageDescriberType.
Definition: ImageDescriber_SIFT_vlfeat.hpp:59
aliceVision::feature::ImageDescriber_SIFT_vlfeat::describe
bool describe(const image::Image< float > &image, std::unique_ptr< Regions > &regions, const image::Image< unsigned char > *mask=nullptr) override
Detect regions on the float image and compute their attributes (description)
Definition: ImageDescriber_SIFT_vlfeat.hpp:98
aliceVision
Definition: checkerDetector.cpp:32
aliceVision::feature::ImageDescriber
A pure virtual class for image description computation.
Definition: ImageDescriber.hpp:159
aliceVision::image::Image< float >
aliceVision::feature::ImageDescriber_SIFT_vlfeat::setUpRight
void setUpRight(bool upRight) override
Set image describer always upRight.
Definition: ImageDescriber_SIFT_vlfeat.hpp:82
aliceVision::feature::ImageDescriber_SIFT_vlfeat::setConfigurationPreset
void setConfigurationPreset(ConfigurationPreset preset) override
Use a preset to control the number of detected regions.
Definition: ImageDescriber_SIFT_vlfeat.hpp:88
aliceVision::feature::ImageDescriber_SIFT_vlfeat
Create an ImageDescriber interface for VLFeat SIFT feature extractor.
Definition: ImageDescriber_SIFT_vlfeat.hpp:29
aliceVision::feature::FeatDescRegions
Definition: Regions.hpp:144
aliceVision::feature::ConfigurationPreset
Definition: ImageDescriber.hpp:118
aliceVision::feature::ImageDescriber_SIFT_vlfeat::getMemoryConsumption
std::size_t getMemoryConsumption(std::size_t width, std::size_t height) const override
Get the total amount of RAM needed for a feature extraction of an image of the given dimension.
Definition: ImageDescriber_SIFT_vlfeat.hpp:73