a function on the sphere as a surface in space, the sphere pushed out to |f| and coloured by f; MATLAB’s S2Fun/surf

Syntax

surf(sF)

The function as a surface.

surf(sF, resolution=2*degree, scaling=False)

A finer mesh, the values as they are.

Description

The radius of the surface in a direction is the absolute value of the function there, the colour its value, the real part of a complex function. A single real function is first scaled to (f - mean) / (max - min) + 1, as MATLAB does, which shows its shape as an ovoid around the unit sphere; scaling=False draws the values as they are. A list of functions is drawn one panel each, in a new figure.

Input

`sF`	S2Fun, or a list of them

Keywords

keyword	default	description
`layout`	`None`	(rows, columns) of the panels of a list of functions
`figSize`	`None`	the size of a new figure, a name such as ‘large’ or (width, height) in inches
`scaling`	`True`	scale a single real function to an ovoid around the unit sphere
`colormap`	`'parula'`	the colour map of the values
`resolution`	`5*degree`	the spacing of the mesh on the sphere, an angle
`edgeColor`	`(0.1, 0.1, 0.1)`	the colour of the edges of the mesh, ‘none’ for none

Output

`h`	the Poly3DCollection of the surface, a list of them for a list of functions

Used on

S2FunHarmonicRepresentation, S2FunPlotting, S2FunQuadrature, S2Kernels, SphericalHarmonics, PiezoElectricity

MATLAB’s vector3d.surf

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/vector3d.surf_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.

vector3d.surf