ncorr Namespace Reference

Namespaces
namespace	details
namespace	exact_detail
namespace	legacy_detail
namespace	log

Classes
class	Array2D
struct	Config
	All tuneable ncorr parameters with their compiled-in defaults. More...
class	Data2D
struct	DIC_analysis_input
struct	DIC_analysis_output
struct	DIC_analysis_parallel_input
struct	DIC_analysis_step_data
struct	DICResult
	Result of running DIC on a single deformed frame. More...
class	Disp2D
struct	FilterConfig
class	Image2D
struct	ImageBuffer
	Thin, non-owning view over a raw image in memory. More...
class	ImageProcessor
class	IniFile
	In-memory representation of a parsed INI file. More...
class	NcorrSession
	Drives an in-memory Digital Image Correlation session. More...
class	ROI2D
struct	SeedAnalysisResult
struct	SeedComputationData
struct	SeedConvergence
struct	SeedParams
struct	SessionConfig
	Configuration for an in-memory DIC session. More...
class	Strain2D
struct	strain_analysis_input
struct	strain_analysis_output
class	VideoImporter
struct	VideoImportParams

Enumerations
enum class	PAD { ZEROS , EXPAND_EDGES }
enum class	INTERP {   NEAREST , LINEAR , CUBIC_KEYS , CUBIC_KEYS_PRECOMPUTE ,   QUINTIC_BSPLINE , QUINTIC_BSPLINE_PRECOMPUTE }
enum class	LINSOLVER { LU , QR , CHOL }
enum class	FilterType { SATURATION , BANDPASS }
enum class	ROI_UPDATE_MODE { SKIP_ALL , SKIP_INVALID }
enum class	ACCUMULATION_MODE { ON_THE_FLY , POST_PROCESS }
enum class	DIC_analysis_config { NO_UPDATE , KEEP_MOST_POINTS , REMOVE_BAD_POINTS }
enum class	PERSPECTIVE { EULERIAN , LAGRANGIAN }
enum class	DISP { U , V }
enum class	STRAIN { EYY , EXY , EXX }
enum class	SUBREGION { CIRCLE , SQUARE }

