the function of mean zero whose gradient the field is; raises unless the field is a gradient, or conservative=True says it is; with x its values at the orientations x

Syntax

F = SO3VF.antiderivative()

The function, an SO3FunHarmonic.

f = SO3VF.antiderivative(ori)

Its values at orientations.

F = SO3VF.antiderivative(conservative=True)

Without checking the field is a gradient.

F = SO3VF.antiderivative(tol=1e-3)

Checked with another tolerance.

Description

The keywords conservative and tol go to antiderivative: the function is the inverse Laplacian of the divergence, and unless conservative=True the gradient of the result must give the field back within tol (1e-4) relative to its norm, else a ValueError is raised.

Input

`SO3VF`	SO3VectorField, converted to its harmonic form
`x`	orientation, where to evaluate the antiderivative

Output

`F`	SO3FunHarmonic
`f`	array, the values at x

Signature

SO3VectorFieldHarmonic.antiderivative(self, x=None, **kwargs)

Used on

SO3FunVectorField

MATLAB’s SO3VectorField.antiderivative

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/SO3VectorField.antiderivative_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.

SO3VectorField.antiderivative