Skip to content

Commit 3190a58

Browse files
committed
DOC: Rename folder directories
Many of the example's folder names differ from the headers in their respective Documentation.rst. In order to help facilitate the alphabetical ordering of these examples on Sphinx, this will make the headers (which are shown on Sphinx) nearly identical to their folder name. Thus, when we look to add new examples in an index.rst, we can order them alphebetically by folder name which will help the save time for the developer.
1 parent c806da3 commit 3190a58

File tree

83 files changed

+305
-306
lines changed

Some content is hidden

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

83 files changed

+305
-306
lines changed

src/Core/Common/CMakeLists.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ add_example(Matrix)
7676
add_example(MatrixInverse)
7777
add_example(VariableLengthVector)
7878
add_example(BresenhamLine)
79-
add_example(Transparency)
80-
compare_to_baseline(EXAMPLE_NAME Transparency
81-
BASELINE_PREFIX Transparency
79+
add_example(MakePartOfImageTransparent)
80+
compare_to_baseline(EXAMPLE_NAME MakePartOfImageTransparent
81+
BASELINE_PREFIX MakePartOfImageTransparent
8282
)
8383

8484
add_example(ConvertArrayToImage)
@@ -87,7 +87,7 @@ compare_to_baseline(EXAMPLE_NAME ConvertArrayToImage
8787
)
8888

8989
add_example(CropImageBySpecifyingRegion)
90-
add_example(CustomOperationToEachPixelInImage)
90+
add_example(ApplyCustomOperationToEachPixelInImage)
9191
add_example(CreateVectorImage)
9292
add_example(NeighborhoodIteratorOnVectorImage)
9393
add_example(IterateOverSpecificRegion)
@@ -199,9 +199,9 @@ compare_to_baseline(EXAMPLE_NAME IterateRegionWithWriteAccess
199199
BASELINE_PREFIX IterateRegionWithWriteAccess
200200
)
201201

202-
add_example(OutOfBoundsPixelsReturnConstValue)
203-
compare_to_baseline(EXAMPLE_NAME OutOfBoundsPixelsReturnConstValue
204-
BASELINE_PREFIX OutOfBoundsPixelsReturnConstValue
202+
add_example(MakeOutOfBoundsPixelsReturnConstValue)
203+
compare_to_baseline(EXAMPLE_NAME MakeOutOfBoundsPixelsReturnConstValue
204+
BASELINE_PREFIX MakeOutOfBoundsPixelsReturnConstValue
205205
)
206206
endif()
207207

src/Core/Common/CreateAnImageRegion/Documentation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Create A Image Region
2-
=====================
1+
Create An Image Region
2+
======================
33

44
.. index::
55
single: ImageRegion

src/Core/Common/DistanceBetweenIndices/Documentation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Distance Between Points
2-
=======================
1+
Distance Between Indices
2+
========================
33

44
.. index::
55
single: Point

src/Core/Common/OutOfBoundsPixelsReturnConstValue/CMakeLists.txt renamed to src/Core/Common/MakeOutOfBoundsPixelsReturnConstValue/CMakeLists.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
cmake_minimum_required(VERSION 3.10.2)
22

3-
project(OutOfBoundsPixelsReturnConstValue)
3+
project(MakeOutOfBoundsPixelsReturnConstValue)
44

55
find_package(ITK REQUIRED)
66
include(${ITK_USE_FILE})
@@ -17,28 +17,28 @@ if(VTK_VERSION VERSION_LESS "8.90.0")
1717
include(${VTK_USE_FILE})
1818
endif()
1919

20-
add_executable(OutOfBoundsPixelsReturnConstValue Code.cxx)
21-
target_link_libraries(OutOfBoundsPixelsReturnConstValue ${ITK_LIBRARIES} ${VTK_LIBRARIES})
20+
add_executable(MakeOutOfBoundsPixelsReturnConstValue Code.cxx)
21+
target_link_libraries(MakeOutOfBoundsPixelsReturnConstValue ${ITK_LIBRARIES} ${VTK_LIBRARIES})
2222

2323
if(NOT VTK_VERSION VERSION_LESS "8.90.0")
2424
vtk_module_autoinit(
25-
TARGETS OutOfBoundsPixelsReturnConstValue
25+
TARGETS MakeOutOfBoundsPixelsReturnConstValue
2626
MODULES ${VTK_LIBRARIES}
2727
)
2828
endif()
2929

30-
install(TARGETS OutOfBoundsPixelsReturnConstValue
30+
install(TARGETS MakeOutOfBoundsPixelsReturnConstValue
3131
DESTINATION bin/ITKExamples/Core/Common
3232
COMPONENT Runtime
3333
)
3434

3535
install(FILES Code.cxx CMakeLists.txt
36-
DESTINATION share/ITKExamples/Code/Core/Common/OutOfBoundsPixelsReturnConstValue/
36+
DESTINATION share/ITKExamples/Code/Core/Common/MakeOutOfBoundsPixelsReturnConstValue/
3737
COMPONENT Code
3838
)
3939

4040

4141
enable_testing()
42-
add_test(NAME OutOfBoundsPixelsReturnConstValueTest
43-
COMMAND ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/OutOfBoundsPixelsReturnConstValue)
42+
add_test(NAME MakeOutOfBoundsPixelsReturnConstValueTest
43+
COMMAND ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/MakeOutOfBoundsPixelsReturnConstValue)
4444

src/Core/Common/OutOfBoundsPixelsReturnConstValue/Documentation.rst renamed to src/Core/Common/MakeOutOfBoundsPixelsReturnConstValue/Documentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Make out of bounds pixels return a constant value.
1313

1414
Results
1515
-------
16-
.. figure:: OutOfBoundsPixelsReturnConstValue.png
16+
.. figure:: MakeOutOfBoundsPixelsReturnConstValue.png
1717
:scale: 70%
1818
:alt: VTK Window
1919

0 commit comments

Comments
 (0)