Functions
template<typename T = double, typename T_alloc = std::allocator<T>>
Array2D< T, T_alloc >	eye (typename Array2D< T, T_alloc >::difference_type n, T type=T(), T_alloc=T_alloc())
ROI2D	update (const ROI2D &, const Disp2D &, INTERP, ROI_UPDATE_MODE mode=ROI_UPDATE_MODE::SKIP_ALL)
ROI2D	matlab_update_roi (const ROI2D &, const Disp2D &, INTERP, ROI2D::difference_type radius)
Data2D	update (const Data2D &, const Disp2D &, INTERP, ROI_UPDATE_MODE mode=ROI_UPDATE_MODE::SKIP_ALL)
Disp2D	add (const std::vector< Disp2D > &, INTERP)
Disp2D	add_with_rois (const std::vector< Disp2D > &disps, const std::vector< ROI2D > &rois, INTERP interp_type)
Disp2D	RGDIC (const Array2D< double > &, const Array2D< double > &, const ROI2D &, ROI2D::difference_type, INTERP, SUBREGION, ROI2D::difference_type, ROI2D::difference_type, double, bool)
DIC_analysis_output	DIC_analysis (const DIC_analysis_input &)
DIC_analysis_output	DIC_analysis_sequential (const DIC_analysis_input &)
SeedAnalysisResult	analyze_seeds (const details::subregion_nloptimizer &sr_nloptimizer, const Array2D< double > &ref_gs, const ROI2D &roi, const std::vector< SeedParams > &seed_positions, ROI2D::difference_type radius, int cutoff_iteration, double cutoff_max_diffnorm, double cutoff_max_corrcoef, bool debug=true)
std::vector< SeedComputationData >	compute_only_seed_points (const Array2D< double > &A_ref, const std::vector< Array2D< double > > &A_curs, const ROI2D &roi, ROI2D::difference_type scalefactor, INTERP interp_type, SUBREGION subregion_type, const std::vector< SeedParams > &seeds_by_region, double cutoff_corrcoef, ROI2D::difference_type region_idx=0, bool debug=false)
Disp2D	compute_displacements (const details::subregion_nloptimizer &sr_nloptimizer, const ROI2D &roi_reduced, const SeedParams &seedparams, ROI2D::difference_type scalefactor, double cutoff_corrcoef, ROI2D::difference_type region_idx, bool debug)
std::vector< SeedParams >	propagate_seeds (const std::vector< SeedParams > &seeds, ROI2D::difference_type spacing)
DIC_analysis_output	DIC_analysis_parallel (const DIC_analysis_parallel_input &)
DIC_analysis_output	matlab_DIC_analysis_parallel (const DIC_analysis_parallel_input &)
DIC_analysis_output	DIC_analysis_sequential (const DIC_analysis_input &DIC_input, const std::vector< SeedParams > &seeds_by_region={}, bool seeds_are_optimized=false)
DIC_analysis_output	DIC_analysis_sequential (const DIC_analysis_parallel_input &)
DIC_analysis_output	matlab_DIC_analysis_sequential (const DIC_analysis_input &DIC_input, const std::vector< SeedParams > &seeds_by_region={}, bool seeds_are_optimized=false)
DIC_analysis_output	matlab_DIC_analysis_sequential (const DIC_analysis_parallel_input &)
DIC_analysis_output	exact_matlab_DIC_analysis_parallel (const DIC_analysis_parallel_input &)
DIC_analysis_output	exact_matlab_DIC_analysis_sequential (const DIC_analysis_input &DIC_input, const std::vector< SeedParams > &seeds_by_region={}, bool seeds_are_optimized=false)
DIC_analysis_output	exact_matlab_DIC_analysis_sequential (const DIC_analysis_parallel_input &)
Disp2D	exact_add_with_rois (const std::vector< Disp2D > &disps, const std::vector< ROI2D > &rois)
Disp2D	RGDIC_with_seeds (const Array2D< double > &A_ref, const Array2D< double > &A_cur, const ROI2D &roi, const DIC_analysis_parallel_input &input)
DIC_analysis_output	change_perspective (const DIC_analysis_output &, INTERP)
DIC_analysis_output	change_perspective_with_inversion (const DIC_analysis_output &, INTERP)
DIC_analysis_output	set_units (const DIC_analysis_output &, const std::string &, double)
DIC_analysis_output	filter_by_correlation (const DIC_analysis_output &, double)
Strain2D	LS_strain (const Disp2D &, PERSPECTIVE, double, SUBREGION, ROI2D::difference_type)
strain_analysis_output	strain_analysis (const strain_analysis_input &)
void	imshow_ncorr_data_over_img (const Image2D &, const Data2D &, ROI2D::difference_type=-1)
void	save_ncorr_data_over_img (const std::string &, const Image2D &, const Data2D &, double, double, double, bool, bool, bool, const std::string &, double, double, double, ROI2D::difference_type, int)
void	save_ncorr_data_over_img_video (const std::string &, const std::vector< Image2D > &, const std::vector< Data2D > &, double, double, double, double, bool, bool, bool, const std::string &, double, double, double, ROI2D::difference_type, int, double, int)
void	save_DIC_video (const std::string &, const DIC_analysis_input &, const DIC_analysis_output &, DISP, double, double, double=std::numeric_limits< double >::quiet_NaN(), double=std::numeric_limits< double >::quiet_NaN(), bool=true, bool=true, bool=true, double=-1.0, double=1.0, ROI2D::difference_type=11, int=cv::COLORMAP_JET, double=2.0, int=cv::VideoWriter::fourcc('M', 'J', 'P', 'G'))
void	save_strain_video (const std::string &, const strain_analysis_input &, const strain_analysis_output &, STRAIN, double, double, double=std::numeric_limits< double >::quiet_NaN(), double=std::numeric_limits< double >::quiet_NaN(), bool=true, bool=true, bool=true, double=-1.0, double=1.0, ROI2D::difference_type=11, int=cv::COLORMAP_JET, double=2.0, int=cv::VideoWriter::fourcc('M', 'J', 'P', 'G'))
bool	load_config_file (const std::string &config_path, Config &out)
	Load compiled defaults, then overlay values from an INI config file.
const std::vector< std::string > &	image_extensions ()
	Supported image extensions (lowercase, including the leading dot).
bool	has_image_extension (const std::string &lower_name)
	Test whether a (lowercased) filename ends with a supported image extension.
bool	natural_less (const std::string &a, const std::string &b)
	Natural (human) ordering comparison for filenames.
std::vector< std::string >	discover_frames (const std::string &folder, const std::string &ref_path, const std::string &roi_path)
	Discover the deformed-frame image files inside folder.
