- EBSD.refine_projection_center(xmap: CrystalMap, detector: EBSDDetector, master_pattern: EBSDMasterPattern, energy: Union[int, float], mask: Optional[np.ndarray] = None, method: Optional[str] = 'minimize', method_kwargs: Optional[dict] = None, trust_region: Optional[list] = None, compute: bool = True, rechunk: bool = True, chunk_kwargs: Optional[dict] = None) Union[Tuple[np.ndarray, EBSDDetector], da.Array] #
Refine projection centers by searching the parameter space using fixed orientations.
Refinement attempts to maximize the similarity between patterns in this signal and simulated patterns projected from a master pattern. The only supported similarity metric is the normalized cross-correlation (NCC). The sample-detector geometry, represented by the three projection center (PC) parameters (PCx, PCy, PCz), is changed during projection, while the orientations are fixed.
- A subset of the optimization methods in SciPy are available:
Single phase crystal map with at least one orientation per point. The orientations are assumed to be relative to the EDAX TSL sample reference frame RD-TD-ND.
Detector describing the detector-sample geometry with either one PC to be used for all map points or one for each point.
Master pattern in the square Lambert projection of the same phase as the one in the crystal map.
Accelerating voltage of the electron beam in kV specifying which master pattern energy to use during projection of simulated patterns.
Boolean mask of signal shape to be applied to the simulated pattern before comparison. Pixels set to
Trueare masked away. If not given, all pixels are matched.
Name of the
scipy.optimizeoptimization method, among
"shgo". Default is
"minimize", which by default performs local optimization with the Nelder-Mead method unless another
"minimize"method is passed to
Keyword arguments passed to the
method. For example, to perform refinement with the modified Powell algorithm, pass
List of +/- percentage deviations as bound constraints on the PC parameters in the Bruker convention. The parameter range is [0, 1]. If not given and
methodrequires bounds, they are set to
[0.05, 0.05, 0.05]. If given,
methodis assumed to support bounds and they are passed to
Whether to refine now (
True) or later (
False). Default is
compute()for more details.
True(default), rechunk the dask array with patterns used in refinement (not the signal data inplace) if it is returned from
get_dask_array()in a single chunk. This ensures small data sets are rechunked so as to utilize multiple CPUs.
New similarity metrics and a new EBSD detector instance with the refined PCs if
compute=False, a dask array of navigation shape + (4,) is returned, to be computed later. See
compute_refine_projection_center_results(). Each navigation point has the optimized score and the three PC parameters in the Bruker convention in element 0, 1, 2, and 3, respectively.