Skip to content

Fix plots found while reviewing the generated docs images - #111

Draft
frankNiessen wants to merge 6 commits into
docs/generated-imagesfrom
fix/plot-review
Draft

frankNiessen wants to merge 6 commits into
docs/generated-imagesfrom
fix/plot-review

Conversation

@frankNiessen

@frankNiessen frankNiessen commented Sep 27, 2026 •

Copy link
Copy Markdown
Collaborator

Stacked on #110; retargets to main once #110 is merged and its branch deleted.

What does this change?

  • liftAboveMap (new, src/util): MTEX 7 draws quiver(grains,...) arrows in 3D, so arrows lying in the map plane are hidden by the map itself and only their heads show. This lifts them slightly towards the viewer. Documented in the function index.
  • plotMap_blockWidths: trace, normal and "mean of projected points" are visible again (lifted, the mean drawn as a line through the centre, no MTEX 7 centre markers).
  • computeHabitPlane: the fitted traces are drawn as lines again instead of dots (same cause).
  • plotMap_KSvariantPairs: with parentGrainId, only the chosen parent grain is shown (grey background and boundaries), not the whole map.
  • plotPDF_variants, plotPDF_packets, plotPDF_bain: stepped colorbar with one colour per Id, matching the maps.
  • CHANGELOG entries under Unreleased.

Why?

Found while reviewing the images generated in #110 against the previously published ones.

How was it tested?

  • mh_lint / pre-commit clean; mkdocs build --strict passes.
  • The MATLAB image workflow runs on this PR; the published-vs-generated comparison (docs-review/compare/index.html in the doc-images artifact of the latest run) was checked for block widths, habit plane, KS variant pairs, the pole figure colorbars and the stack.

Checklist

  • pre-commit run --all-files passes
  • New functions documented in docs/function_index.md
  • CHANGELOG.md updated

- plotMap_KSvariantPairs: with parentGrainId, restrict the grey EBSD map
  to the chosen parent grain
- plotMap_blockWidths: pass 'noMarker' to quiver (MTEX 7 marks grain
  centres by default) and draw the mean of the projected points as an
  axis
- plotPDF_variants/packets/bain: stepped colorbar with one colour per Id,
  as in the maps
MTEX 7 draws quiver(grains,...) in 3D, so arrows lying in the map plane
are hidden by the map and only their heads show. liftAboveMap lifts them
slightly towards the viewer. Used for the block width traces and the
habit plane traces, which also no longer mark every grain centre.

plotMap_KSvariantPairs with parentGrainId no longer draws the
boundaries of all grains, which made the whole map appear.

This branch has not been deployed

No deployments
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