A method of grain3d.

the ids of neighbouring grains; MATLAB’s neighbors of grain3d

Syntax

pairs = grains.neighbors()

The pairs within the set.

pairs = grains.neighbors(full=True)

Every pair of the boundary.

Description

Two grains are neighbours when they share a boundary face. A pair is sorted, the smaller id first, and listed once; the outside of the volume is no neighbour. MATLAB’s flag ‘matrix’, the adjacency matrix, has no counterpart here.

Input

grains grain3d

Keywords

keyword default description
full False every pair of grains sharing a face of the boundary, also those with a grain outside the set

Output

pairs (n, 2) array of grain ids

See also

grain3d.numNeighbors, grain2d.neighbors

MATLAB’s grain3d.neighbors

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/grain3d.neighbors_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.