A method of S2VectorFieldHarmonic.
whether two fields agree in their coefficients up to the relative tolerance rtol
Syntax
tf = isclose(vF1, vF2)
Equal up to a relative 1e-8.
tf = isclose(vF1, vF2, rtol=1e-2)
Up to a relative 1e-2.
Description
The fields are compared at the larger of their bandwidths: the norm of the difference of the coefficients of the three components must not exceed rtol times the norm of those of w; a field of another kind is expanded first.
Input
vF1 |
S2VectorFieldHarmonic |
w |
S2VectorField, the field to compare with |
Keywords
| keyword | default | description |
|---|---|---|
rtol |
1e-08 |
the tolerance relative to the norm of w |
Output
tf |
bool |
See also
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/S2VectorFieldHarmonic.isclose_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.