Skip to content

Explain how live indexing and live strain work - #33

Merged
CSSFrancis merged 2 commits into
mainfrom
docs/live-indexing
Nov 13, 2026
Merged

CSSFrancis merged 2 commits into
mainfrom
docs/live-indexing

Conversation

@CSSFrancis

Copy link
Copy Markdown
Member

Expands the developer guide's live indexing section (docs/dev/indexing.rst) from one paragraph into how a buffer is indexed, and adds a live strain section.

Live indexing

  • Preparing the patterns: averaging to the refine shape, the static background (and why it waits for 32 frames, and is blurred for a single crystal), the dynamic background, the ghost.
  • Searching the dictionary: one matrix product over every phase's stacked dictionary, chunking for low symmetry, and why the search's masters are blurred 2°.
  • Refining: seven projections a level with a parabola per axis, the fused kernels' coarse levels, and the rotation-only fit (fit=True, fitted_refine_steps_deg).
  • Calibrating the pattern center the same way.

Live strain

  • Fitted against the master (refine_deformation): the g (I - beta) model, why hydrostatic strain is invisible, why rotations are fitted with the strains, the step bound and line search, the fused schedule, and why the pattern center must come from the geometry rather than each pattern.
  • Against a reference (strain_from_reference, HR-EBSD): what it gives up and gains, with the twin comparison.

The numbers are the ones the code's docstrings already record. The docs build passes with -W --keep-going.

https://claude.ai/code/session_01DzXsKCmqfzn1vmniNccgXh

The live indexing section grows from one paragraph to the steps a buffer
goes through -- preparing the patterns against the static and dynamic
backgrounds, the dictionary search, the stepped refine and the fit, the
pattern-center calibration -- and a live strain section: the fit against
the master, and HR-EBSD against a reference, with why each is built as it is.

Claude-Session: https://claude.ai/code/session_01DzXsKCmqfzn1vmniNccgXh
The live-indexing guide opens with a figure of one pattern through the
indexer (prepare, search, the 2 and 1 degree levels as tableaus with their
parabolas, one Gauss-Newton step, the strain fit and its polar split) and
the scan's maps, on de-twin's duplex steel.

The strain fit cites Vermeij and Hoefnagels' integrated DIC (a Gauss-Newton
deformation fit to the whole pattern) and Tanaka and Wilkinson's pattern
matching against simulated patterns, in the guide and in refine_deformation's
docstring; the reference strain cites Wilkinson, Meaden and Dingley's HR-EBSD.

Claude-Session: https://claude.ai/code/session_01DzXsKAUJSM4XYpqqzrcuV5
@CSSFrancis

Copy link
Copy Markdown
Member Author

Added an end-to-end figure of the live indexer at the top of the Live indexing section, made on de-twin's duplex steel. It shows prepare, search, the 2° and 1° refine levels as tableaus with their parabolas, one Gauss–Newton step, the strain fit with its polar split, and the scan's maps. Added citations for the strain fit (Vermeij & Hoefnagels' integrated DIC, Tanaka & Wilkinson's pattern matching) and for the reference strain (Wilkinson, Meaden & Dingley's HR-EBSD), in the guide and in refine_deformation's docstring. Changelog fragment: +live-indexing-figure.doc.rst. The docs build with -W (warnings as errors) and passes.

https://claude.ai/code/session_01DzXsKAUJSM4XYpqqzrcuV5

@CSSFrancis
CSSFrancis added this pull request to stack #36 November 13, 2026 16:41
@CSSFrancis
CSSFrancis marked this pull request as ready for review November 13, 2026 16:42
@CSSFrancis
CSSFrancis merged commit c4722b6 into main Nov 13, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant