Skip to content

Commit 279922b

Browse files
committed
Retrofit Batch 1 & 2 docs: Required Input Sources + MyST links
- 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.
1 parent ca8bbea commit 279922b

22 files changed

Lines changed: 180 additions & 33 deletions

src/Plugins/OrientationAnalysis/docs/AlignSectionsMisorientationFilter.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This **Filter** aligns serial sections (2D slices stacked along the Z-direction)
1010

1111
### When to Use This Method
1212

13-
Use this method when your data contains crystal orientation measurements (quaternions or Euler angles) and you want to align sections based on the actual crystallographic content. This works well for most EBSD datasets. For data without orientation information, consider the **Align Sections (Feature Centroid)** or **Align Sections (Mutual Information)** methods instead.
13+
Use this method when your data contains crystal orientation measurements (quaternions or Euler angles) and you want to align sections based on the actual crystallographic content. This works well for most EBSD datasets. For data without orientation information, consider the [Align Sections (Feature Centroid)](../SimplnxCore/AlignSectionsFeatureCentroidFilter.md) or [Align Sections (Mutual Information)](AlignSectionsMutualInformationFilter.md) methods instead.
1414

1515
### How This Filter Works
1616

@@ -25,7 +25,7 @@ The filter uses an iterative grid search to find the optimal alignment for each
2525

2626
### Local Minima Warning
2727

28-
This iterative grid search is similar to a downhill simplex optimization and **can get caught in a local minimum**. If alignment results look incorrect, try adjusting the misorientation tolerance or consider using the **Align Sections (Feature Centroid)** method, which does not have this limitation.
28+
This iterative grid search is similar to a downhill simplex optimization and **can get caught in a local minimum**. If alignment results look incorrect, try adjusting the misorientation tolerance or consider using the [Align Sections (Feature Centroid)](../SimplnxCore/AlignSectionsFeatureCentroidFilter.md) method, which does not have this limitation.
2929

3030
### Masking
3131

@@ -58,6 +58,12 @@ In this new structure, what follows is what the created structures represent:
5858

5959
In previous versions a file would have been produced instead. If you wish to recreate this, you can write the Attribute Matrix as a CSV/Text file.
6060

61+
### Required Input Sources
62+
63+
- **Cell Quaternions** -- typically read from EBSD data via [Read H5EBSD](ReadH5EbsdFilter.md), [Read CTF Data](ReadCtfDataFilter.md), or [Read ANG Data](ReadAngDataFilter.md).
64+
- **Cell Phases** -- typically read from EBSD data alongside the quaternions.
65+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
66+
- **Mask** (optional) -- a boolean array marking valid cells, typically produced by a threshold operation such as [Multi-Threshold Objects](../SimplnxCore/MultiThresholdObjectsFilter.md).
6167

6268
% Auto generated parameter table will be inserted here
6369

src/Plugins/OrientationAnalysis/docs/AlignSectionsMutualInformationFilter.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Reconstruction (Alignment)
66

77
## Description
88

9-
This **Filter** aligns serial sections (2D slices stacked along the Z-direction) by maximizing the *mutual information* between the feature patterns on neighboring slices. Rather than comparing individual cell orientations (as in **Align Sections (Misorientation)**), this method first groups cells into temporary features on each slice, then finds the shift that best aligns those feature patterns between slices.
9+
This **Filter** aligns serial sections (2D slices stacked along the Z-direction) by maximizing the *mutual information* between the feature patterns on neighboring slices. Rather than comparing individual cell orientations (as in [Align Sections (Misorientation)](AlignSectionsMisorientationFilter.md)), this method first groups cells into temporary features on each slice, then finds the shift that best aligns those feature patterns between slices.
1010

1111
### When to Use This Method
1212

@@ -18,7 +18,7 @@ Mutual information is a statistical measure of how much information one variable
1818

1919
### How This Filter Works
2020

