Skip to content

Commit dc2d293

Browse files
hjmjohnsonhjmjohnson
committed
DOC: Improved results and indexing. Addition changes mentioned in pull request.
The examples were run and the image and command line outputs were captured in many of the examples. - AbsValueOfImage - AbsValueOfTwoImages - AddConstantToEveryPixel - AddConstantToPixelsWithoutDuplication - AddPointsAndEdges - AddTwoImages - ApplyKernelToEveryPixel - ApplyKernelToEveryPixelInNonZeroImage - ApproxDistanceMapOfBinary - AssignContiguousLabelsToConnectedRegions - BilateralFilterAnImage - BinaryANDTwoImages - BinaryMinMaxCurvatureFlow - BinaryORTwoImages - BinaryXORTwoImages - Blob - CalculateAreaAndVolumeOfSimplexMesh - CartesianToAzimuthElevation - CastImageToAnotherTypeButClampToOutput - CastVectorImageToAnotherType - CheckIfModuleIsPresent - CleanQuadEdgeMesh - ClosingBinaryImage - ClusterPixelsInGrayscaleImage - ColorBoundariesOfRegions - ColorLabeledRegions - ComposeVectorFromThreeScalarImages - ComputeInverseFFTOfImage - ComputeMeanSquareBetweenTwoImages - ComputeMedianOfImageAtPixel - ComputeMinMaxVarianceMeanOfImage - ComputerLocalNoise - ComputerMagInVectorImageToMakeMagImage - ContourSpatialObject - ConvertArrayToImage - ConvertImageToAnotherType - ConvertImageToLabelMap - ConvertImageWithLabelsToShapeLabelMap - ConvertLabelMapToImage - ConvertMeshToUnstructeredGrid - ConvertRealAndImaginaryToComplexImage - ConvertSpacialObjectToImage - ConvolveImageWithKernel - CreateAnother - CreateAnotherInstanceOfAnImage - CreateDerivativeKernel - CreateForwardDifferenceKernel - CreateGaussianDerivativeKernel - CreateGaussianDistribution - CreateGaussianKernel - CreateHistogramFromListOfMeasurements - CreateLaplacianKernel - CreateListOfSampleMeasurements - CreateListOfSamplesWithIDs - CreateSobelKernel - CreateVectorImage - CreateVectorImageFromScalarImages - CropImageBySpecifyingRegion - CropImageBySpecifyingRegion2 - CustomOperationToCorrespondingPixelsInTwoImages - CustomOperationToEachPixelInImage - DeepCopyImage - DemonstrateThresholdAlgorithms - DerivativeImage - DirectWarningToFile - DisplayImage - DistanceMap - Ellipse - ErodeBinaryImageUsingFlatStruct - ExhaustiveOptimizer - ExtractBoundariesOfBlobsInBinaryImage - ExtractBoundariesOfConnectedRegionsInBlobsInBinaryImage - ExtractChannelOfImageWithMultipleComponents - ExtractComponentOfVectorImage - ExtractContoursFromImage - ExtractLargestConnectComponentFromBinaryImage - FilterAndParallelizeImageRegion - FilterImage - FilterImageUsingMultipleThreads - FindHigherDerivativeOfImage - FindMaxAndMinInImage - FindZeroCrossings - GaussianBlurImageFunction - GenerateStructureElementsWithAccurateArea - GeometricPropertiesOfRegion - GetOrSetMemberVariableOfITKClass - GlobalRegistrationOfTwoImages - GlobalRegistrationTwoImagesAffine - GlobalRegistrationTwoImagesBSpline - ImageRegionIntersection - IntensityWindowing - InverseOfMaskToImage - InvertImage - InvertImageUsingBinaryNot - IsPixelInsideRegion - IterateOnAVectorContainer - IterateOverSpecificRegion - IterateRegionWithAccessToIndexWithWriteAccess - IterateRegionWithAccessToIndexWithoutWriteAccess - IterateRegionWithNeighborhood - IterateRegionWithWriteAccess - IterateRegionWithoutNeighborhood - JoinImages - KeepBinaryRegionsThatMeetSpecific - KeepRegionsAboveLevel - KeepRegionsThatMeetSpecific - LabelBinaryRegionsAndGetProperties - LabelBinaryRegionsInImage - LabelConnectComponentsInBinaryImage - LabelConnectComponentsInGrayscaleImage - LabelConnectedComponentsInGrayscaleImage - LabelContoursOfConnectedComponent - LineSpacialObject - LineThroughImage - LinearlyInterpolatePositionInImage - MapScalarIntoJetColormap - MaskImage - MaurerDistanceMapOfBinary - MeanDistanceBetweenAllPointsOnTwoCurves - MergeLabelMaps - MiniPipeline - MorphologicalWatershedSegmentation - MultiThreadOilPainting - MultipleInputsOfDifferentType - MultipleOutputsOfDifferentType - MultipleOutputsOfSameType - MultiplyKernelWithAnImageAtLocation - MultiresolutionPyramidFromImage - MutualInformation - MutualInformationAffine - NeighborhoodIteratorOnVectorImage - NormalizeImage - NormalizedCorrelation - NormalizedCorrelationOfMaskedImage - NormalizedCorrelationUsingFFT - NormalizedCorrelationUsingFFTWithMaskImages - OpeningBinaryImage - OverlayLabelMapOnImage - PadAnImageByWrapping - PadImageByWrapping - PassImageToFunction - PermuteSequenceOfIndices - PixelDivisionOfTwoImages - PredefinedOperationToCorrespondingPixelsInTwoImages - PresentImageAfterOperation - ProcessNthComponentOfVectorImage - ProduceImageProgrammatically - PruneBinaryImage - RandomSelectOfPixelsFromRegionWithoutReplace - RandomSelectOfPixelsInRegion - RegionalMaximal - RegionalMinimal - RegisterImageToAnotherUsingLandmarks - RegisterTransformWithTransformFactory - RemoveLabelsFromLabelMap - RequesterRegion - ResampleSegmentedImage - ReturnObjectFromFunction - RunImageFilterOnRegionOfImage - ScaleAnImage - ScalePixelSumToConstant - SegmentPixelsWithSimilarStats - SetOutputPixelToMax - SetOutputPixelToMin - ShapeAttributesForBinaryImage - SharpenImage - ShrinkImage - SmoothImageUsingCurvatureFlow - SmoothImageUsingMinMaxCurvatureFlow - SmoothImageWhilePreservingEdges - SmoothImageWhilePreservingEdges2 - SmoothImageWithDiscreteGaussianFilter - SmoothRGBImageUsingCurvatureFlow - SmoothRGBImageUsingMinMaxCurvatureFlow - SortITKIndex - SpatialSearch - SquareEveryPixel - SquaredDifferenceOfTwoImages - StatisticalPropertiesOfRegions - SubtractConstantFromEveryPixel - SubtractTwoImages - ThinImage - ThrowException - TileImageSideBySide - TransformVectorValuedImagePixels - TranslateAVectorImage - Transparency - ValuedRegionalMaximaImage - ValuedRegionalMinimalImage - ViewComponentVectorImageAsScaleImage - VoronoiDiagram - WatchRegistration - WorkingWithPointAndCellData - WriteAnImage - WriteMeshToVTP - ZeroCrossingBasedEdgeDecor Co-Authored By: Mathew J. Seng <[email protected]> ENH: Remove duplicate GaussianBlurImageFunction The sphinx example was an exact duplicate of the ITK example. STYLE: Remove unused variable warnings. COMP: Future proof vnl_math_XXX function usage. Prefer C++ over aliased names vnl_math_[min|max] -> std::[min|max] Prefer vnl_math::abs over deprecated alias vnl_math_abs In all compilers currently supported by VXL, vnl_math_[min|max] could be replaced with std::[min|max] without loss of functionality. This also circumvents part of the backwards compatibility requirements as vnl_math_ has been recently replaced with a namespace of vnl_math::. Since Wed Nov 14 07:42:48 2012: The vnl_math_* functions use #define aliases to their vnl_math::* counterparts in the "real" vnl_math:: namespace. The new syntax should be backwards compatible to VXL versions as old as 2012. Prefer to use itk::Math:: over vnl_math:: namespace STYLE: Use override statements for C++11 Describe function overrides using the override keyword from C++11. cd ${BLDDIR} run-clang-tidy.py -extra-arg=-D__clang__ -checks=-*,modernize-use-override -header-filter=.* -fix COMP: Use nullptr instead of 0 or NULL The check converts the usage of null pointer constants (eg. NULL, 0) to use the new C++11 nullptr keyword. SRCDIR=/Users/johnsonhj/Dashboard/src/ITK #My local SRC BLDDIR=/Users/johnsonhj/Dashboard/src/ITK-bld/ #My local BLD cd /Users/johnsonhj/Dashboard/src/ITK-bld/ run-clang-tidy.py -extra-arg=-D__clang__ -checks=-*,modernize-use-nullptr -header-filter=.* -fix STYLE: Small spacing change DOC: Better description of example STYLE: Removal of extra spacing STYLE: Removal of extra spacing DOC: Better index description for example DOC: Better index description for example DOC: Better index description for example STYLE: Removal of extra spacing STYLE: Removal of extra spacing DOC: More detailed indexing for example. DOC: More detailed indexing for example. DOC: More detailed indexing for example. DOC: More detailed indexing and results for example. STYLE: Removal of extra spacing STYLE: Removal of extra spacing DOC: More detailed indexing of example DOC: More detailed indexing of example DOC: More detailed indexing of example DOC: More detailed indexing of example DOC: More detailed results for example DOC: More detailed results for example DOC: More detailed results and indexing for example DOC: More detailed results and indexing for example DOC: Fixed punctuation error DOC: Improved indexing for example DOC: Better indexing and results for example DOC: Improved indexing and spacing for example DOC: Improved indexing and description for example DOC: Improved indexing and spacing for example DOC: Improved indexing and spacing for example DOC: Improved results for example DOC: Improved results and indexing for example DOC: Improved results and indexing for example DOC: Improved results and indexing for example DOC: Improved results for example DOC: Improved results and indexing for examples DOC: Improved indexing for examples DOC: Improved indexing for examples DOC: Improved indexing and results for example DOC: Improved indexing for example DOC: Improved indexing for example DOC: Improved indexing for example DOC: Improved indexing and results for examples DOC: Improved indexing for examples DOC: Improved indexing for examples DOC: Improved indexing and spacing for ImageAdaptor examples DOC: Improved results for example DOC: Improved index for example DOC: Improved index for example DOC: Improved index for example DOC: Improved index for example DOC: Improved index and results for examples DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results and indexing for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results and indexing for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results and indexing for example DOC: Improved results and indexing for example DOC: Improved results and indexing for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for examples DOC: Improved indexing for example DOC: Improved indexing for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example DOC: Improved results for example ENH: Remove .txt from Girder images DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve Indexing for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results and indexing for example DOC: Improve results for example DOC: Improve results for example DOC: Improve results and indexing for example DOC: Improve description and indexing for example DOC: Improve indexing for example DOC: Small improvements for indexing and results in examples DOC: Small improvements for indexing in example DOC: Small improvements for indexing and results in example DOC: Small improvements for indexing and results in example DOC: Small improvements for results in example ENH: itkMessageLog added to DirectWarningToFile example ENH: Proper output for IterateWithNeighborhoodWithoutAccess example ENH: Proper output for MersenneTwisterRandomIntegerGenerator example ENH: Proper output for MersenneTwisterRandomNumberGenerator example ENH: Proper output for Transparency example ENH: Proper output for WorkingWithPointAndCellData example ENH: Add correlation.mha to NormalizedCorrelationOfMaskedImage example ENH: Add correlation.mha to NormalizedCorrelationUsingFFT example ENH: Add correlation.mha to NormalizedCorrelationUsingFFTWithMaskImages example ENH: Add input and output mhd files and renamed ComputerLocalNoise example ENH: Add input and output mhd files for KeepBinaryRegionsThatMeetSpecific example ENH: Add results to CreateListOfSamplesFromImageWithoutDuplication example DOC: Rescale of AbsValueOfTwoImages example STYLE: Small punctuation change. DOC: Spacing change for proper result format DOC: Spacing change for proper result format DOC: Spacing change for proper result format DOC: Proper image scale for example DOC: Proper image scale for example DOC: Removal of results due to no output DOC: Removal of results due to no output DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Proper scale of images in results DOC: Improve indexing for example DOC: Improve indexing and scaling of results for example DOC: Improve indexing and scaling of results for example DOC: Improve indexing and scaling of results for example DOC: Improve indexing and scaling of results for example DOC: Improve indexing and scaling of results for example DOC: Improve indexing and scaling of results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Improve scaling of images in results for example DOC: Minor changes to indexing and punctuation. Removal of .txt from Girder images DOC: Small changes to indexing and punctuation STYLE: Removal of .txt from Girder images
1 parent 17d6c6f commit dc2d293

