returns the Ids of neighboring grains
Syntax
% pairs of neighboring grains in grains1
pairs = neighbors(grains1)% pairs of neighboring grains in grains1 and grains2
pairs = neighbors(grains1,grains2)% all neighboring grains of grains1
pairs = neighbors(grains1,'full')% adjacency matrix of grains
A = grains.neighbors('matrix')Input
| grains1, grains2 | grain2d |
Output
| pairs | index list of size N × 2 |
| A | adjacency matrix |
Options
| full | consider all neighboring grains, not only those contained in |
| matrix | provide the result as adjacency matrix |
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/grain2d.neighbors.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.