represent a periodic circular function by a vectorised callable.

Syntax

f = S1FunHandle(lambda x: np.cos(2*x))
f = S1FunHandle(fun, bandwidth=32, real=False)

Description

The callable receives numeric angles in radians. Evaluation calls it directly; the wrapper does not make a nonperiodic formula periodic. Choose a function of period 2*pi for circular data. Operations needing coefficients first approximate the callable as an S1FunHarmonic at the stated bandwidth.

Input

fun callable accepting an angle array and returning matching values

Keywords

keyword	default	description
`bandwidth`		largest Fourier mode of harmonic approximations; maxS1Bandwidth when omitted
`real`		return real values, dropping any imaginary part

Output

`f`	S1FunHandle, evaluated with f(angles)

Properties

`fun`	wrapped callable
`bandwidth`	resolution used by harmonic operations
`isReal`	whether evaluation returns only real values

Members

eval	call the supplied function at numeric angles in radians
max	the global, local and pointwise maxima of a function on the circle given by a callable
mean	the mean over the circle, through the harmonic form
min	the global, local and pointwise minima of a function on the circle given by a callable
S1FunHandle	represent a periodic circular function by a vectorised callable

Used on

S1FunHarmonics

MATLAB’s S1FunHandle_index

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/S1FunHandle_index_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.

The class S1FunHandle