ncorr::DICResult Struct Reference

Result of running DIC on a single deformed frame. More...

#include <session.h>

Public Attributes
int	width = 0
	Width of the displacement fields, in reduced-grid samples.
int	height = 0
	Height of the displacement fields, in reduced-grid samples.
std::vector< double >	u
	Horizontal Lagrangian displacement (u), pixels, row-major. NaN outside ROI.
std::vector< double >	v
	Vertical Lagrangian displacement (v), pixels, row-major. NaN outside ROI.
std::vector< double >	corrcoef
	Per-point correlation coefficient, row-major, size width*height. NaN outside ROI.
bool	valid = false
	True if the frame was processed successfully.
std::string	message
	Human-readable status / error message (empty on success).

Detailed Description

Result of running DIC on a single deformed frame.

Displacement fields are the native Lagrangian (reference-perspective) u / v in pixels, sampled on the reduced DIC analysis grid. width and height therefore describe the displacement array's own dimensions, which are generally smaller than the input image (they depend on scalefactor and subregion radius), NOT the reference frame size.

Fields are returned as flat row-major arrays of length width * height. Points outside the analysed region of interest are set to NaN. The fields are deliberately plain std::vector<double> so callers do not need any internal ncorr types to consume the result.

Definition at line 84 of file session.h.

Member Data Documentation

corrcoef

std::vector<double> ncorr::DICResult::corrcoef

Per-point correlation coefficient, row-major, size width*height. NaN outside ROI.

Definition at line 94 of file session.h.

height

int ncorr::DICResult::height = 0

Height of the displacement fields, in reduced-grid samples.

Definition at line 88 of file session.h.

message

std::string ncorr::DICResult::message

Human-readable status / error message (empty on success).

Definition at line 98 of file session.h.

u

std::vector<double> ncorr::DICResult::u

Horizontal Lagrangian displacement (u), pixels, row-major. NaN outside ROI.

Definition at line 90 of file session.h.

v

std::vector<double> ncorr::DICResult::v

Vertical Lagrangian displacement (v), pixels, row-major. NaN outside ROI.

Definition at line 92 of file session.h.

valid

bool ncorr::DICResult::valid = false

True if the frame was processed successfully.

Definition at line 96 of file session.h.

width

int ncorr::DICResult::width = 0

Width of the displacement fields, in reduced-grid samples.

Definition at line 86 of file session.h.

---

The documentation for this struct was generated from the following file:

• include/ncorr/session.h