EBSDIndexer#

class pyebsdindex.ebsd_index.EBSDIndexer(filename=None, phaselist=['FCC'], vendor=None, PC=None, sampleTilt=70.0, camElev=5.3, bandDetectPlan=None, nRho=90, nTheta=180, patternmask=None, patternmaskindex=None, tSigma=1.0, rSigma=1.2, rhoMaskFrac=0.15, nBands=9, patDim=None, nband_earlyexit=None, **kwargs)[source]#

Bases: object

Setup of Radon indexing of EBSD patterns.

Parameters:
filenamestr, optional

Name of file with EBSD patterns.

phaselistlist of str, optional

Options are "FCC" and "BCC". Default is ["FCC"].

vendorstr, optional

Which vendor convention to use for the pattern center (PC) and the returned orientations. The available options are "EDAX" (default), "BRUKER", "OXFORD", "EMSOFT", "KIKUCHIPY".

PClist, optional

Pattern center (PCx, PCy, PCz) in the vendor convention. For EDAX TSL, this is (x*, y*, z*), defined in fractions of pattern width with respect to the lower left corner of the detector. If not passed, this is set to (x*, y*, z*) = (0.471659, 0.675044, 0.630139). If vendor="EMSOFT", the PC must be four numbers, the final number being the pixel size.

sampleTiltfloat, optional

Sample tilt towards the detector in degrees. Default is 70 degrees. Unused if ebsd_indexer_obj is passed.

camElevfloat, optional

Camera elevation in degrees. Default is 5.3 degrees. Unused if ebsd_indexer_obj is passed.

bandDetectPlanpyebsdindex.band_detect.BandDetect, optional

Collection of parameters using in band detection. Unused if ebsd_indexer_obj is passed.

nRhoint, optional

Default is 90 degrees. Unused if ebsd_indexer_obj is passed.

nThetaint, optional

Default is 180 degrees. Unused if ebsd_indexer_obj is passed.

tSigmafloat, optional

Unused if ebsd_indexer_obj is passed.

rSigmafloat, optional

Unused if ebsd_indexer_obj is passed.

rhoMaskFracfloat, optional

Default is 0.1. Unused if ebsd_indexer_obj is passed.

nBandsint, optional

Number of detected bands to use in triplet voting. Default is 9. Unused if ebsd_indexer_obj is passed.

patDimint, optional

Number of dimensions of pattern array.

**kwargs

Keyword arguments passed on to BandDetect.

Methods

EBSDIndexer.addphaselist([phaselist])

EBSDIndexer.getmatchedpole(ebsddata, banddata)

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

EBSDIndexer.index_pats([patsin, patstart, ...])

Index EBSD patterns.

EBSDIndexer.saveindexer([filename])

EBSDIndexer.update_file([filename, patDim])

Update file with patterns to index.