Skip to content

Commit

Permalink
DOC: Update all doc files to have correct filter human name (BlueQuar…
Browse files Browse the repository at this point in the history
…tzSoftware#914)

Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson committed Apr 15, 2024
1 parent 3fa1bb5 commit f206151
Show file tree
Hide file tree
Showing 72 changed files with 72 additions and 72 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Approximate Signed Distance Map Image Filter (ITKApproximateSignedDistanceMapImage)
# ITK Approximate Signed Distance Map Image Filter

Create a map of the approximate signed distance from the boundaries of a binary image.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Connected Component Image Filter (ITKConnectedComponentImage)
# ITK Connected Component Image Filter

Label the objects in a binary image.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Curvature Anisotropic Diffusion Image Filter (ITKCurvatureAnisotropicDiffusionImage)
# ITK Curvature Anisotropic Diffusion Image Filter

This filter performs anisotropic diffusion on a scalar itk::Image using the modified curvature diffusion equation (MCDE).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Curvature Flow Image Filter (ITKCurvatureFlowImage)
# ITK Curvature Flow Image Filter

Denoise an image using curvature driven flow.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Danielsson Distance Map Image Filter (ITKDanielssonDistanceMapImage)
# ITK Danielsson Distance Map Image Filter

This filter computes the distance map of the input image as an approximation with pixel accuracy to the Euclidean distance.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Double Threshold Image Filter (ITKDoubleThresholdImage)
# ITK Double Threshold Image Filter

Binarize an input image using double thresholding.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Gradient Anisotropic Diffusion Image Filter (ITKGradientAnisotropicDiffusionImage)
# ITK Gradient Anisotropic Diffusion Image Filter

This filter performs anisotropic diffusion on a scalar itk::Image using the classic Perona-Malik, gradient magnitude based equation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Gradient Magnitude Recursive Gaussian Image Filter (ITKGradientMagnitudeRecursiveGaussianImage)
# ITK Gradient Magnitude Recursive Gaussian Image Filter

Computes the Magnitude of the Gradient of an image by convolution with the first derivative of a Gaussian.

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/ITKImageProcessing/docs/ITKImageReader.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK::Image Reader
# Read Image (ITK)

This filter directly wraps an ITK filter of the same name.

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/ITKImageProcessing/docs/ITKImageWriter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK::Image Writer (KW)
# Write Image (ITK)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import Fiji Montage
# Read Fiji Montage (ITK)

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/ITKImageProcessing/docs/ITKImportImageStack.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK::Import Images (3D Stack)
# Read Images [3D Stack] (ITK)

This filter directly wraps an ITK filter of the same name.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Iso Contour Distance Image Filter (ITKIsoContourDistanceImage)
# ITK Iso Contour Distance Image Filter

Compute an approximate distance from an interpolated isocontour to the close grid points.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Laplacian Recursive Gaussian Image Filter (ITKLaplacianRecursiveGaussianImage)
# ITK Laplacian Recursive Gaussian Image Filter

Computes the Laplacian of Gaussian (LoG) of an image.

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/ITKImageProcessing/docs/ITKMaskImage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK::Mask Image Filter
# ITK Mask Image Filter

This filter directly wraps an ITK filter of the same name.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Min Max Curvature Flow Image Filter (ITKMinMaxCurvatureFlowImage)
# ITK Min Max Curvature Flow Image Filter

Denoise an image using min/max curvature flow.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Regional Maxima Image Filter (ITKRegionalMaximaImage)
# ITK Regional Maxima Image Filter

Produce a binary image where foreground is the regional maxima of the input image.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Regional Minima Image Filter (ITKRegionalMinimaImage)
# ITK Regional Minima Image Filter

Produce a binary image where foreground is the regional minima of the input image.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Signed Danielsson Distance Map Image Filter (ITKSignedDanielssonDistanceMapImage)
# ITK Signed Danielsson Distance Map Image Filter

This filter computes the signed distance map of the input image as an approximation with pixel accuracy to the Euclidean distance.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Threshold Maximum Connected Components Image Filter (ITKThresholdMaximumConnectedComponentsImage)
# ITK Threshold Maximum Connected Components Image Filter

Finds the threshold value of an image based on maximizing the number of objects in the image that are larger than a given minimal size.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ITK Zero Crossing Image Filter (ITKZeroCrossingImage)
# ITK Zero Crossing Image Filter

This filter finds the closest pixel to the zero-crossings (sign changes) in a signed itk::Image .

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Convert Hexagonal Grid Data to Square Grid Data (TSL - .ang)
# Convert EDAX Hex Grid to Square Grid (.ang)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Convert Orientation Representations
# Convert Orientation Representation

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GenerateFZQuaternions
# Reduce Orientations to Fundamental Zone

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Generate Feature Face Misorientations
# Generate Feature Face Misorientation (Face)

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/OrientationAnalysis/docs/ReadAngDataFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import EDAX EBSD Data (.ang)
# Read EDAX EBSD Data (.ang)

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/OrientationAnalysis/docs/ReadCtfDataFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import Oxford Instr. Ebsd Data
# Read Oxford Instr. EBSD Data (.ctf)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import Ensemble Info File
# Read Ensemble Info File

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/OrientationAnalysis/docs/ReadH5EbsdFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Read H5Ebsd
# Read H5EBSD File

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import Bruker Nano Esprit EBSD Data (.h5)
# Read Bruker Nano Esprit Data (.h5)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import EDAX EBSD Data (.h5)
# Read EDAX OIMAnalysis Data (.h5)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import Oxford AZtec H5OINA Data File (.h5oina)
# Read Oxford Aztec Data (.h5oina)

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/OrientationAnalysis/docs/WriteINLFileFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Export INL File
# Write INL File

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Export Pole Figure Images
# Generate and Write Pole Figure Images

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Export StatsGenerator ODF Angle File
# Write StatsGenerator ODF Angle File

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Append Z-Slice
# Append Z Slice (Image Geometry)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CalculateArrayHistogram
# Calculate Frequency Histogram

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Generate Triangle Areas
# Calculate Triangle Areas

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/ComputeFeatureRectFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Compute Feature Rect
# Compute Feature Corners

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Compute MomentInvariants (2D)
# Compute Moment Invariants (2D)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Create Feature Array From Element Array
# Create Feature Array from Element Array

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/CreateImageGeometry.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Create Geometry (Image)
# Create Geometry (Image)

## This filter should be considered deprecated. Use the "Create Geometry" filter instead

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Smooth Bad Data (Coordination Number)
# Erode/Dilate Coordination Number

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Extract Component as Attribute Array
# Extract/Remove Components

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Extract Internal Surfaces from Triangle Geometry
# Extract Internal Surfaces From Triangle Geometry

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/FindDifferencesMap.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Find Difference Map
# Find Differences Map

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/FindNeighborListStatistics.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Find NeighborList Statistics
# Find Neighbor List Statistics

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Find Surface Area to Volume
# Find Surface Area to Volume & Sphericity

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/FlyingEdges3DFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FlyingEdges3D (Image Contouring)
# Surface Contour Filter (Flying Edges 3D)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Initialize Image Geom Cell Data
# Initialize Image Geometry Cell Data

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Label Triangle Geometry
# Label CAD Geometry

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/MultiThresholdObjects.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Threshold Objects
# Multi-Threshold Objects

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fuse Regular Grids (Nearest Points)
# Fuse Regular Grids (Nearest Point)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import North Star Imaging CT File (Binary)
# Read North Star Imaging CT (.nsihdr/.nsidat)

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/ReadDREAM3DFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Read DREAM3D Filter
# Read DREAM.3D File

## Description

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/ReadDeformKeyFileV12Filter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Read Deform Key File v12
# Read Deform Key File (v12)

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/ReadRawBinaryFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Read Raw Binary File
# Read Raw Binary

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Read Volume Graphics Files (.vgi, .vol)
# Read Volume Graphics File (.vgi/.vol)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Read VTK Structured Points File
# Read Vtk Structured Points File

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/RenameDataObject.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RenameDataObject
# Rename DataObject

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/ResampleImageGeomFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Resample Image Geometry
# Resample Data (Image Geometry)

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Resample RectGrid To ImageGeom
# Resample Rectilinear Grid to Image Geom

## Group (Subgroup)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Set Origin & Spacing (Image Geometry)
# Set Origin & Spacing (Image Geom)

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/SharedFeatureFaceFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Generate Feature Face Triangle Ids
# Generate Triangle Face Ids

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/SurfaceNetsFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SurfaceNets Filter
# SurfaceNets Meshing Filter

## Group (Subgroup)

Expand Down
2 changes: 1 addition & 1 deletion src/Plugins/SimplnxCore/docs/TriangleCentroidFilter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Generate Triangle Centroids
# Calculate Triangle Centroids

## Group (Subgroup)

Expand Down
Loading

0 comments on commit f206151

Please sign in to comment.