A method of trueEbsd.

the registration settings of every map of the job, or of one; MATLAB’s setOptions of trueEbsd

Syntax

job.setOptions(roiSize=5, numROI=24)

5 um tiles on every map.

job.setOptions(1, registerOn='raw')

Map 1 alone matched on its values.

job.setOptions(0, roiSize=[4, 8])

A tile width per fit stage of map 0.

job.setOptions([0, 1], highContrast='auto')

Maps 0 and 1, measured when needed.

Description

The settings say how the job registers, not what an image is, so they live on the job. The lengths are in the scan unit, not in pixels, so they may be set before or after pixelSizeMatch. The maps are counted from 0, where MATLAB counts them from 1.

A setting left at ‘auto’ is measured from a coarse correlation when calcDistortion first needs it, and the choice is printed; a setting given here is used as it is. The settings are keyword arguments, their names in any case:

roiSize: the width of a correlation tile, a length; one, or one per fit stage; 0 for a map correlated against nothing, as the reference.
numROI: the number of tiles across the image, a whole number, the number down following from the aspect ratio.
registerOn: ‘edge’ to correlate the edge transform, ‘raw’ the values as they are, for a pair already sharing its contrast.
edgeWidth: the neighbour distance of the edge transform, a length.
highContrast: whether the image can be registered on directly, True, False or ‘auto’.
pixelTime: the dwell time per pixel, a number not below 0, carried and not used.

Input

job trueEbsd

Keywords

keyword	default	description
`n`	`None`	the map, or a list of maps, the settings apply to; by default every map

Output

the job is changed in place

Used on

EBSDTrueEbsd

MATLAB’s trueEbsd.setOptions

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/trueEbsd.setOptions_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.

trueEbsd.setOptions