session.h

Go to the documentation of this file.

#pragma once
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
namespace ncorr {
 
struct ImageBuffer {
    const std::uint8_t* data = nullptr;
    int width = 0;
    int height = 0;
    int channels = 1;
 
    ImageBuffer() = default;
 
    ImageBuffer(const std::uint8_t* data_, int width_, int height_, int channels_ = 1)
        : data(data_), width(width_), height(height_), channels(channels_) {}
 
    bool valid() const { return data != nullptr && width > 0 && height > 0 && channels > 0; }
 
    std::size_t size_bytes() const { return static_cast<std::size_t>(width) * height * channels; }
};
 
struct DICResult {
    int width = 0;
    int height = 0;
    std::vector<double> u;
    std::vector<double> v;
    std::vector<double> corrcoef;
    bool valid = false;
    std::string message;
};
 
struct SessionConfig {
    int scalefactor = 3;
    int subregion_radius = 20;
    int strain_radius = 5;
    int num_threads = 4;
    bool debug = false;
};
 
class NcorrSession {
  public:
    explicit NcorrSession(const SessionConfig& config = SessionConfig());
 
    ~NcorrSession();
 
    // Movable, non-copyable (owns engine state).
    NcorrSession(NcorrSession&&) noexcept;
    NcorrSession& operator=(NcorrSession&&) noexcept;
    NcorrSession(const NcorrSession&) = delete;
    NcorrSession& operator=(const NcorrSession&) = delete;
 
    void set_reference(const ImageBuffer& ref);
 
    void set_roi(const ImageBuffer& roi_mask);
 
    DICResult process_frame(const ImageBuffer& def);
 
    bool has_reference() const;
 
  private:
    // PIMPL: hides internal ncorr engine types from this public header.
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace ncorr