session.h File Reference

In-memory DIC session API for CppNCorr. More...

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

Go to the source code of this file.

Classes
struct	ncorr::ImageBuffer
	Thin, non-owning view over a raw image in memory. More...
struct	ncorr::DICResult
	Result of running DIC on a single deformed frame. More...
struct	ncorr::SessionConfig
	Configuration for an in-memory DIC session. More...
class	ncorr::NcorrSession
	Drives an in-memory Digital Image Correlation session. More...

Namespaces
namespace	ncorr

Detailed Description

In-memory DIC session API for CppNCorr.

This header defines a small, dependency-light interface that lets a caller (for example CPPxDIC's proxyncorr target) push raw image buffers directly to the ncorr DIC engine without first writing frames to disk.

Design goals:

• The public surface depends only on standard-library types and the thin ncorr::ImageBuffer struct, so callers need not include the heavy internal ncorr headers (Array2D, Disp2D, ...) just to drive a session.
• The usage pattern mirrors the file-based pipeline: set a reference frame once, then process one or more deformed frames.

Note

Results are the native Lagrangian displacement fields, in pixels, on the reduced DIC analysis grid (see DICResult). The implementation drives the same engine path as the image-folder reader in proxyncorr.cpp (Image2D -> DIC_analysis_input -> DIC_analysis).

Definition in file session.h.