FILT: Add EDAX EBSD pattern file reader - #1731
Open
imikejackson wants to merge 1 commit into
Open
Conversation
* Add an extension-based reader hierarchy for UP header versions 1 and 3 * Create AttributeMatrix-aware output arrays with chunked payload imports * Add analytical tests, user documentation, and V&V draft artifacts Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an OrientationAnalysis filter that imports EDAX
.up1and.up2EBSDpattern stacks into SIMPLNX DataArrays. A format-neutral reader interface and
extension-based factory isolate the UP implementation so additional EBSD
pattern formats can be added later. Version 1 and packed version 3 headers,
AttributeMatrix-aware output shapes, bounded sequential reads, validation,
documentation, and V&V artifacts are included. 17 files changed, +1757 / -2
lines.
================================================================================
================================================================================
src/Plugins/OrientationAnalysis/src/OrientationAnalysis/utilities/IEbsdPatternFileReader.hpp— normalized reader contract and metadataEbsdPatternFileReaderFactory.cpp— case-insensitive extension dispatchEdaxUpPatternFileReader.cpp— EDAX UP header and payload implementationEbsdPatternFileUtilities.cpp— checked arithmetic and endian utilitiesThe EDAX reader parses serialized fields individually as little-endian values,
including the unaligned version 3 fields. Checked 64-bit arithmetic protects
pattern strides and payload offsets. The reader supports version 1 and version
3 headers, warns when a future version uses the version 3 layout, diagnoses
likely
.up1/.up2extension mismatches, and skips declared extra patternswhile importing the complete scan grid.
Payload reads use bounded chunks, report progress, and check cancellation
between chunks. In-memory stores use contiguous copies after decoding. Other
store implementations use forward-sequential writes without concurrent access.
================================================================================
2. Filter and DataStructure integration
src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/ReadEbsdPatternFileFilter.cpp— parameters and preflight policyAlgorithms/ReadEbsdPatternFile.cpp— execution-time coordinationThe filter derives output type and component shape from the file.
.up1creates
uint8data and.up2createsuint16data. Each tuple contains onepattern with component shape
{patternHeight, patternWidth}.Outputs created inside an existing AttributeMatrix inherit its tuple shape and
must match its total tuple count. Version 3 files created outside an
AttributeMatrix use the stored row and column counts. Version 1 files default
to a flat pattern count and optionally accept validated user-supplied rows and
columns.
================================================================================
3. Validation, tests, and documentation
src/Plugins/OrientationAnalysis/test/ReadEbsdPatternFileTest.cpp— independent analytical byte fixtures and behavior checks
src/Plugins/OrientationAnalysis/docs/ReadEbsdPatternFileFilter.md— user-facing format, shape, and limitation guidance
src/Plugins/OrientationAnalysis/vv/ReadEbsdPatternFileFilter.md— Class 1 and Class 4 V&V dashboard
Fourteen Catch2 tests construct little-endian files independently of the
production reader. They verify exact pixel values, both header versions, both
pixel widths, manual and AttributeMatrix tuple shapes, extra-pattern handling,
future-version warnings, malformed files, both extension-mismatch directions,
case-insensitive extensions, and cancellation.
Test plan
alltarget builds with AppleClang in Release configuration