the reindexing that lays an array out in this layout
Description
A layout says which specimen directions the row and the column index of an array advance along, so two of them differ by a transpose and two flips - a signed permutation, the only thing reindexing can express. The inverse is the same call with the two layouts swapped.
The source is given as two directions rather than a layout because a grid may be sheared, and a gridLayout requires its axes perpendicular.
doTranspose is reported because a transpose also exchanges whatever is indexed BY dimension - a pixel step, a size - which the index cannot carry.
Syntax
lin = layoutIndex(gL,[d1 d2],size(A))
lin = layoutIndex(gL,src,size(A))
lin = layoutIndex(gL,src,size(A),'nearest')
[lin,doTranspose] = layoutIndex(gL,[d1 d2],size(A))Input
| gL | gridLayout the array is to be laid out in, i.e. the TARGET |
| dims | 1x2 vector3d, the directions dimensions 1 and 2 advance along |
| src | gridLayout, the same stated as a layout |
| sz | size(A), dimensions beyond the first two are left alone |
Output
| lin | linear indices, A(lin) is A laid out in gL |
| doTranspose | whether the first two dimensions were exchanged |
Flags
| nearest | snap to the closest layout instead of erroring |
See also
gridLayout referenceFrame.transformationMatrix EBSDsquare.transformReferenceFrame
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/gridLayout.layoutIndex.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.