DOC: Update filter documentation with figures and easier to read descriptions - #1589
Open
imikejackson wants to merge 1 commit into
Open
DOC: Update filter documentation with figures and easier to read descriptions#1589imikejackson wants to merge 1 commit into
imikejackson wants to merge 1 commit into
Conversation
imikejackson
force-pushed
the
topic/documentation_update
branch
3 times, most recently
from
April 24, 2026 18:44
9b8844e to
c843a5a
Compare
imikejackson
force-pushed
the
topic/documentation_update
branch
from
May 4, 2026 20:06
c843a5a to
d02723b
Compare
imikejackson
force-pushed
the
topic/documentation_update
branch
from
May 28, 2026 20:23
8aff31f to
8aea5bc
Compare
imikejackson
force-pushed
the
topic/documentation_update
branch
from
June 11, 2026 00:12
8aea5bc to
2836ec0
Compare
imikejackson
force-pushed
the
topic/documentation_update
branch
2 times, most recently
from
June 18, 2026 16:49
4bfd0d5 to
33fb6fb
Compare
imikejackson
force-pushed
the
topic/documentation_update
branch
3 times, most recently
from
July 16, 2026 18:29
e7232d6 to
02535b3
Compare
imikejackson
force-pushed
the
topic/documentation_update
branch
from
July 24, 2026 01:32
02535b3 to
a09fc5d
Compare
Multi-batch documentation overhaul across SimplnxCore, OrientationAnalysis, and ITKImageProcessing, plus supporting figures. Documentation review (Batches 1-9, ~284 filters): * Rewrote filter docs for accuracy against the implementation: explicit units on parameters, "Required Input Sources" sections naming the upstream producer filters, and MyST cross-references between filters. * Covered orientation/crystallography, alignment, segmentation, neighbor and kernel operations, geometry creation/manipulation, data manipulation, I/O filters, the ITK image-processing wrappers (88), and the remaining SimplnxCore filters. * Fixed doc/code mismatches surfaced during review (e.g. ErodeDilate Coordination Number uses CN >= threshold; Write GBCD Triangles column legend header). * Moved 6 disabled ITK filter docs to docs_disabled/ so only built filters ship, clearing stale MyST cross-reference warnings. * Added reference docs: upstream-filter-sources.md, filter-figure-style.md, and the documentation_review_tracker.md. Figures: * EBSDSegmentFeatures before/after screenshot pilot (IPF map -> segmented grains) with a reproducibility pipeline and .d3dstate files under docs/figure-generation/. * 15 hand-authored conceptual SVG/PNG diagrams: coordination number, sample-vs-geometric rotation, geometry types, image-geometry origin/ spacing/dimensions, erode/dilate iteration, sample-vs-crystal reference frame, axis-angle transform, cell/feature/ensemble data model, equivalent sphere diameter, orientation representations, resample spacing/cell-count, misorientation, morphological opening/closing, HDF5 tuples/components, and Abaqus voxel-to-hexahedron. Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
imikejackson
force-pushed
the
topic/documentation_update
branch
from
July 24, 2026 19:28
a09fc5d to
5c1d68e
Compare
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
1 participant
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.
No description provided.