how long a scale bar of a map should be, in the coordinates the map is drawn in, and how it reads: a round number near a tenth of the width, in the unit that keeps it readable

Syntax

length, label = scaleBar(ebsd)

(5000.0, ‘5 mm’) for a map 36.6 mm wide.

length, label = scaleBar(36550.0, 'um', fraction=0.2)

From a width in a unit.

length, label = scaleBar(0.5, 'mm')

(0.05, ‘50 µm’).

Description

The fraction of the width is brought to the unit among nm, µm, mm and m that keeps its number between one and a thousand and rounded to the nearest of 1, 2, 5, 10, 15, 20, 25, 50, 75, 100, 125, 150, 200, 500, 750. A map, grains or boundary give their width on the screen and their scanUnit.

Input

x the width of the map, or the map, grains or boundary

Keywords

keyword default description
unit 'um' the unit of a width given as a number
fraction 0.1 the length aimed at, as a fraction of the width

Output

length the length of the bar in the units of the map
label its text, as ‘5 mm’

See also

mapExtent, plotEBSD

MATLAB’s scaleBar

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