template<typename T , typename T_container >
T_container &	fill (T_container &A, const ROI2D::region_nlinfo &nlinfo, const T &val)
template<typename T , typename T_container >
T_container &	fill (T_container &A, const Array2D< double > &boundary, const T &val)
template<typename T_container >
std::pair< typename T_container::value_type, typename T_container::coords >	max (T_container &A, const ROI2D::region_nlinfo &nlinfo)
template<typename T_container >
std::pair< typename T_container::value_type, typename T_container::coords >	min (T_container &A, const ROI2D::region_nlinfo &nlinfo)
std::ostream &	operator<< (std::ostream &os, const Data2D &data)
void	imshow (const Data2D &data, Data2D::difference_type delay)
bool	isequal (const Data2D &data1, const Data2D &data2)
void	save (const Data2D &data, std::ofstream &os)
std::ostream &	operator<< (std::ostream &os, const Disp2D &disp)
void	imshow (const Disp2D &disp, Disp2D::difference_type delay)
bool	isequal (const Disp2D &disp1, const Disp2D &disp2)
void	save (const Disp2D &disp, std::ofstream &os)
std::ostream &	operator<< (std::ostream &os, const Image2D &img)
void	imshow (const Image2D &img, Image2D::difference_type delay)
bool	isequal (const Image2D &img1, const Image2D &img2)
void	save (const Image2D &img, std::ofstream &os)
Disp2D	RGDIC_without_thread (const Array2D< double > &A_ref, const Array2D< double > &A_cur, const ROI2D &roi, ROI2D::difference_type scalefactor, INTERP interp_type, SUBREGION subregion_type, ROI2D::difference_type r, double cutoff_corrcoef, bool debug, const std::vector< SeedParams > &seeds_by_region={}, bool seeds_are_optimized=false)
void	save (const DIC_analysis_input &DIC_input, std::ofstream &os)
void	save (const DIC_analysis_input &DIC_input, const std::string &filename)
void	save (const DIC_analysis_output &DIC_output, std::ofstream &os)
void	save (const DIC_analysis_output &DIC_output, const std::string &filename)
void	save (const DIC_analysis_step_data &step_data, std::ofstream &os)
void	save (const DIC_analysis_step_data &step_data, const std::string &filename)
void	save (const strain_analysis_input &strain_input, std::ofstream &os)
void	save (const strain_analysis_input &strain_input, const std::string &filename)
void	save (const strain_analysis_output &strain_output, std::ofstream &os)
void	save (const strain_analysis_output &strain_output, const std::string &filename)
std::vector< SeedComputationData >	compute_only_seed_points (const Array2D< double > &A_ref, const std::vector< Array2D< double > > &A_curs, const ROI2D &roi, ROI2D::difference_type scalefactor, INTERP interp_type, SUBREGION subregion_type, ROI2D::difference_type r, const std::vector< SeedParams > &seeds_by_region, double cutoff_corrcoef, ROI2D::difference_type region_idx, bool debug)
DIC_analysis_output	exact_matlab_DIC_analysis_impl (const DIC_analysis_parallel_input &input, bool run_in_parallel, const std::string &mode_name)
std::ostream &	operator<< (std::ostream &os, const ROI2D &roi)
bool	isequal (const ROI2D &roi1, const ROI2D &roi2)
void	save (const ROI2D &roi, std::ofstream &os)
std::ostream &	operator<< (std::ostream &os, const ROI2D::region_nlinfo &nlinfo)
bool	isequal (const ROI2D::region_nlinfo &nlinfo1, const ROI2D::region_nlinfo &nlinfo2)
void	save (const ROI2D::region_nlinfo &nlinfo, std::ofstream &os)
std::ostream &	operator<< (std::ostream &os, const ROI2D::region_boundary &boundary)
bool	isequal (const ROI2D::region_boundary &boundary1, const ROI2D::region_boundary &boundary2)
void	save (const ROI2D::region_boundary &boundary, std::ofstream &os)
std::ostream &	operator<< (std::ostream &os, const ROI2D::region &reg)
void	save (const ROI2D::region &reg, std::ofstream &os)
std::ostream &	operator<< (std::ostream &os, const Strain2D &strain)
void	imshow (const Strain2D &strain, Strain2D::difference_type delay)
bool	isequal (const Strain2D &strain1, const Strain2D &strain2)
void	save (const Strain2D &strain, std::ofstream &os)

Variables
const class details::last_index	last
const class details::all_range	all

Enumeration Type Documentation

ACCUMULATION_MODE

enum class ncorr::ACCUMULATION_MODE

strong

Enumerator
ON_THE_FLY
POST_PROCESS

Definition at line 160 of file ncorr.h.

DIC_analysis_config

enum class ncorr::DIC_analysis_config

strong

Enumerator
NO_UPDATE
KEEP_MOST_POINTS
REMOVE_BAD_POINTS

Definition at line 176 of file ncorr.h.

DISP

enum class ncorr::DISP

strong

Enumerator
U
V

Definition at line 628 of file ncorr.h.

FilterType

enum class ncorr::FilterType

strong

Enumerator
SATURATION
BANDPASS

Definition at line 24 of file Image2D.h.

INTERP

enum class ncorr::INTERP

strong

Enumerator
NEAREST
LINEAR
CUBIC_KEYS
CUBIC_KEYS_PRECOMPUTE
QUINTIC_BSPLINE
QUINTIC_BSPLINE_PRECOMPUTE

Definition at line 77 of file Array2D.h.

LINSOLVER

enum class ncorr::LINSOLVER

strong

Enumerator
LU
QR
CHOL

Definition at line 78 of file Array2D.h.

PAD

enum class ncorr::PAD

strong

Enumerator
ZEROS
EXPAND_EDGES

Definition at line 73 of file Array2D.h.

PERSPECTIVE

