getmatchedpole

EBSDIndexer.getmatchedpole(ebsddata, banddata, phasenumber=-1, float_out=False)

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

Parameters:

ebsddata: numpy.ndarray

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

banddatanumpy.ndarray

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

phasenumber: int, optional

Default( -1). Set this to which phase the poles should be returned for. The default is to return the match to the best-fit phase.

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.

If the pole was unindexed, then for that entry, this will return [0,0,0]. Note - this might be a single band that was unindexed. If all bands return unindexed, this might be because the pattern did not have enough bands to index, or because another phase forced an early exit (solution was good enough that no other phases were tested). Setting EBSDIndexer.nband_earlyexit to a value that is greater than the number of bands will avoid this.