ENH: Add ability to specify if NumberOfThreads is required.

Select the patch that renames NumberOfThreads to NumberOfWorkUnits.
Use a cmake driven option to indicate which code spelling should
be used.

Author: hjmjohnson

CMakeLists.txt

@@ -45,6 +45,14 @@ if(NOT ITK_SOURCE_DIR)
     set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
   endif()
 
+project(PerformanceBenchmarking)
+
+option(ITK_USES_NUMBEROFTHREADS "If ITKv5 uses NumberOfThreads (not NumberOfWorkUnits" OFF)
+
+set(PerformanceBenchmarking_LIBRARIES PerformanceBenchmarking)
+
+include_directories(${CMAKE_BINARY_DIR})
+if(NOT ITK_SOURCE_DIR)
   include(ITKModuleExternal)
 else()
   set(ITK_DIR ${CMAKE_BINARY_DIR})

evaluate-itk-performance.py

@@ -43,7 +43,7 @@ def __call__(self, parser, namespace, values, option_string=None):
         help='ITK performance benchmarks build directory', action = FullPaths)
 run_parser.add_argument('-r', '--rev-list',
         help='Arguments for "git rev-list" to select the range of commits to benchmark, for example: "--first-parent v4.10.0..v5.0rc1"',
-        default='--no-merges HEAD~1..')
+        default='--first-parent HEAD~1..')
 
 upload_parser = subparsers.add_parser('upload',
         help='upload the benchmarks to data.kitware.com')
@@ -154,20 +154,41 @@ def check_for_build_information(itk_src):
         has_itkbuildinformation = True
     return has_itkbuildinformation
 
+# 2075084be6f9988b1ae2231bca607830fe6d772b is sha1 that rename NumberOfThreads into NumberOfWorkUnits in filters
+# Author: Dzenan Zukic <[email protected]>
+# Date:   Tue Jul 17 19:30:02 2018
+# so all ancestors need to prevent the benchmarking from using
+def check_for_NumberOfThreads(itk_src):
+    os.chdir(itk_src)
+    try:
+        cmd = ['git', 'merge-base',
+            '--is-ancestor', 'HEAD',
+            '2075084be6f9988b1ae2231bca607830fe6d772b']
+        has_itkNumberOfThreads = not bool(subprocess.check_call( cmd ) )
+    except subprocess.CalledProcessError:
+        has_itkNumberOfThreads = False
+    return has_itkNumberOfThreads
+
 def build_benchmarks(benchmark_src, benchmark_bin,
         itk_bin,
-        itk_has_buildinformation):
+        itk_has_buildinformation,
+        itk_has_NumberOfThreads):
     os.chdir(benchmark_bin)
     if itk_has_buildinformation:
         build_information_arg = '-DITK_HAS_INFORMATION_H:BOOL=ON'
     else:
         build_information_arg = '-DITK_HAS_INFORMATION_H:BOOL=OFF'
+    if itk_has_NumberOfThreads:
+        NumberOfThreads_arg = '-DITK_USES_NUMBEROFTHREADS:BOOL=ON'
+    else:
+        NumberOfThreads_arg = '-DITK_USES_NUMBEROFTHREADS:BOOL=OFF'
     subprocess.check_call(['cmake',
         '-G', 'Ninja',
         '-DCMAKE_BUILD_TYPE:STRING=Release',
         '-DCMAKE_CXX_STANDARD:STRING=17',
         '-DITK_DIR:PATH=' + itk_bin,
         build_information_arg,
+        NumberOfThreads_arg,
         benchmark_src])
     subprocess.check_call(['ninja'])
 
@@ -328,10 +349,11 @@ def has_sha(filepath):
         build_itk(args.src, args.bin)
 
         itk_has_buildinformation = check_for_build_information(args.src)
+        itk_has_NumberOfThreads = check_for_NumberOfThreads(args.src)
 
         print('\nBuilding benchmarks...')
         build_benchmarks(benchmark_src, args.benchmark_bin, args.bin,
-                itk_has_buildinformation)
+                itk_has_buildinformation, itk_has_NumberOfThreads)
 
         print('\nRunning benchmarks...')
         run_benchmarks(args.benchmark_bin, itk_information)

include/PerformanceBenchmarkingUtilities.h

@@ -5,20 +5,20 @@
 #ifndef PerformanceBenchmarkingUtilities_h
 #define PerformanceBenchmarkingUtilities_h
 
-#include "PerformanceBenchmarkingExport.h"
+#include "PerformanceBenchmarkingInformation.h"
 
 #include "jsonxx.h"
 #include <ctime> //TODO:  Move to utiliites
 #include "itkHighPriorityRealTimeProbesCollector.h"
 
-#if ITK_VERSION_MAJOR >= 5
-#  include "itkMultiThreaderBase.h"
-using MultiThreaderName = itk::MultiThreaderBase;
-#  define SET_PARALLEL_UNITS(x) SetNumberOfWorkUnits(x)
-#else
-#  include "itkMultiThreader.h"
+#if ITK_VERSION_MAJOR < 5 || defined(ITK_USES_NUMBEROFTHREADS)
+#include "itkMultiThreader.h"
 using MultiThreaderName = itk::MultiThreader;
-#  define SET_PARALLEL_UNITS(x) SetNumberOfThreads(x)
+#define SET_PARALLEL_UNITS( x ) SetNumberOfThreads( x )
+#else
+#include "itkMultiThreaderBase.h"
+using MultiThreaderName = itk::MultiThreaderBase;
+#define SET_PARALLEL_UNITS( x ) SetNumberOfWorkUnits( x )
 #endif
 
 PerformanceBenchmarking_EXPORT std::string

src/PerformanceBenchmarkingInformation.h.in

@@ -30,6 +30,8 @@
 
 #include "PerformanceBenchmarkingExport.h"
 
+#cmakedefine ITK_USES_NUMBEROFTHREADS
+
 
 namespace itk
 {