search_base.hpp

Go to the documentation of this file.

#pragma once

#include <utils/image.hpp>
#include <utils/dataset.hpp>

#include <cstdint>
#include <vector>
#include <string>
#include <memory>

/// Structure to hold input training parameters (ex. #clusters, #examples to consider)
struct TrainParamsBase {
};

/// Structure to hold input search parameters (ex. #matches, threshold, number neighbors to consider, etc.)
struct SearchParamsBase {
};


/// Structure to hold returned match results (returned from a search call).
struct MatchResultsBase {
        std::vector<uint64_t> matches;
        
};


/// Abstract class from which all search structures and methods derive from.  Each search method
/// must implement train, search, load and save. 
class SearchBase {

public:
        SearchBase();
        SearchBase(const std::string &file_path);

        virtual ~SearchBase();

        /// Given a set of training parameters, list of images, trains.  Returns true if successful, false
        /// if not successful.
        virtual bool train (Dataset &dataset, const std::shared_ptr<const TrainParamsBase> &params, const std::vector< std::shared_ptr<const Image > > &examples) = 0;

        /// Given a set of search parameters, list of query images, searches for matching images and returns the result
        /// matches.
        std::vector< std::shared_ptr<MatchResultsBase> > search(Dataset &dataset, const std::shared_ptr<SearchParamsBase> &params,
                                                                                                                         const std::vector< std::shared_ptr<const Image > > &examples);

        /// Loads a trained search structure from the input filepath
        virtual bool load (const std::string &file_path) = 0;

        /// Saves a trained search structure to the input filepath
        virtual bool save (const std::string &file_path) const = 0;

protected:

        /// Given a set of search parameters, a query images, searches for matching images and returns the match
        virtual std::shared_ptr<MatchResultsBase> search(Dataset &dataset, const std::shared_ptr<const SearchParamsBase> &params, const std::shared_ptr<const Image > &example) = 0;

private:
        
};