getmatchedpole#

EBSDIndexer.getmatchedpole(banddata, float_out=False)[source]#

Return the pole from the library that was matched to the detected band.

Parameters:
banddatanumpy.ndarray

Output structured band data array from index_pats() or index_pats_distributed().

float_outbool, optional

Default (False) is to return an array of ints with Miller indices. If set to True, then floats, with unit length, will be returned in the sample Cartesian reference frame. (Length is only valid for cubic systems).

Returns:
numpy.ndarray

The default is an array [npoints, nbands, 3] that contains the Miller indices (as ints) of the matching pole (note that hexagonal will also return only three-index notation). If the float_out is set to True, then the output will be floating point vectors of length one, within the sample Cartesian reference frame.