enum class ncorr::PERSPECTIVE

strong

Enumerator
EULERIAN
LAGRANGIAN

Definition at line 249 of file ncorr.h.

ROI_UPDATE_MODE

enum class ncorr::ROI_UPDATE_MODE

strong

Enumerator
SKIP_ALL
SKIP_INVALID

Definition at line 152 of file ncorr.h.

STRAIN

enum class ncorr::STRAIN

strong

Enumerator
EYY
EXY
EXX

Definition at line 647 of file ncorr.h.

SUBREGION

enum class ncorr::SUBREGION

strong

Enumerator
CIRCLE
SQUARE

Definition at line 27 of file ROI2D.h.

Function Documentation

add()

Disp2D ncorr::add	(	const std::vector< Disp2D > &	disps,
		INTERP	interp_type
	)

Definition at line 1126 of file ncorr.cpp.

add_with_rois()

Disp2D ncorr::add_with_rois	(	const std::vector< Disp2D > &	disps,
		const std::vector< ROI2D > &	rois,
		INTERP	interp_type
	)

Definition at line 1246 of file ncorr.cpp.

analyze_seeds()

SeedAnalysisResult ncorr::analyze_seeds	(	const details::subregion_nloptimizer &	sr_nloptimizer,
		const Array2D< double > &	ref_gs,
		const ROI2D &	roi,
		const std::vector< SeedParams > &	seed_positions,
		ROI2D::difference_type	radius,
		int	cutoff_iteration,
		double	cutoff_max_diffnorm,
		double	cutoff_max_corrcoef,
		bool	debug = true
	)

Definition at line 4699 of file ncorr.cpp.

change_perspective()

DIC_analysis_output ncorr::change_perspective	(	const DIC_analysis_output &	DIC_output,
		INTERP	interp_type
	)

Definition at line 3366 of file ncorr.cpp.

change_perspective_with_inversion()

DIC_analysis_output ncorr::change_perspective_with_inversion	(	const DIC_analysis_output &	DIC_output,
		INTERP	interp_type
	)

Definition at line 3400 of file ncorr.cpp.

compute_displacements()

Disp2D ncorr::compute_displacements	(	const details::subregion_nloptimizer &	sr_nloptimizer,
		const ROI2D &	roi_reduced,
		const SeedParams &	seedparams,
		ROI2D::difference_type	scalefactor,
		double	cutoff_corrcoef,
		ROI2D::difference_type	region_idx,
		bool	debug
	)

Definition at line 4470 of file ncorr.cpp.

compute_only_seed_points() [1/2]

std::vector< SeedComputationData > ncorr::compute_only_seed_points	(	const Array2D< double > &	A_ref,
		const std::vector< Array2D< double > > &	A_curs,
		const ROI2D &	roi,
		ROI2D::difference_type	scalefactor,
		INTERP	interp_type,
		SUBREGION	subregion_type,
		const std::vector< SeedParams > &	seeds_by_region,
		double	cutoff_corrcoef,
		ROI2D::difference_type	region_idx = 0,
		bool	debug = false
	)

compute_only_seed_points() [2/2]

std::vector< SeedComputationData > ncorr::compute_only_seed_points	(	const Array2D< double > &	A_ref,
		const std::vector< Array2D< double > > &	A_curs,
		const ROI2D &	roi,
		ROI2D::difference_type	scalefactor,
		INTERP	interp_type,
		SUBREGION	subregion_type,
		ROI2D::difference_type	r,
		const std::vector< SeedParams > &	seeds_by_region,
		double	cutoff_corrcoef,
		ROI2D::difference_type	region_idx,
		bool	debug
	)

Definition at line 4578 of file ncorr.cpp.

DIC_analysis()

DIC_analysis_output ncorr::DIC_analysis

(

const DIC_analysis_input &

DIC_input

)

Definition at line 2718 of file ncorr.cpp.

DIC_analysis_parallel()

DIC_analysis_output ncorr::DIC_analysis_parallel

(

const DIC_analysis_parallel_input &

input

)

Definition at line 5260 of file ncorr.cpp.

DIC_analysis_sequential() [1/3]

DIC_analysis_output ncorr::DIC_analysis_sequential

(

const DIC_analysis_input &

)

DIC_analysis_sequential() [2/3]

DIC_analysis_output ncorr::DIC_analysis_sequential	(	const DIC_analysis_input &	DIC_input,
		const std::vector< SeedParams > &	seeds_by_region = {},
		bool	seeds_are_optimized = false
	)

Definition at line 2916 of file ncorr.cpp.

DIC_analysis_sequential() [3/3]

DIC_analysis_output ncorr::DIC_analysis_sequential

(

const DIC_analysis_parallel_input &

parallel_input

)

Definition at line 3128 of file ncorr.cpp.

discover_frames()

std::vector< std::string > ncorr::discover_frames ( const std::string &  folder, const std::string &  ref_path, const std::string &  roi_path  )

