the offsets of the lattice reachable in that many steps over its stencil, or within a physical distance over as many steps as it takes to reach it; the neighbourhood KAM and the denoising filters average over

Syntax

offs = neighbourBall(ebsd.lattice, 1)

The nearest neighbours, the stencil.

offs = neighbourBall(ebsd.lattice, 2)

The neighbours up to the second order.

offs = neighbourBall(ebsd.lattice, radius=0.7) # the neighbours within 0.7 scan units

Description

The offsets are integer steps (i, j) along the two lattice directions, the pixel itself left out, sorted. With a radius the walk goes as many steps as the shortest step of the stencil needs to reach it, and keeps the offsets whose physical length is at most radius.

Input

l lattice, ebsd.lattice

Keywords

keyword default description
order None the number of steps over the stencil
radius None the largest physical distance, in the scan unit, which replaces order

Output

offs (n, 2) int array of the offsets

See also

KAM, lattice

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