LabKit MATLAB Workbench

reference

API ReferenceDIC Postprocess

dic_postprocess.analysisRun.summarizeStrain

Summarize finite EXX and EYY values inside a mask.

Syntax

T = dic_postprocess.analysisRun.summarizeStrain(strain, mask)

Inputs

strain
Scalar struct with numeric exx and eyy arrays of the same size.
mask
Logical array matching exx and eyy. true entries select samples for both components.

Outputs

T
Five-row table. Metric contains "Mean", "Std", "Median", "Min", and "Max"; EXX and EYY contain the corresponding statistics.

Description

Nonfinite values are removed independently from each selected component. Std uses MATLAB's default sample standard deviation. When a component has no finite selected values, all five values for that component are NaN.

Failure Behavior

An empty finite selection returns NaN statistics as documented. Missing exx or eyy fields, incompatible mask geometry, or values unsupported by MATLAB numeric statistics propagate the originating field/indexing error.

Example

strain = struct("exx", [1 2; NaN 4], "eyy", [2 4; 6 Inf]);
T = dic_postprocess.analysisRun.summarizeStrain( ...
strain, true(2));
assert(T.EXX(T.Metric == "Mean") == 7/3)
assert(T.EYY(T.Metric == "Max") == 6)

Source

This page is generated from the MATLAB help text in apps/dic/dic_postprocess/+dic_postprocess/+analysisRun/summarizeStrain.m.