21-
1. **Segment features on each slice:** Neighboring cells on each 2D slice are grouped into temporary features using a misorientation tolerance (the same algorithm as **Segment Features (Misorientation)**, applied in 2D). These feature IDs are internal to this filter and are not stored.
21+
1. **Segment features on each slice:** Neighboring cells on each 2D slice are grouped into temporary features using a misorientation tolerance (the same algorithm as [Segment Features (Misorientation)](EBSDSegmentFeaturesFilter.md), applied in 2D). These feature IDs are internal to this filter and are not stored.
2222
2. **Calculate mutual information:** For a given relative position of two slices, compute the mutual information between the feature ID patterns on the two slices.
2323
3. **Grid search:** Evaluate the mutual information at all 49 positions in a 7x7 grid (shifting the upper slice from -3 to +3 cells in both X and Y). Select the position with the highest mutual information.
2424
4. **Iterate:** Re-center the 7x7 grid on the best position and repeat until the best position no longer changes.
@@ -30,7 +30,7 @@ The *misorientation tolerance* parameter controls how cells are grouped into tem
3030

3131
### Local Minima Warning
3232

33-
This iterative grid search is similar to a downhill simplex optimization and **can get caught in a local minimum**. If alignment results look incorrect, try adjusting the misorientation tolerance or consider using the **Align Sections (Feature Centroid)** method, which does not have this limitation.
33+
This iterative grid search is similar to a downhill simplex optimization and **can get caught in a local minimum**. If alignment results look incorrect, try adjusting the misorientation tolerance or consider using the [Align Sections (Feature Centroid)](../SimplnxCore/AlignSectionsFeatureCentroidFilter.md) method, which does not have this limitation.
3434

3535
### Masking
3636

@@ -59,6 +59,13 @@ In this new structure, what follows is what the created structures represent:
5959

6060
In previous versions a file would have been produced instead. If you wish to recreate this, you can write the Attribute Matrix as a CSV/Text file.
6161

62+
### Required Input Sources
63+
64+
- **Cell Quaternions** -- typically read from EBSD data via [Read H5EBSD](ReadH5EbsdFilter.md), [Read CTF Data](ReadCtfDataFilter.md), or [Read ANG Data](ReadAngDataFilter.md).
65+
- **Cell Phases** -- typically read from EBSD data alongside the quaternions.
66+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
67+
- **Mask** (optional) -- a boolean array marking valid cells, typically produced by a threshold operation such as [Multi-Threshold Objects](../SimplnxCore/MultiThresholdObjectsFilter.md).
68+
6269
% Auto generated parameter table will be inserted here
6370

6471
## References

src/Plugins/OrientationAnalysis/docs/ComputeAvgCAxesFilter.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ In cubic materials, the [001], [010], and [100] directions are all crystallograp
3030

3131
The filter will produce an error if no hexagonal phases are present in the data.
3232

33+
### Required Input Sources
34+
35+
This filter operates on previously segmented data and requires that several prior operations have already been run:
36+
37+
- **Cell Quaternions** -- typically read from EBSD data via [Read H5EBSD](ReadH5EbsdFilter.md), [Read CTF Data](ReadCtfDataFilter.md), or [Read ANG Data](ReadAngDataFilter.md); can also be produced from Euler angles by [Convert Orientations](ConvertOrientationsFilter.md).
38+
- **Cell Feature Ids** -- produced by a segmentation filter such as [Segment Features (Misorientation)](EBSDSegmentFeaturesFilter.md) or [Segment Features (C-Axis Misalignment)](CAxisSegmentFeaturesFilter.md).
39+
- **Cell Phases** -- typically read from EBSD data alongside the quaternions.
40+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
41+
3342
% Auto generated parameter table will be inserted here
3443

3544
## Example Pipelines

src/Plugins/OrientationAnalysis/docs/ComputeAvgOrientationsFilter.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,13 @@ These values may be exposed as user-configurable parameters in a future release.
7272
- **Features with zero elements:** Features with no elements (phase <= 0 for all voxels) will have their output arrays initialized to NaN (for vMF/Watson) or identity quaternion / zero Euler angles (for Rodrigues).
7373
- **Phase indexing:** The filter requires that phase values be > 0 for elements to be included in the averaging. Phase index 0 is reserved for "Unknown" in the Crystal Structures array and is always skipped.
7474

