All tuneable ncorr parameters with their compiled-in defaults. More...

#include <config.h>

Public Attributes
int	scalefactor = 3
	Pyramid scale factor (downsampling level used for the seed search).

std::string	subregion_type = "CIRCLE"
	Subregion shape: "CIRCLE" or "SQUARE".

int	subregion_radius = 20
	Subregion (correlation window) radius in pixels.

std::string	interp_type = "QUINTIC_BSPLINE_PRECOMPUTE"
	Interpolation/order: NEAREST, LINEAR, CUBIC_KEYS[_PRECOMPUTE], QUINTIC_BSPLINE[_PRECOMPUTE].

std::string	strain_subregion_type = "CIRCLE"
	Strain subregion shape: "CIRCLE" or "SQUARE".

int	strain_radius = 5
	Strain window (subregion) radius in pixels.

std::string	dic_config = "NO_UPDATE"
	Reference-update policy: NO_UPDATE, KEEP_MOST_POINTS, REMOVE_BAD_POINTS.

int	num_threads = 4
	Number of worker threads for parallel analysis.

bool	debug = false
	Enable verbose debug output from the engine.

std::string	perspective_interp = "CUBIC_KEYS"
	Interpolation used by the perspective change step.

std::string	units = "mm"
	Physical units label for displacement output.

double	units_per_pixel = 0.2
	Physical units per pixel scaling.

double	alpha = 0.5
	Video overlay alpha (0..1).

double	fps = 15.0
	Output video frames-per-second.

Detailed Description

All tuneable ncorr parameters with their compiled-in defaults.

The field names here are the canonical config keys. The shipped config/default.cfg mirrors every field one-to-one.

Definition at line 28 of file config.h.

Member Data Documentation

◆ alpha

double ncorr::Config::alpha = 0.5

Video overlay alpha (0..1).

Definition at line 68 of file config.h.

◆ debug

bool ncorr::Config::debug = false

Enable verbose debug output from the engine.

Definition at line 56 of file config.h.

◆ dic_config

std::string ncorr::Config::dic_config = "NO_UPDATE"

Reference-update policy: NO_UPDATE, KEEP_MOST_POINTS, REMOVE_BAD_POINTS.

Definition at line 52 of file config.h.

◆ fps

double ncorr::Config::fps = 15.0

Output video frames-per-second.

Definition at line 70 of file config.h.

◆ interp_type

std::string ncorr::Config::interp_type = "QUINTIC_BSPLINE_PRECOMPUTE"

Interpolation/order: NEAREST, LINEAR, CUBIC_KEYS[_PRECOMPUTE], QUINTIC_BSPLINE[_PRECOMPUTE].

Definition at line 42 of file config.h.

◆ num_threads

int ncorr::Config::num_threads = 4

Number of worker threads for parallel analysis.

Definition at line 54 of file config.h.

◆ perspective_interp

std::string ncorr::Config::perspective_interp = "CUBIC_KEYS"

Interpolation used by the perspective change step.

Definition at line 60 of file config.h.

◆ scalefactor

int ncorr::Config::scalefactor = 3

Pyramid scale factor (downsampling level used for the seed search).

Definition at line 31 of file config.h.

◆ strain_radius

int ncorr::Config::strain_radius = 5

Strain window (subregion) radius in pixels.

Definition at line 48 of file config.h.

◆ strain_subregion_type

std::string ncorr::Config::strain_subregion_type = "CIRCLE"

Strain subregion shape: "CIRCLE" or "SQUARE".

Definition at line 46 of file config.h.

◆ subregion_radius

int ncorr::Config::subregion_radius = 20

Subregion (correlation window) radius in pixels.

Definition at line 37 of file config.h.

◆ subregion_type

std::string ncorr::Config::subregion_type = "CIRCLE"

Subregion shape: "CIRCLE" or "SQUARE".

Definition at line 35 of file config.h.

◆ units

std::string ncorr::Config::units = "mm"

Physical units label for displacement output.

Definition at line 62 of file config.h.

◆ units_per_pixel

double ncorr::Config::units_per_pixel = 0.2

Physical units per pixel scaling.

Definition at line 64 of file config.h.

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

include/ncorr/config.h

Public Attributes