layoutHold edit page

suspend the layout of a figure while it is being built

Description

Every plot command ends by laying the figure out, so a command that builds one a plot at a time lays it out once per plot and throws all but the last away. plotPDF of three pole figures laid out four times and measured the axes seventeen times to produce one figure; holding the layout while it builds made that five measurements and took 46% off the wall time.

Releasing lays the figure out, so it is safe to take the hold before any early return: whichever way the command leaves, the figure ends up laid out exactly once.

Syntax

release = layoutHold(mtexFig);
...                              % many plot commands
clear release                    % lays the figure out, once

Input

mtexFig mtexFigure, or the plain struct newMtexFigure falls back to

Output

release onCleanup; the layout resumes when it is cleared or goes out of scope, so an error on the way cannot leave a figure suspended

See also

mtexLayout.hold mtexFigure.drawNow

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