plottingConvention edit page

class describing the alignment of a reference frame on the screen

plottingConvention is a value class: assigning one always copies, so a convention can never be changed behind the back of the data holding it. What couples data to the session default is the shared referenceFrame - see specimenFrame.default - not a shared convention handle.

Syntax

% specify a custom plotting convention
pC = plottingConvention(outOfScreen,east)
plot(ebsd,pC)

% specify a custom plotting convention by a string - each axis is
% followed or preceded by the direction it points to on screen
pC = plottingConvention('y↑→x')  % y points up, x points to the right
pC = plottingConvention('x←↑y')  % x points to the left, y points up
pC = plottingConvention('z⊙→x')  % z points out of screen, x right
pC = plottingConvention('y^->x') % same as 'y↑→x', ASCII arrows
pC = plottingConvention('z(.)->x') % same as 'z⊙→x', (x) is ⊗

% changing the default plotting convention - modify a copy and make
% it the default (this is what plotx2east and friends do)
pC = plottingConvention.default; pC.east = yvector; pC.makeDefault

% a convention belongs to a reference frame, never to a data object, so
% how2plot is read only everywhere but <referenceFrame.referenceFrame.html referenceFrame> - align data by
% moving it into a frame that carries the convention
ebsd.frame = specimenFrame.rolling

Input

`outOfScreen`	`vector3d`
`east`	`vector3d`
`str`	`char, e.g. 'y↑→x', see the syntax above`

Output

`pC`	`plottingConvention`

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