A method of sphericalRegion.

whether directions lie in the region, up to a small tolerance at the boundary

Syntax

inside = sR.checkInside(v)

A boolean per direction.

inside = sR.checkInside(v, tol=1e-2)

A wider margin at the boundary.

Description

A direction is inside when <v, N> >= alpha - tol for every boundary circle, the length of v not mattering. For an antipodal region or antipodal directions, -v inside counts too.

Input

sR sphericalRegion
v vector3d, or an (…, 3) array

Keywords

keyword default description
tol 0.0001 the margin in the cosines

Output

inside boolean array in the shape of v

See also

projectIntoRegion, sphericalRegion.volume

MATLAB’s sphericalRegion.checkInside

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/sphericalRegion.checkInside_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.