75+
### Required Input Sources
76+
77+
- **Cell Quaternions** -- typically read from EBSD data via [Read H5EBSD](ReadH5EbsdFilter.md), [Read CTF Data](ReadCtfDataFilter.md), or [Read ANG Data](ReadAngDataFilter.md); can also be produced from Euler angles by [Convert Orientations](ConvertOrientationsFilter.md).
78+
- **Cell Feature Ids** -- produced by a segmentation filter such as [Segment Features (Misorientation)](EBSDSegmentFeaturesFilter.md).
79+
- **Cell Phases** -- typically read from EBSD data alongside the quaternions.
80+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
81+
7582
% Auto generated parameter table will be inserted here
7683

7784
## Example Pipelines

src/Plugins/OrientationAnalysis/docs/ComputeBoundaryStrengthsFilter.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Statistics (Crystallography)
88

99
This **Filter** computes slip transmission metrics for each **Face** (triangle) on a grain boundary mesh. These metrics quantify how easily plastic deformation can transfer across a grain boundary, based on the geometric alignment of slip systems in the two grains on either side.
1010

11-
This filter computes the same metrics as the **Compute Neighbor Slip Transmission Metrics** filter, but stores results per boundary **Face** rather than per **Feature**. This makes it suitable for visualization and analysis on a **Triangle Geometry** surface mesh.
11+
This filter computes the same metrics as the [Compute Neighbor Slip Transmission Metrics](ComputeSlipTransmissionMetricsFilter.md) filter, but stores results per boundary **Face** rather than per **Feature**. This makes it suitable for visualization and analysis on a **Triangle Geometry** surface mesh.
1212

13-
For a detailed explanation of the slip transmission concept and the individual metrics, see the **Compute Neighbor Slip Transmission Metrics** documentation.
13+
For a detailed explanation of the slip transmission concept and the individual metrics, see the [Compute Neighbor Slip Transmission Metrics](ComputeSlipTransmissionMetricsFilter.md) documentation.
1414

1515
### Cubic Materials Only
1616

@@ -43,6 +43,15 @@ Three fracture initiation parameter values are computed per **Face**, as defined
4343