File tree

487 files changed

+3063
-1297
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

487 files changed

+3063
-1297
lines changed

‎src/Compatibility/Deprecated/ResampleITKVectorImage/Documentation.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Results
1919
Implementation of Results for sphinx examples containing this message.
2020
Reconfiguration of CMakeList.txt may be necessary.
2121
`Write An Example <https://itk.org/ITKExamples/Documentation/Contribute/WriteANewExample.html`>
22+
2223
Code
2324
----
2425

‎src/Compatibility/Deprecated/ResampleRGBImage/Documentation.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Resample RGB Image
44
.. index::
55
single: VectorResampleImageFilter
66
single: RGB
7+
single: resampling
78

89
Synopsis
910
--------

‎src/Core/Common/AddNoiseToBinaryImage/AddNoiseToBinaryImage.png.sha512‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
55051f7beed90c8d71e75e7a5d7c19c87f2082fe7bed49017fa3079c512780c6467266a108b541970d52ffb3ab56af2ed450644b604c2905fe51b08f516daa6e

‎src/Core/Common/AddNoiseToBinaryImage/Documentation.rst‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,20 @@ Add noise to a binary image.
1414

1515
Results
1616
-------
17-
.. note::
18-
**Help Wanted**
19-
Implementation of Results for sphinx examples containing this message.
20-
Reconfiguration of CMakeList.txt may be necessary.
21-
`Write An Example <https://itk.org/ITKExamples/Documentation/Contribute/WriteANewExample.html`>
17+
.. figure:: Yinyang.png
18+
:scale: 60%
19+
:alt: Input.png
20+
21+
Input image.
22+
23+
.. figure:: AddNoiseToBinaryImage.png
24+
:scale: 60%
25+
:alt: Output.png
26+
27+
Output image.
28+
Output::
29+
30+
Number of random samples: 105062
2231