inline

Discover the deformed-frame image files inside folder.

See the file-level documentation for the expected naming convention. Files named "roi.png"/"ref.png" (case-insensitive) and any matching the supplied roi_path / ref_path basenames are excluded; hidden files, sub-directories and non-image extensions are skipped. The result is sorted with natural_less.

Parameters

folder	Directory to scan.
ref_path	Reference image path whose basename should be excluded (may be empty).
roi_path	ROI image path whose basename should be excluded (may be empty).

Returns

Frame paths (folder + "/" + name) in natural order. Empty if the folder has no usable frames (the caller is expected to report that).

Exceptions

std::runtime_error

if folder cannot be opened.

Definition at line 122 of file frame_reader.h.

exact_add_with_rois()

Disp2D ncorr::exact_add_with_rois	(	const std::vector< Disp2D > &	disps,
		const std::vector< ROI2D > &	rois
	)

Definition at line 5556 of file ncorr.cpp.

exact_matlab_DIC_analysis_impl()

DIC_analysis_output ncorr::exact_matlab_DIC_analysis_impl	(	const DIC_analysis_parallel_input &	input,
		bool	run_in_parallel,
		const std::string &	mode_name
	)

Definition at line 5684 of file ncorr.cpp.

exact_matlab_DIC_analysis_parallel()

DIC_analysis_output ncorr::exact_matlab_DIC_analysis_parallel

(

const DIC_analysis_parallel_input &

input

)

Definition at line 5811 of file ncorr.cpp.

exact_matlab_DIC_analysis_sequential() [1/2]

DIC_analysis_output ncorr::exact_matlab_DIC_analysis_sequential	(	const DIC_analysis_input &	DIC_input,
		const std::vector< SeedParams > &	seeds_by_region = {},
		bool	seeds_are_optimized = false
	)

Definition at line 5802 of file ncorr.cpp.

exact_matlab_DIC_analysis_sequential() [2/2]

DIC_analysis_output ncorr::exact_matlab_DIC_analysis_sequential

(

const DIC_analysis_parallel_input &

input

)

Definition at line 5808 of file ncorr.cpp.

eye()

template<typename T = double, typename T_alloc = std::allocator<T>>

Array2D< T, T_alloc > ncorr::eye	(	typename Array2D< T, T_alloc >::difference_type	n,
		T	type = T(),
		T_alloc	= T_alloc()
	)

Definition at line 4225 of file Array2D.h.

fill() [1/2]

template<typename T , typename T_container >

T_container & ncorr::fill	(	T_container &	A,
		const Array2D< double > &	boundary,
		const T &	val
	)

Definition at line 440 of file ROI2D.h.

fill() [2/2]

template<typename T , typename T_container >

T_container & ncorr::fill	(	T_container &	A,
		const ROI2D::region_nlinfo &	nlinfo,
		const T &	val
	)

Definition at line 422 of file ROI2D.h.

filter_by_correlation()

DIC_analysis_output ncorr::filter_by_correlation	(	const DIC_analysis_output &	DIC_output,
		double	cutoff_corrcoef
	)

Definition at line 3483 of file ncorr.cpp.

has_image_extension()

bool ncorr::has_image_extension ( const std::string &  lower_name )

inline

Test whether a (lowercased) filename ends with a supported image extension.

Length-safe: never reads out of bounds for short names.

Parameters

lower_name

Filename already converted to lowercase.

Returns

true if the name ends with one of image_extensions().

Definition at line 60 of file frame_reader.h.

image_extensions()

const std::vector< std::string > & ncorr::image_extensions ( )

inline

Supported image extensions (lowercase, including the leading dot).

Mirrors the formats OpenCV's imread handles in this build. Keep in sync with the user guide.

Definition at line 46 of file frame_reader.h.

imshow() [1/4]

void ncorr::imshow	(	const Data2D &	data,
		Data2D::difference_type	delay
	)

Definition at line 58 of file Data2D.cpp.

imshow() [2/4]

void ncorr::imshow	(	const Disp2D &	disp,
		Disp2D::difference_type	delay
	)

Definition at line 38 of file Disp2D.cpp.

imshow() [3/4]

void ncorr::imshow	(	const Image2D &	img,
		Image2D::difference_type	delay
	)

Definition at line 90 of file Image2D.cpp.

imshow() [4/4]

void ncorr::imshow	(	const Strain2D &	strain,
		Strain2D::difference_type	delay
	)

Definition at line 38 of file Strain2D.cpp.

imshow_ncorr_data_over_img()

void ncorr::imshow_ncorr_data_over_img	(	const Image2D &	img,
		const Data2D &	data,
		ROI2D::difference_type	delay = -1
	)

Definition at line 4132 of file ncorr.cpp.

isequal() [1/7]

bool ncorr::isequal	(	const Data2D &	data1,
		const Data2D &	data2
	)

Definition at line 72 of file Data2D.cpp.

