addphase#

pyebsdindex.tripletvote.addphase(libtype=None, phasename=None, spacegroup=None, latticeparameter=None, polefamilies=None, nband_earlyexit=10)[source]#

Return a band indexer for a phase.

Parameters:
libtypestr, optional

Shorthand definition of a phase. Options are FCC, BCC, or HCP.

phasenamestr, optional

Phase name.

spacegroupint, optional

Space group of the phase.

latticeparameternp.ndarray, tuple, or list, optional

Lattice parameters (a, b, c, alpha, beta, gamma).

polefamiliesnp.ndarray, tuple, or list, optional

Reflector families to use in indexing.

nband_earlyexitint, optional

If this phase is first in a list of phases used in indexing, and if this many bands are matched, the remaining phases in the list will not be checked. Default is 10, unless libtype is passed, in which case it is 8.

Returns:
BandIndexer

Band indexer for this phase.