2332
Code
2433
----

‎src/Core/Common/AddNoiseToBinaryImage/Yinyang.png.sha512‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
14b645d89824bf4c084f1e9daa88b4049b5ff984d2ce900e9208b442d71c4181a834699e94bd58b78a2ecb45e56e65b863dbea057b744f7aef5550b7a0bf3c8b

‎src/Core/Common/AddOffsetToIndex/Documentation.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Synopsis
99
--------
1010

1111

12-
Add an offset to a pixel index
12+
Add an offset to a pixel index.
1313

1414

1515
Results

‎src/Core/Common/BoundingBoxOfAPointSet/Documentation.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Results
1717

1818

1919
Output::
20+
2021
bounds: [0, 0.1, 0, 0.1, 0, 0]
2122
center: [0.05, 0.05, 0]
2223
diagonal length squared: 0.02

‎src/Core/Common/BresenhamLine/Documentation.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,8 @@ Synopsis
99

1010
Get the points on a Bresenham line between two points.
1111

12-
1312
Results
1413
-------
15-
1614
Output::
1715

1816
[0, 0]

‎src/Core/Common/CMakeLists.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,3 +353,8 @@ add_example(DisplayImage)
353353
compare_to_baseline(EXAMPLE_NAME DisplayImage
354354
BASELINE_PREFIX OutputBaseline
355355
)
356+
357+
add_example(DirectWarningToFile)
358+
compare_to_baseline(EXAMPLE_NAME DirectWarningToFile
359+
BASELINE_PREFIX OutputBaseline
360+
)

‎src/Core/Common/CastVectorImageToAnotherType/Code.cxx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#include "itkVectorImage.h"
1919
#include "itkCastImageFilter.h"
2020

21-
int main(int argc, char *argv[])
21+
int main(int /*argc*/, char * /*argv*/[])
2222
{
2323
typedef itk::VectorImage<unsigned char, 2> UnsignedCharVectorImageType;
2424
typedef itk::VectorImage<float, 2> FloatVectorImageType;

0 commit comments

Comments
 (0)