4444
[2] [D. Kumar, T. R. Bieler, P. Eisenlohr, D. E. Mason, M. A. Crimp, F. Roters, and D. Raabe. On Predicting Nucleation of Microcracks Due to Slip Twin Interactions at Grain Boundaries in Duplex Near γ-TiAl. Journal of Engineering Materials and Technology, 130(2):021012–12, 2008. doi:10.1115/1.2841620.](https://doi.org/10.1115/1.2841620)
4545

46+
### Required Input Sources
47+
48+
This filter operates on a grain-boundary surface mesh and requires the following upstream steps:
49+
50+
- **Triangle Geometry** and **Face Labels** -- produced by a surface meshing filter such as [Quick Surface Mesh](../SimplnxCore/QuickSurfaceMeshFilter.md).
51+
- **Average Quaternions** -- the per-feature average orientation produced by [Compute Average Orientations](ComputeAvgOrientationsFilter.md).
52+
- **Feature Phases** -- produced by [Compute Feature Phases](../SimplnxCore/ComputeFeaturePhasesFilter.md).
53+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
54+
4655
% Auto generated parameter table will be inserted here
4756

4857
## Example Pipelines

src/Plugins/OrientationAnalysis/docs/ComputeCAxisLocationsFilter.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ In cubic materials, the [001], [010], and [100] directions are all crystallograp
2828

2929
### Comparison with Compute Average C-Axis Orientations
3030

31-
This filter computes the C-axis direction for each individual **Cell**. If you need the average C-axis direction for each **Feature** (grain) instead, use the **Compute Average C-Axis Orientations** filter.
31+
This filter computes the C-axis direction for each individual **Cell**. If you need the average C-axis direction for each **Feature** (grain) instead, use the [Compute Average C-Axis Orientations](ComputeAvgCAxesFilter.md) filter.
32+
33+
### Required Input Sources
34+
35+
- **Cell Quaternions** -- typically read from EBSD data via [Read H5EBSD](ReadH5EbsdFilter.md), [Read CTF Data](ReadCtfDataFilter.md), or [Read ANG Data](ReadAngDataFilter.md); can also be produced from Euler angles by [Convert Orientations](ConvertOrientationsFilter.md).
36+
- **Cell Phases** -- typically read from EBSD data alongside the quaternions.
37+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
3238

3339
% Auto generated parameter table will be inserted here
3440

src/Plugins/OrientationAnalysis/docs/ComputeFeatureNeighborCAxisMisalignmentsFilter.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,27 @@ This is distinct from a full misorientation, which considers the complete rotati
1313
### Flexible Neighbor Definition
1414

1515
The neighbor list is supplied by the user and can come from any filter that produces neighbor relationships. For example:
16-
- **Find Feature Neighbors** -- neighbors that physically share a boundary
17-
- **Compute Feature Neighborhoods** -- neighbors within a specified radius
16+
- [Compute Feature Neighbors](../SimplnxCore/ComputeFeatureNeighborsFilter.md) -- neighbors that physically share a boundary
17+
- [Compute Feature Neighborhoods](../SimplnxCore/ComputeNeighborhoodsFilter.md) -- neighbors within a specified radius
1818
- Any other custom filter that generates a neighbor list
1919

20-
### Outputs
21-
22-
- A list of C-axis misalignment angles (in degrees) for each **Feature**, one per neighbor
23-
- Optionally, the average misalignment across all neighbors
20+
The filter also optionally computes the average misalignment across all of a feature's neighbors.
2421

2522
### Hexagonal Materials Only
2623

27-
Only **Features** with identical phase values and a crystal structure of **Hexagonal_High** (6/mmm) or **Hexagonal_Low** (Hexagonal 6/m (C6h)) are compared. If two **Features** have different phases or a non-hexagonal crystal structure, a value of NaN is stored for the misalignment. See the **Compute Average C-Axis Orientations** documentation for an explanation of why C-axis calculations are restricted to hexagonal materials.
24+
Only **Features** with identical phase values and a crystal structure of **Hexagonal_High** (6/mmm) or **Hexagonal_Low** (Hexagonal 6/m (C6h)) are compared. If two **Features** have different phases or a non-hexagonal crystal structure, a value of NaN is stored for the misalignment. See the [Compute Average C-Axis Orientations](ComputeAvgCAxesFilter.md) documentation for an explanation of why C-axis calculations are restricted to hexagonal materials.
2825

2926
### Note
3027

3128
Results from this filter may differ from the original DREAM.3D 6.5 version by approximately 0.0001 degrees due to the use of double precision and Eigen for matrix operations.
3229

30+
### Required Input Sources
31+
32+
- **Neighbor List** -- produced by [Compute Feature Neighbors](../SimplnxCore/ComputeFeatureNeighborsFilter.md) or [Compute Feature Neighborhoods](../SimplnxCore/ComputeNeighborhoodsFilter.md).
33+
- **Average Quaternions** -- produced by [Compute Average Orientations](ComputeAvgOrientationsFilter.md).
34+
- **Feature Phases** -- produced by [Compute Feature Phases](../SimplnxCore/ComputeFeaturePhasesFilter.md).
35+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
36+
3337
% Auto generated parameter table will be inserted here
3438

3539
## Example Pipelines

src/Plugins/OrientationAnalysis/docs/ComputeFeatureNeighborMisorientationsFilter.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ Optionally, the filter can also compute the average misorientation between a **F
1616

1717
Only **Features** with identical crystal structures are compared. If two neighboring **Features** have different crystal structures, a value of NaN is stored for their misorientation, since misorientation between different crystal systems is not physically meaningful.
1818

19+
### Required Input Sources
20+
21+
- **Neighbor List** -- produced by [Compute Feature Neighbors](../SimplnxCore/ComputeFeatureNeighborsFilter.md) or [Compute Feature Neighborhoods](../SimplnxCore/ComputeNeighborhoodsFilter.md).
22+
- **Average Quaternions** -- produced by [Compute Average Orientations](ComputeAvgOrientationsFilter.md).
23+
- **Feature Phases** -- produced by [Compute Feature Phases](../SimplnxCore/ComputeFeaturePhasesFilter.md).
24+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
25+
1926
% Auto generated parameter table will be inserted here
2027

2128
## Example Pipelines

src/Plugins/OrientationAnalysis/docs/ComputeFeatureReferenceCAxisMisorientationsFilter.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,20 @@ A low average misalignment indicates a grain with a uniform C-axis orientation.
2121

2222
### Hexagonal Materials Only
2323

24-
This filter requires at least one hexagonal crystal structure phase (6/m or 6/mmm). Non-hexagonal phases are skipped. See the **Compute Average C-Axis Orientations** documentation for an explanation of why C-axis calculations are restricted to hexagonal materials.
24+
This filter requires at least one hexagonal crystal structure phase (6/m or 6/mmm). Non-hexagonal phases are skipped. See the [Compute Average C-Axis Orientations](ComputeAvgCAxesFilter.md) documentation for an explanation of why C-axis calculations are restricted to hexagonal materials.
2525

2626
### Note
2727

2828
Results may differ from the DREAM3D 6.6 version by approximately 0.0001 degrees due to improved double-precision calculations for cross-platform accuracy.
2929

30+
### Required Input Sources
31+
32+
- **Cell Feature Ids** -- produced by a segmentation filter such as [Segment Features (Misorientation)](EBSDSegmentFeaturesFilter.md) or [Segment Features (C-Axis Misalignment)](CAxisSegmentFeaturesFilter.md).
33+
- **Cell Quaternions** -- typically read from EBSD data via [Read H5EBSD](ReadH5EbsdFilter.md), [Read CTF Data](ReadCtfDataFilter.md), or [Read ANG Data](ReadAngDataFilter.md).
34+
- **Cell Phases** -- typically read from EBSD data alongside the quaternions.
35+
- **Average C-Axes** -- produced by [Compute Average C-Axis Orientations](ComputeAvgCAxesFilter.md).
36+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
37+
3038
% Auto generated parameter table will be inserted here
3139

3240
## Example Pipelines

src/Plugins/OrientationAnalysis/docs/ComputeFeatureReferenceMisorientationsFilter.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,15 @@ feature boundary, and use that voxel's orientation as the **reference orientatio
4545

4646
![ComputeFeatureReferenceMisorientations_1.png](Images/ComputeFeatureReferenceMisorientations_1.png)
4747

48+
### Required Input Sources
49+
50+
- **Cell Feature Ids** -- produced by a segmentation filter such as [Segment Features (Misorientation)](EBSDSegmentFeaturesFilter.md).
51+
- **Cell Quaternions** -- typically read from EBSD data via [Read H5EBSD](ReadH5EbsdFilter.md), [Read CTF Data](ReadCtfDataFilter.md), or [Read ANG Data](ReadAngDataFilter.md).
52+
- **Cell Phases** -- typically read from EBSD data alongside the quaternions.
53+
- **Average Quaternions** (for Average Feature Orientation mode) -- produced by [Compute Average Orientations](ComputeAvgOrientationsFilter.md).
54+
- **Boundary Euclidean Distances** (for Orientation Farthest from Feature Boundary mode) -- produced by [Compute Euclidean Distance Map](../SimplnxCore/ComputeEuclideanDistMapFilter.md).
55+
- **Crystal Structures** -- ensemble-level array read from EBSD data or created by [Create Ensemble Info](CreateEnsembleInfoFilter.md).
56+
4857
% Auto generated parameter table will be inserted here
4958

5059
## Example Pipelines

0 commit comments

Comments
 (0)