isequal() [2/7]

bool ncorr::isequal	(	const Disp2D &	disp1,
		const Disp2D &	disp2
	)

Definition at line 46 of file Disp2D.cpp.

isequal() [3/7]

bool ncorr::isequal	(	const Image2D &	img1,
		const Image2D &	img2
	)

Definition at line 94 of file Image2D.cpp.

isequal() [4/7]

bool ncorr::isequal	(	const ROI2D &	roi1,
		const ROI2D &	roi2
	)

Definition at line 164 of file ROI2D.cpp.

isequal() [5/7]

bool ncorr::isequal	(	const ROI2D::region_boundary &	boundary1,
		const ROI2D::region_boundary &	boundary2
	)

Definition at line 957 of file ROI2D.cpp.

isequal() [6/7]

bool ncorr::isequal	(	const ROI2D::region_nlinfo &	nlinfo1,
		const ROI2D::region_nlinfo &	nlinfo2
	)

Definition at line 357 of file ROI2D.cpp.

isequal() [7/7]

bool ncorr::isequal	(	const Strain2D &	strain1,
		const Strain2D &	strain2
	)

Definition at line 46 of file Strain2D.cpp.

load_config_file()

bool ncorr::load_config_file	(	const std::string &	config_path,
		Config &	out
	)

Load compiled defaults, then overlay values from an INI config file.

Only keys present in the file override the corresponding Config field; unknown keys are ignored (optionally reported by the parser). Missing file is treated as "use defaults".

Parameters

config_path	Path to an INI config file (e.g. config/default.cfg).
out	Config to update in place (start from compiled defaults).

Returns

true if the file was found and parsed; false if it did not exist (in which case out is left at its incoming/default values).

Exceptions

std::runtime_error

on a malformed value (e.g. non-integer for an int).

Definition at line 15 of file config.cpp.

LS_strain()

Strain2D ncorr::LS_strain	(	const Disp2D &	disp,
		PERSPECTIVE	perspective_type,
		double	units_per_pixel,
		SUBREGION	subregion_type,
		ROI2D::difference_type	r
	)

Definition at line 3547 of file ncorr.cpp.

matlab_DIC_analysis_parallel()

DIC_analysis_output ncorr::matlab_DIC_analysis_parallel

(

const DIC_analysis_parallel_input &

input

)

Definition at line 5255 of file ncorr.cpp.

matlab_DIC_analysis_sequential() [1/2]

DIC_analysis_output ncorr::matlab_DIC_analysis_sequential	(	const DIC_analysis_input &	DIC_input,
		const std::vector< SeedParams > &	seeds_by_region = {},
		bool	seeds_are_optimized = false
	)

Definition at line 5245 of file ncorr.cpp.

matlab_DIC_analysis_sequential() [2/2]

DIC_analysis_output ncorr::matlab_DIC_analysis_sequential

(

const DIC_analysis_parallel_input &

input

)

Definition at line 5251 of file ncorr.cpp.

matlab_update_roi()

ROI2D ncorr::matlab_update_roi	(	const ROI2D &	roi,
		const Disp2D &	disp,
		INTERP	interp_type,
		ROI2D::difference_type	radius
	)

Definition at line 804 of file ncorr.cpp.

max()

template<typename T_container >

std::pair< typename T_container::value_type, typename T_container::coords > ncorr::max	(	T_container &	A,
		const ROI2D::region_nlinfo &	nlinfo
	)

Definition at line 509 of file ROI2D.h.

min()

template<typename T_container >

std::pair< typename T_container::value_type, typename T_container::coords > ncorr::min	(	T_container &	A,
		const ROI2D::region_nlinfo &	nlinfo
	)

Definition at line 538 of file ROI2D.h.

natural_less()

bool ncorr::natural_less ( const std::string &  a, const std::string &  b  )

inline

Natural (human) ordering comparison for filenames.

Compares runs of digits by numeric value so unpadded numeric frame names sort correctly, e.g. "frame_2.png" < "frame_10.png". Falls back to lexicographic for non-digit runs. Zero-padded names also sort correctly under this rule.

Parameters

a	Left-hand filename.
b	Right-hand filename.

Returns

true if a should sort before b.

Definition at line 81 of file frame_reader.h.

operator<<() [1/8]

std::ostream & ncorr::operator<<	(	std::ostream &	os,
		const Data2D &	data
	)

Definition at line 50 of file Data2D.cpp.

operator<<() [2/8]

std::ostream & ncorr::operator<<	(	std::ostream &	os,
		const Disp2D &	disp
	)

Definition at line 30 of file Disp2D.cpp.

operator<<() [3/8]

std::ostream & ncorr::operator<<	(	std::ostream &	os,
		const Image2D &	img
	)

Definition at line 80 of file Image2D.cpp.

operator<<() [4/8]

std::ostream & ncorr::operator<<	(	std::ostream &	os,
		const ROI2D &	roi
	)

