A method of mapImage.

the pixel of the image covering each position; MATLAB’s mapImage.pos2ind

Syntax

i, j, inside = mg.pos2ind(pos)

Row and column, and whether on the grid.

ind = mg.pos2ind(pos, linear=True)

The index into the flattened grid.

Description

On a regular grid this is a projection and a rounding, not a search: the two steps are perpendicular, so the row and the column separate. The row and column are counted from zero and not clipped to the grid; the linear index is -1 outside it, where MATLAB’s is NaN.

Input

mg mapImage
pos vector3d, or an (…, 2) or (…, 3) array of positions

Keywords

keyword default description
linear False return the linear index alone

Output

i, j int arrays, row and column of the pixel
inside bool array, whether it lies on the grid
ind int array, the index into the flattened grid, row by row, -1 outside

See also

mapImage.interp, mapImage.subGrid

MATLAB’s mapImage.pos2ind

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/mapImage.pos2ind_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.