dicresults.py

class Results(ss_x, ss_y, u, v, mag=None, converged=None, cost=None, ftol=None, xtol=None, niter=None, shape_params=None, filenames=None)

Bases: object

Data container for Digital Image Correlation (DIC) analysis results.

This dataclass stores the displacements, convergence info, and correlation data associated with a DIC computation.

ss_x

The x-coordinates of the subset centers (in pixels). shape=(img_num,y,x)

ss_y

The y-coordinates of the subset centers (in pixels). shape=(img_num,y,x)

u

Horizontal displacements at each subset location. shape=(img_num,y,x)

v

Vertical displacements at each subset location. shape=(img_num,y,x)

mag

Displacement magnitude at each subset location, typically computed as sqrt(u^2 + v^2). shape=(img_num,y,x)

converged

boolean value for whether the subset has converged or not. shape=(img_num,y,x)

__init__(ss_x, ss_y, u, v, mag=None, converged=None, cost=None, ftol=None, xtol=None, niter=None, shape_params=None, filenames=None)

cost

Final cost or residual value from the correlation optimization (e.g., ZNSSD). shape=(img_num,y,x)

ftol

Final ftol value from the optimization routine, indicating function tolerance. shape=(img_num,y,x)

xtol

Final xtol value from the optimization routine, indicating solution tolerance. shape=(img_num,y,x)

niter

Number of iterations taken to converge for each subset point. shape=(img_num,y,x)

shape_params

Optional shape parameters if output during DIC calculation (e.g., affine, rigid). shape=(img_num,y,x)

filenames

name of DIC result files that have been found