DOC: Update filter documentation with figures and easier to read descriptions#1589
Open
imikejackson wants to merge 13 commits into
Open
DOC: Update filter documentation with figures and easier to read descriptions#1589imikejackson wants to merge 13 commits into
imikejackson wants to merge 13 commits into
Conversation
imikejackson
force-pushed
the
topic/documentation_update
branch
3 times, most recently
from
9b8844e to
c843a5a
Compare
ComputeGBCDMetricBasedFilter -- Broke up the dense paragraph about metrics into a numbered two-stage explanation (misorientation selection, then normal probing). Added a sentence explaining why metric-based avoids discretization artifacts vs binning. ComputeGBPDMetricBasedFilter -- Added a clear opening that explains what GBPD is and how it differs from GBCD (2D plane normals only vs full 5D). Added MRD interpretation (1.0 = random, >1.0 = preferred). Restructured the metric-based approach description. ComputeShapesTriangleGeomFilter -- Moved the caveats into a cleaner "Differences from the Image Geometry Version" section. Consolidated the watertight warning and Euler characteristic info into a single "Mesh Quality Requirements" section. Cross-referenced the Image Geometry version for output descriptions to avoid duplication.
- Add "Required Input Sources" section to filters with non-obvious upstream
dependencies, naming the specific filter that produces each required input.
- Convert inline filter name mentions to MyST markdown links
([Filter Name](FilterFile.md)) so they render as clickable cross-references
in the Sphinx-generated documentation.
- Remove redundant "Outputs" listing in ComputeFeatureNeighborCAxisMisalignments
(auto-generated parameter table already covers it).
- Replace existing {ref} directive in ComputeGBPDMetricBased with a simpler
MyST link.
imikejackson
force-pushed
the
topic/documentation_update
branch
from
c843a5a to
d02723b
Compare
…e-style Reference material extracted from the vv-filter-documentation skill so the lookup table can be grown by separate agents and the figure style guide is versioned with the project. - docs/upstream-filter-sources.md: input array → producing filter table with conventions for growing the table and a stub for future graph representation. - docs/filter-figure-style.md: canonical font, color palette, callout box, file format, and naming conventions for filter doc figures.
Triaged Geometry Creation / Manipulation batch (15 filters): - Tier 1 (Critical): 0 - Tier 2 (Important): 8 filters (CreateGeometry, ApplyTransformationToGeometry, RotateSampleRefFrame, ResampleImageGeom, ResampleRectGridToImageGeom, PadImageGeometry, QuickSurfaceMesh, InitializeImageGeomCellData) - Tier 3 (Polish): 7 filters (CreateImageGeometry, CombineTransformationMatrices, SetImageGeomOriginScaling, CropImageGeometry, AppendImageGeometry, PartitionGeometry, ComputeCoordinatesImageGeom) Added 14 Real-World Visualization Wishlist entries with priorities, and 3 new concept-page candidates (Geometry Types, Transformation Matrices, Sample vs Crystal Reference Frame).
Tier 2 (8 filters): CreateGeometry, ApplyTransformationToGeometry, RotateSampleRefFrame, ResampleImageGeom, ResampleRectGridToImageGeom, PadImageGeometry, QuickSurfaceMesh, InitializeImageGeomCellData. Tier 3 (7 filters): CreateImageGeometry, CombineTransformationMatrices, SetImageGeomOriginScaling, CropImageGeometry, AppendImageGeometry, PartitionGeometry, ComputeCoordinatesImageGeom. Each rewrite applied the established conventions: Required Input Sources section naming upstream producers, MyST cross-reference links, explicit units on numeric parameters, no duplication of the auto-generated parameter table. Notable structural changes: - CreateGeometry: trimmed and reorganized; promoted geometry-type taxonomy to a navigable table. - ApplyTransformationToGeometry: removed duplicate transformation-type listing; added explicit cross-reference to CombineTransformationMatrices. - RotateSampleRefFrame: prominent verified-only-for-axis-aligned banner; explicit distinction from ApplyTransformation. - QuickSurfaceMesh: deprecation banner promoted with explicit recommendation to use Surface Nets. - CropImageGeometry: documented voxels-vs-physical-bounds parameter explicitly. - PadImageGeometry: expanded Default Value semantics and Update Origin behavior. Build verified clean (no new Sphinx warnings).
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.