Definition at line 151 of file ROI2D.cpp.

operator<<() [5/8]

std::ostream & ncorr::operator<<	(	std::ostream &	os,
		const ROI2D::region &	reg
	)

Definition at line 1029 of file ROI2D.cpp.

operator<<() [6/8]

std::ostream & ncorr::operator<<	(	std::ostream &	os,
		const ROI2D::region_boundary &	boundary
	)

Definition at line 946 of file ROI2D.cpp.

operator<<() [7/8]

std::ostream & ncorr::operator<<	(	std::ostream &	os,
		const ROI2D::region_nlinfo &	nlinfo
	)

Definition at line 338 of file ROI2D.cpp.

operator<<() [8/8]

std::ostream & ncorr::operator<<	(	std::ostream &	os,
		const Strain2D &	strain
	)

Definition at line 30 of file Strain2D.cpp.

propagate_seeds()

std::vector< SeedParams > ncorr::propagate_seeds	(	const std::vector< SeedParams > &	seeds,
		ROI2D::difference_type	spacing
	)

Definition at line 4680 of file ncorr.cpp.

RGDIC()

Disp2D ncorr::RGDIC	(	const Array2D< double > &	A_ref,
		const Array2D< double > &	A_cur,
		const ROI2D &	roi,
		ROI2D::difference_type	scalefactor,
		INTERP	interp_type,
		SUBREGION	subregion_type,
		ROI2D::difference_type	r,
		ROI2D::difference_type	num_threads,
		double	cutoff_corrcoef,
		bool	debug
	)

Definition at line 1948 of file ncorr.cpp.

RGDIC_with_seeds()

Disp2D ncorr::RGDIC_with_seeds	(	const Array2D< double > &	A_ref,
		const Array2D< double > &	A_cur,
		const ROI2D &	roi,
		const DIC_analysis_parallel_input &	input
	)

Definition at line 3337 of file ncorr.cpp.

RGDIC_without_thread()

Disp2D ncorr::RGDIC_without_thread	(	const Array2D< double > &	A_ref,
		const Array2D< double > &	A_cur,
		const ROI2D &	roi,
		ROI2D::difference_type	scalefactor,
		INTERP	interp_type,
		SUBREGION	subregion_type,
		ROI2D::difference_type	r,
		double	cutoff_corrcoef,
		bool	debug,
		const std::vector< SeedParams > &	seeds_by_region = {},
		bool	seeds_are_optimized = false
	)

Definition at line 2125 of file ncorr.cpp.

save() [1/18]

void ncorr::save	(	const Data2D &	data,
		std::ofstream &	os
	)

Definition at line 78 of file Data2D.cpp.

save() [2/18]

void ncorr::save	(	const DIC_analysis_input &	DIC_input,
		const std::string &	filename
	)

Definition at line 2545 of file ncorr.cpp.

save() [3/18]

void ncorr::save	(	const DIC_analysis_input &	DIC_input,
		std::ofstream &	os
	)

Definition at line 2505 of file ncorr.cpp.

save() [4/18]

void ncorr::save	(	const DIC_analysis_output &	DIC_output,
		const std::string &	filename
	)

Definition at line 2624 of file ncorr.cpp.

save() [5/18]

void ncorr::save	(	const DIC_analysis_output &	DIC_output,
		std::ofstream &	os
	)

Definition at line 2602 of file ncorr.cpp.

save() [6/18]

void ncorr::save	(	const DIC_analysis_step_data &	step_data,
		const std::string &	filename
	)

Definition at line 2708 of file ncorr.cpp.

save() [7/18]

void ncorr::save	(	const DIC_analysis_step_data &	step_data,
		std::ofstream &	os
	)

Definition at line 2683 of file ncorr.cpp.

save() [8/18]

void ncorr::save	(	const Disp2D &	disp,
		std::ofstream &	os
	)

Definition at line 50 of file Disp2D.cpp.

save() [9/18]

void ncorr::save	(	const Image2D &	img,
		std::ofstream &	os
	)

Definition at line 123 of file Image2D.cpp.

save() [10/18]

void ncorr::save	(	const ROI2D &	roi,
		std::ofstream &	os
	)

Definition at line 182 of file ROI2D.cpp.

save() [11/18]

void ncorr::save	(	const ROI2D::region &	reg,
		std::ofstream &	os
	)

Definition at line 1036 of file ROI2D.cpp.

save() [12/18]

void ncorr::save	(	const ROI2D::region_boundary &	boundary,
		std::ofstream &	os
	)

Definition at line 973 of file ROI2D.cpp.

save() [13/18]

void ncorr::save	(	const ROI2D::region_nlinfo &	nlinfo,
		std::ofstream &	os
	)

Definition at line 369 of file ROI2D.cpp.

save() [14/18]

void ncorr::save	(	const Strain2D &	strain,
		std::ofstream &	os
	)

