Skip to content

BUG: Combine the EBSD fixes that need the next EbsdLib release - #1973

Open
imikejackson wants to merge 14 commits into
BlueQuartzSoftware:developfrom
imikejackson:topic/next_ebsdlib_fixes
Open

imikejackson wants to merge 14 commits into
BlueQuartzSoftware:developfrom
imikejackson:topic/next_ebsdlib_fixes

Conversation

@imikejackson

@imikejackson imikejackson commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This branch combines the simplnx pull requests that are tied to the next EbsdLib release into one branch, so that simplnx and EbsdLib each have one branch to build and test together. It builds and passes its tests against BlueQuartzSoftware/EbsdLib#86 (branch topic/next_release_fixes).

Each original pull request is merged with --no-ff, so its commits and history are kept. The original pull requests are closed with a link to this one.

CI will fail until the EbsdLib release is in simplnx-registry. This branch uses LaueOps::GetLaueOpsFromSpaceGroupNumber and other API that EbsdLib 3.1.3 does not have. Merge order: EbsdLib#86, EbsdLib release, simplnx-registry update, simplnx vcpkg update, then this pull request.

Merged pull requests

PR Title Closes
#1967 BUG: Validate EBSD reader headers, scans and slice ranges #1882, #1906
#1962 BUG: Use one EbsdLib space-group mapping in Read GrainMapper3D #1953
#1965 BUG: Fix input validation in four EBSD and mesh filters #1882, #1906, #1946, #1957
#1968 BUG: Return child preflight errors from ReadH5Ebsd without a crash
#1969 BUG: Reject zero and nonfinite misorientation axes and loading directions
#1970 BUG: Check the Phase of Interest and its crystal structure in Write GBCD GMT
#1971 BUG: Report an error for an empty or malformed EBSD phase table
#1972 BUG: Clamp cosines before acos in Compute Twin Boundaries
#1961 COMP: Rename the simplnx HDF5 lock macro to remove a name conflict

Closes #1953
Closes #1882
Closes #1906
Closes #1946
Closes #1957

Conflict resolutions and decisions

Changes needed for the combined EbsdLib

  • Three tests now expect the EbsdLib error, because the combined EbsdLib rejects the input before the simplnx check runs:
    • ReadAngData: HeaderValidation steps: an XSTEP or YSTEP of nan or 1e999 gives -115 from AngReader (EbsdLib#82), not -67602.
    • ReadChannel5Data: Empty phase list: -102300 from CprReader (EbsdLib#75), not -66502.
    • ReadH5Ebsd: Phase table validation, short lattice constants: -50027 (EbsdLib#84), not -50028.
  • The simplnx checks -66502 and -50028 are kept as a fallback.
  • Read H5EBSD error -50027 now includes the reader's error code and message, so the user sees the EbsdLib reason (for example -90350 for a LatticeConstants dataset without 6 values). The test checks for it.

Test Plan

  • Linux x64, Release (ci-linux-x64 preset with SIMPLNX_USE_LOCAL_EBSD_LIB=ON, EbsdLib topic/next_release_fixes, H5Support v1.0.14): full ctest passes serially, 3972/3972. After the last two commits (the -50027 message and the EbsdLib H5CtfVolumeReader fix), the OrientationAnalysis tests pass again, 520/520.
  • No exemplar result changed with the combined EbsdLib, including Bug in Import ASCI Data #60/Feature/MapPointCloudToRegularGrid #61 (ODF sampling) and Save Filter DataStructure on Error #64 (getFZQuat).
  • clang-format 19.1.1: every changed C++ file is clean.
  • Windows x64, Release (MSVC 2022 14.44, Ninja, x64-windows-v143, local EbsdLib#86 and H5Support v1.0.14): all 1478 targets build. The only warnings are 6 existing C4244 warnings in test files that this branch does not change. EbsdLib tests pass 516/516 and ^OrientationAnalysis:: tests pass 496/496, the same count as Linux for that pattern. The full simplnx suite was not run on Windows.
  • macOS build.
  • Out-of-core validation: not run (no out-of-core build on this machine).
  • CI (after the EbsdLib release and the simplnx-registry update).

The bluequartz-skills plugin skills that AGENTS.md lists were not available in this environment; the changes follow docs/Coding_Knowledge_Base.md.

🤖 Generated with Claude Code

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

…Software#1967)

Originally simplnx BlueQuartzSoftware#1967 (branch fix/ebsd-vv-filter-items), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…uartzSoftware#1962)

Originally simplnx BlueQuartzSoftware#1962 (branch topic/gm3d_space_group_laue), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…ftware#1965)

Originally simplnx BlueQuartzSoftware#1965 (branch topic/hex_to_square_ang_extension_case), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…lueQuartzSoftware#1968)

Originally simplnx BlueQuartzSoftware#1968 (branch fix/read_h5ebsd_preflight_errors), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…ions (BlueQuartzSoftware#1969)

Originally simplnx BlueQuartzSoftware#1969 (branch fix/orientation-axis-direction-validation), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…BCD GMT (BlueQuartzSoftware#1970)

Originally simplnx BlueQuartzSoftware#1970 (branch fix/writegbcdgmt-crystal-structure-check), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…QuartzSoftware#1971)

Originally simplnx BlueQuartzSoftware#1971 (branch fix/ebsd-reader-phase-table-checks), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…Software#1972)

Originally simplnx BlueQuartzSoftware#1972 (branch fix/twin-boundaries-acos-clamp), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…lueQuartzSoftware#1961)

Originally simplnx BlueQuartzSoftware#1961 (branch topic/rename_simplnx_h5support_mutex_macro), combined into this branch for the EbsdLib 3.1.4 update.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
- The merge of BlueQuartzSoftware#1962 into the combined branch joined the last BlueQuartzSoftware#1967 test case
  and the first BlueQuartzSoftware#1962 test case without the closing brace between them, so
  ReadGrainMapper3DTest.cpp did not compile.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
…ter checks

The combined EbsdLib rejects three malformed inputs in the reader, before the
simplnx check that the test expected can run:

- ReadAngData HeaderValidation steps: AngReader reports an XSTEP or YSTEP of
  "nan" or "1e999" as a header parse error (-115, EbsdLib "Report an error when
  an ANG header number cannot be parsed"). The filter check (-67602) still
  rejects -1 and 0.
- ReadChannel5Data Empty phase list: CprReader reports a .cpr file without
  phases (-102300, EbsdLib "Report an error when a .cpr file defines no
  phases") before the filter check (-66502).
- ReadH5Ebsd Phase table validation: EbsdLib rejects a LatticeConstants dataset
  without 6 values, so the volume reader returns no phases (-50027) before the
  lattice-constant check (-50028).

Each input is still rejected with an error that names the file and the value.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
* When EbsdLib returns no phases, error -50027 now gives the reader's
  error code and message, for example the EbsdLib -90350 message for a
  LatticeConstants dataset that does not hold 6 values. Before, the
  message said only that the phase information could not be read.
* The phase-table test checks that the message contains -90350.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
@imikejackson
imikejackson force-pushed the topic/next_ebsdlib_fixes branch from 841677f to 20b4e06 Compare November 14, 2026 19:34
Fill the grayscale pipeline fixture by index instead of growing it with
vector::insert, which triggers a gcc 13 -Wstringop-overflow false positive.
The pixel bytes are unchanged.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
@imikejackson

Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant