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, 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:
- filename
str
,optional
Name of file with EBSD patterns.
- phaselist
list
of
str
,optional
Options are
"FCC"
and"BCC"
. Default is["FCC"]
.- vendor
str
,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"
.- PC
list
,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). Ifvendor="EMSOFT"
, the PC must be four numbers, the final number being the pixel size.- sampleTilt
float
,optional
Sample tilt towards the detector in degrees. Default is 70 degrees. Unused if
ebsd_indexer_obj
is passed.- camElev
float
,optional
Camera elevation in degrees. Default is 5.3 degrees. Unused if
ebsd_indexer_obj
is passed.- bandDetectPlan
pyebsdindex.band_detect.BandDetect
,optional
Collection of parameters using in band detection. Unused if
ebsd_indexer_obj
is passed.- nRho
int
,optional
Default is 90 degrees. Unused if
ebsd_indexer_obj
is passed.- nTheta
int
,optional
Default is 180 degrees. Unused if
ebsd_indexer_obj
is passed.- tSigma
float
,optional
Unused if
ebsd_indexer_obj
is passed.- rSigma
float
,optional
Unused if
ebsd_indexer_obj
is passed.- rhoMaskFrac
float
,optional
Default is 0.1. Unused if
ebsd_indexer_obj
is passed.- nBands
int
,optional
Number of detected bands to use in triplet voting. Default is 9. Unused if
ebsd_indexer_obj
is passed.- patDim
int
,optional
Number of dimensions of pattern array.
- **kwargs
Keyword arguments passed on to
BandDetect
.
- filename
Methods
EBSDIndexer.getmatchedpole
(banddata[, float_out])Return the pole from the library that was matched to the detected band.
EBSDIndexer.index_pats
([patsin, patstart, ...])Index EBSD patterns.
EBSDIndexer.update_file
([filename, patDim])Update file with patterns to index.