Skip to content

Commit

Permalink
DOC: Fix sphinx warnigs
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson committed Sep 27, 2024
1 parent d79d010 commit 35b17ab
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions src/Plugins/SimplnxCore/docs/AppendImageGeometryFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ This filter also has an option to mirror the resulting geometry in the chosen di

### X Direction Examples

#### Example 1
#### Example 1 (X)
If the user has an already existing **Image Geometry** that is 100 voxels in the *Y* direction by 300 pixels in the
*Z* direction and composed of 10 *X* slices, then if the user appends another three data sets in the X direction that are the same dimensions in Y & Z but contain 20 *X* slices each, the resulting **Image Geometry** will have a total of 70 *X* slices.

#### Example 2 (Visual Example)
#### Example 2 (Visual Example) (X)
Here's the SmallIN100 dataset example sliced into three pieces in the X direction:

![](Images/AppendImageGeometry/x_direction_pieces.png)
Expand All @@ -28,11 +28,11 @@ And here is what the geometry looks like after appending the three pieces togeth

### Y Direction Examples

#### Example 1
#### Example 1 (Y)
If the user has an already existing **Image Geometry** that is 400 voxels in the *X* direction by 200 pixels in the
*Z* direction and composed of 50 *Y* slices, then if the user appends another two data sets in the Y direction that are the same dimensions in X & Z but contain 40 *Y* slices each, the resulting **Image Geometry** will have a total of 130 *Y* slices.

#### Example 2 (Visual Example)
#### Example 2 (Visual Example) (Y)
Here's the SmallIN100 dataset example sliced into three pieces in the Y direction:

![](Images/AppendImageGeometry/y_direction_pieces.png)
Expand All @@ -43,11 +43,11 @@ And here is what the geometry looks like after appending the three pieces togeth

### Z Direction Examples

#### Example 1
#### Example 1 (Z)
If the user has an already existing **Image Geometry** that is 100 voxels in the *X* direction by 200 pixels in the
*Y* direction and composed of 5 *Z* slices, then if the user appends one other data set in the Z direction that is the same dimensions in X & Y but contains 10 *Z* slices, the resulting **Image Geometry** will have a total of 15 *Z* slices.

#### Example 2 (Visual Example)
#### Example 2 (Visual Example) (Z)
Here's the SmallIN100 dataset example sliced into three pieces in the Z direction:

![](Images/AppendImageGeometry/z_direction_pieces.png)
Expand Down
6 changes: 3 additions & 3 deletions src/Plugins/SimplnxCore/docs/ComputeSurfaceFeaturesFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ This **Filter** determines whether a **Feature** touches an outer *Surface* of t

The output of this filter is a **Feature** level array of booleans where 0=Interior/Not touching and 1=Surface/Touching.

### WARNING
### WARNING - Feature ID=0 Voxels

If there are voxels within the volume that have **Feature ID=0** then any feature touching those voxels will be considered a *Surface* feature.

### WARNING
### WARNING - Fixed bugs

The version of this filter in legacy DREAM.3D had two bugs: one that indexed into neighboring features incorrectly (DREAM3D repo issue #988), and another that incorrectly labeled feature 0 as a surface feature when feature 0 exists in the feature ids array (DREAM3D repo issue #989). Both of these bugs have been fixed in this new version.
The version of this filter in legacy DREAM.3D (version 6.x) had two bugs: one that indexed into neighboring features incorrectly [DREAM.3D repo issue #988](https://github.com/BlueQuartzSoftware/DREAM3D/issues/988), and another that incorrectly labeled feature 0 as a surface feature when feature 0 exists in the feature ids array [DREAM.3D repo issue #989](https://github.com/BlueQuartzSoftware/DREAM3D/issues/989). Both of these bugs have been fixed in this new version.

### 2D Image Geometry

Expand Down

0 comments on commit 35b17ab

Please sign in to comment.