A method of PoleFigure.
the mean deviation, one number per pole figure, from a recalculation by an ODF or from other pole figures on the same directions; MATLAB’s calcError
Syntax
e = calcError(pf, odf)
The damped relative error.
e = calcError(pf, pf2)
Against other pole figures on the same directions.
e = calcError(pf, odf, 'RP', epsilon=0.5)
The RP error above 0.5.
e = calcError(odf, pf, 'RP')
The ODF first, as MATLAB’s.
e = calcError(pf, odf, 'l2')
The relative mean square error.
Description
The deviations are those of calcErrorPF, averaged over each pole figure: ‘relative’, the default, the relative error damped by epsilon (0.5), which MATLAB computes when no measure is named (its documentation calls the default RP); ‘RP’ the mean of |I - Ic| / Ic over the directions where Ic exceeds epsilon (1), MATLAB’s ‘RP’, epsilon; ‘l1’ and ‘l2’ the mean absolute and squared differences divided by the mean absolute and squared intensities. The names are taken in any case.
Input
pf |
PoleFigure, the measurement |
other |
SO3Fun, the ODF of the recalculation, or PoleFigure on the same directions |
Keywords
| keyword | default | description |
|---|---|---|
mode |
'relative' |
‘relative’, ‘RP’, ‘l1’ or ‘l2’ |
epsilon |
None |
the damping of ‘relative’ or the threshold of ‘RP’, both times the normalisation |
Output
e |
ndarray, one number per pole figure; NaN where ‘RP’ keeps no direction |
See also
PoleFigure.calcErrorPF, calcNormalization, SO3Fun.calcError
MATLAB’s PoleFigure.calcError
source
Citing this page.
This page is part of the documentation of
MTEX, a free and open
source MATLAB toolbox for analyzing and modeling crystallographic textures.
It was written by The MTEX Developers and is published at
https://mtex-toolbox.github.io/PoleFigure.calcError_py.html.
If you use MTEX, or reuse text or figures from this page, in your research,
please cite
F. Bachmann, R. Hielscher, H. Schaeben: Texture Analysis with MTEX - Free and Open Source Software Toolbox, Solid State Phenomena 160 (2010), 63-68. 10.4028/www.scientific.net/SSP.160.63
BibTeX
@article{bachmann2010mtex,
author = {F. Bachmann and R. Hielscher and H. Schaeben},
title = {Texture Analysis with MTEX - Free and Open Source Software Toolbox},
journal = {Solid State Phenomena},
volume = {160},
pages = {63-68},
year = {2010},
doi = {10.4028/www.scientific.net/SSP.160.63},
url = {https://doi.org/10.4028/www.scientific.net/SSP.160.63}
}
Other papers describing specific MTEX methods are listed under Publications — please cite the one that best fits your application. The MTEX source code is licensed under the GNU General Public License v2.0; the text and figures of this documentation are licensed under CC BY 4.0, which permits reuse — including by automated systems — provided The MTEX Developers and this page are credited.