A method of S1FunHarmonic.

plot of a function on the circle, its values as the radius of a polar line; MATLAB’s S1Fun/plot

Syntax

h = plot(sF1)

A polar line over the angle.

h = plot(sF1, '--', color='r')

A line style and a colour.

h = plot(sF1, polar=False)

The values over the angle in [0, 2 pi].

h = plot(sF1, lineWidth=2, displayName='f')

A wider line named in the legend.

Description

The function is evaluated at 361 angles from 0 to 2 pi; a complex function shows its real part. A positional string is matplotlib’s format, MATLAB’s line style. An axes the user made with plt.subplot takes the line, as MATLAB’s subplot does, and a held figure the next line; further keywords go to matplotlib’s plot.

Input

sF1 S1FunHarmonic, a function on the circle

Keywords

keyword default description
lineWidth 1.0 the width of the line in points
displayName None the name of the line in a legend
color None the colour of the line, a name or an RGB triple
polar True draw in polar coordinates, the radius the value; False draws the values over the angle in Cartesian axes, MATLAB’s ‘notPolar’
how2plot None the plotting convention that places the angle 0 and the sense of rotation

Output

h matplotlib Line2D, the line drawn

See also

S1FunHarmonic, plotSection, S1FunHarmonics

MATLAB’s S1Fun.plot

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/S1Fun.plot_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.