HREBSDResult#

class de_ebsd.index.crosscorr.HREBSDResult(beta, strain, rotation, rotation_vector, shifts, centers, peak, residual, n_passes)[source]#

Bases: object

What hrebsd() measured, per test pattern, in the detector frame.

Use to_sample() for the sample frame.

Methods

to_sample

(beta, strain, rotation) rotated into the sample frame.

Attributes

`beta`	`(N, 3, 3)` displacement gradient, trace-free: the hydrostatic part is invisible to the projection (see the module docstring).
`strain`	`(N, 3, 3)` deviatoric strain, `sym(beta)`.
`rotation`	`(N, 3, 3)` lattice rotation, `skew(beta)`.
`rotation_vector`	`(N, 3)` axial vector of `rotation`, in radians.
`shifts`	`(N, M, 2)` region shifts `(drow, dcol)` in pixels, from the final pass.
`centers`	`(M, 2)` region-of-interest centers as `(row, col)`.
`peak`	`(N, M)` correlation peak height; low values flag an unusable region.
`residual`	`(N,)` weighted rms of the shift-equation fit, in gnomonic units -- multiply by `detector.nrows` for pixels.
`n_passes`	Passes run, remapping between each.

beta#: (N, 3, 3) displacement gradient, trace-free: the hydrostatic part is invisible to the projection (see the module docstring).

centers#: (M, 2) region-of-interest centers as (row, col).

n_passes#: Passes run, remapping between each.

peak#: (N, M) correlation peak height; low values flag an unusable region.

residual#: (N,) weighted rms of the shift-equation fit, in gnomonic units – multiply by detector.nrows for pixels. The honest per-point error bar: divide by the gnomonic half-width to read it as a strain floor.

rotation#: (N, 3, 3) lattice rotation, skew(beta).

rotation_vector#: (N, 3) axial vector of rotation, in radians.

shifts#: (N, M, 2) region shifts (drow, dcol) in pixels, from the final pass. After remapping these are residuals, so they should be small.

strain#: (N, 3, 3) deviatoric strain, sym(beta).

to_sample(detector)[source]#: (beta, strain, rotation) rotated into the sample frame.