annotateFrame edit page

annotate a spherical plot with the axes of its reference frame

Writes the axes names of the reference frame the data lives in into a spherical plot - RD / TD / ND for a rolled sheet, a, b, c for a plain function living in a crystal frame. The frame reaches this function as an argument of its own, as the frame of a symmetry in the argument list, or as the dataFrame option that sphericalPlot carries over from the data.

A frame that names its axes the way the session frame does says nothing the session does not, and is annotated through the pfAnnotations preference instead - which is what lets the user replace the labels or switch them off for the whole session.

A crystal symmetry in the argument list marks the plot as living in crystal coordinates, where X / Y / Z would be meaningless - there sphericalPlot writes the Miller indices of the sector vertices instead. A crystal frame is not a crystal symmetry: a plain function living in one gets the a, b, c of that frame.

On a three dimensional plot the labels are placed in space and each of them gets an arrow pointing along the direction it names, see vector3d/text.

Syntax

h = annotateFrame(ax)
h = annotateFrame(ax,cs)

A crystal symmetry suppresses the labels.

h = annotateFrame(ax,ss)

A symmetry names the frame of the data.

h = annotateFrame(ax,'dataFrame',specimenFrame.rolling)

Input

ax axes handle
cs crystalSymmetry
ss specimenSymmetry

Options

dataFrame referenceFrame the plotted data is expressed in
noLabel do not annotate at all

Output

h handles of the graphics objects drawn

See also

sphericalPlot vector3d.text vector3d.arrow3d

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