trueEbsd.setOptions edit page

set the registration settings, for every hop or for one

These describe how the job should register rather than what an image is, which is why they live on the job and not on mapImage.

Description

Lengths, not pixels. A pixel count means a different thing before and after pixelSizeMatch, which is what forces a settings block to sit wedged between that call and calcDistortion; a length does not, so this may be called at any point.

Anything left at 'auto' is measured from a cheap coarse correlation when calcDistortion first needs it, and what it chose is printed. Anything set here is used untouched and nothing is measured for it.

Syntax

job.setOptions('roiSize',5,'numROI',24)   % 5 um tiles on every hop
job.setOptions(3,'registerOn','raw')      % hop 3 only
job.setOptions(1,'registerOn','edge')     % match hop 1 on edges
job.setOptions(1,'roiSize',[4 8])         % per fit stage of hop 1

Input

job trueEbsd
n which map the settings apply to, all of them if omitted

Options

roiSize correlation tile width, a LENGTH in the sequence's scanUnit. One value, or one per fit stage. Zero means this map correlates against nothing, as the reference does
numROI tiles across the image; the number down follows from the aspect ratio
registerOn 'edge' to correlate the edge transform, 'raw' for the values as they are. Not measured: 'edge' is the method's premise and raw is the exception, for a pair that already shares contrast - which the person who collected them knows and no cheap proxy reliably does. See PARAMETERS.md
edgeWidth neighbour distance of the edge transform, a LENGTH
highContrast whether this image can be registered on directly. true, false, or 'auto' to measure it
pixelTime dwell time per pixel, carried but not used

See also

trueEbsd trueEbsd.calcDistortion mapImage.edgeMap

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