Options edit page

Many functions provided by MTEX can be customized by options. An option is passed to a method as a string parameter followed by a value. For example, almost all plotting methods support the option resolution followed by a double value specifying the resolution in radians. The code below demonstrates the effect of changing this parameter.

odf = SantaFe
plotPDF(odf,Miller(1,0,0,odf.CS),'resolution',10*degree,'contour','linewidth',2);
odf = SO3FunRBF (m3̅m → y↑→x (222))
 
  uniform component
  weight: 0.73
 
  unimodal component
  kernel: van Mises Fisher, halfwidth 10°
  center: 1 orientations
 
  Bunge Euler angles in degree
     phi1     Phi    phi2  weight
  296.565 48.1897 26.5651    0.27
plotPDF(odf,Miller(1,0,0,odf.CS),'resolution',2.5*degree,'contour','linewidth',2);

Options that are not followed by a value are called flags. In the above example, contour is a flag that tells the plotting routine to plot contour lines. Options and flags to a function are always optional and can be passed in any order. If conflicting options or flags are passed, i.e., the resolution is specified twice, the later option in the list is considered to be the right one.

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