Definition at line 50 of file Strain2D.cpp.

save() [15/18]

void ncorr::save	(	const strain_analysis_input &	strain_input,
		const std::string &	filename
	)

Definition at line 3722 of file ncorr.cpp.

save() [16/18]

void ncorr::save	(	const strain_analysis_input &	strain_input,
		std::ofstream &	os
	)

Definition at line 3708 of file ncorr.cpp.

save() [17/18]

void ncorr::save	(	const strain_analysis_output &	strain_output,
		const std::string &	filename
	)

Definition at line 3778 of file ncorr.cpp.

save() [18/18]

void ncorr::save	(	const strain_analysis_output &	strain_output,
		std::ofstream &	os
	)

Definition at line 3767 of file ncorr.cpp.

save_DIC_video()

void ncorr::save_DIC_video	(	const std::string &	filename,
		const DIC_analysis_input &	DIC_input,
		const DIC_analysis_output &	DIC_output,
		DISP	disp_type,
		double	alpha,
		double	fps,
		double	min_disp = std::numeric_limits<double>::quiet_NaN(),
		double	max_disp = std::numeric_limits<double>::quiet_NaN(),
		bool	enable_colorbar = true,
		bool	enable_axes = true,
		bool	enable_scalebar = true,
		double	num_units = -1.0,
		double	font_size = 1.0,
		ROI2D::difference_type	num_tick_marks = 11,
		int	colormap = cv::COLORMAP_JET,
		double	end_delay = 2.0,
		int	fourcc = cv::VideoWriter::fourcc('M','J','P','G')
	)

Definition at line 4299 of file ncorr.cpp.

save_ncorr_data_over_img()

void ncorr::save_ncorr_data_over_img	(	const std::string &	filename,
		const Image2D &	img,
		const Data2D &	data,
		double	alpha,
		double	min_data,
		double	max_data,
		bool	enable_colorbar,
		bool	enable_axes,
		bool	enable_scalebar,
		const std::string &	units,
		double	units_per_pixel,
		double	num_units,
		double	font_size,
		ROI2D::difference_type	num_tick_marks,
		int	colormap
	)

Definition at line 4156 of file ncorr.cpp.

save_ncorr_data_over_img_video()

void ncorr::save_ncorr_data_over_img_video	(	const std::string &	filename,
		const std::vector< Image2D > &	imgs,
		const std::vector< Data2D > &	data,
		double	alpha,
		double	fps,
		double	min_data,
		double	max_data,
		bool	enable_colorbar,
		bool	enable_axes,
		bool	enable_scalebar,
		const std::string &	units,
		double	units_per_pixel,
		double	num_units,
		double	font_size,
		ROI2D::difference_type	num_tick_marks,
		int	colormap,
		double	end_delay,
		int	fourcc
	)

Definition at line 4189 of file ncorr.cpp.

save_strain_video()

void ncorr::save_strain_video	(	const std::string &	filename,
		const strain_analysis_input &	strain_input,
		const strain_analysis_output &	strain_output,
		STRAIN	strain_type,
		double	alpha,
		double	fps,
		double	min_strain = std::numeric_limits<double>::quiet_NaN(),
		double	max_strain = std::numeric_limits<double>::quiet_NaN(),
		bool	enable_colorbar = true,
		bool	enable_axes = true,
		bool	enable_scalebar = true,
		double	num_units = -1.0,
		double	font_size = 1.0,
		ROI2D::difference_type	num_tick_marks = 11,
		int	colormap = cv::COLORMAP_JET,
		double	end_delay = 2.0,
		int	fourcc = cv::VideoWriter::fourcc('M','J','P','G')
	)

Definition at line 4381 of file ncorr.cpp.

set_units()

DIC_analysis_output ncorr::set_units	(	const DIC_analysis_output &	DIC_output,
		const std::string &	units,
		double	units_per_pixel
	)

Definition at line 3451 of file ncorr.cpp.

strain_analysis()

strain_analysis_output ncorr::strain_analysis

(

const strain_analysis_input &

strain_input

)

Definition at line 3792 of file ncorr.cpp.

update() [1/2]

Data2D ncorr::update	(	const Data2D &	data,
		const Disp2D &	disp,
		INTERP	interp_type,
		ROI_UPDATE_MODE	mode = ROI_UPDATE_MODE::SKIP_ALL
	)

Definition at line 1040 of file ncorr.cpp.

update() [2/2]

ROI2D ncorr::update	(	const ROI2D &	roi,
		const Disp2D &	disp,
		INTERP	interp_type,
		ROI_UPDATE_MODE	mode = ROI_UPDATE_MODE::SKIP_ALL
	)

Definition at line 681 of file ncorr.cpp.

Variable Documentation

all

const class details::all_range ncorr::all

Definition at line 70 of file Array2D.h.

last

const class details::last_index ncorr::last

Definition at line 69 of file Array2D.h.