CurvilinearArraySpecialCoordinatesImage's wrapping does not compile

[dzenanz]

Build error I run into:

Build started...
1>------ Build started: Project: castxml, Configuration: RelWithDebInfo x64 ------
2>------ Build started: Project: ITKData, Configuration: RelWithDebInfo x64 ------
3>------ Build started: Project: swig, Configuration: RelWithDebInfo x64 ------
4>------ Build started: Project: ClangFormat, Configuration: RelWithDebInfo x64 ------
5>------ Build started: Project: UltrasoundHeaderTestClean, Configuration: RelWithDebInfo x64 ------
6>------ Skipped Build: Project: Continuous, Configuration: RelWithDebInfo x64 ------
6>Project not selected to build for this solution configuration 
7>------ Skipped Build: Project: Experimental, Configuration: RelWithDebInfo x64 ------
7>Project not selected to build for this solution configuration 
8>------ Skipped Build: Project: Nightly, Configuration: RelWithDebInfo x64 ------
8>Project not selected to build for this solution configuration 
9>------ Skipped Build: Project: NightlyMemoryCheck, Configuration: RelWithDebInfo x64 ------
9>Project not selected to build for this solution configuration 
10>------ Skipped Build: Project: RUN_TESTS, Configuration: RelWithDebInfo x64 ------
10>Project not selected to build for this solution configuration 
11>------ Build started: Project: UltrasoundCastXML, Configuration: RelWithDebInfo x64 ------
12>------ Build started: Project: UltrasoundSwig, Configuration: RelWithDebInfo x64 ------
13>------ Skipped Build: Project: ITKHeaderTests, Configuration: RelWithDebInfo x64 ------
13>Project not selected to build for this solution configuration 
14>------ Build started: Project: UltrasoundPython, Configuration: RelWithDebInfo x64 ------
14>itkCurvilinearArraySpecialCoordinatesImagePython.cpp
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(151520,76): error C2672: 'itk::CurvilinearArraySpecialCoordinatesImage<float,2>::TransformPhysicalPointToContinuousIndex': no matching overloaded function found
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(151520,76): error C2783: 'itk::ContinuousIndex<TIndexRep,2> itk::CurvilinearArraySpecialCoordinatesImage<float,2>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,2> &) const': could not deduce template argument for 'TIndexRep'
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(244): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<float,2>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(151520,143): error C2780: 'bool itk::CurvilinearArraySpecialCoordinatesImage<float,2>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,2> &,itk::ContinuousIndex<TIndexRep,2> &) const': expects 2 arguments - 1 provided
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(194): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<float,2>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(152266,76): error C2672: 'itk::CurvilinearArraySpecialCoordinatesImage<float,3>::TransformPhysicalPointToContinuousIndex': no matching overloaded function found
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(152266,76): error C2783: 'itk::ContinuousIndex<TIndexRep,3> itk::CurvilinearArraySpecialCoordinatesImage<float,3>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,3> &) const': could not deduce template argument for 'TIndexRep'
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(244): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<float,3>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(152266,143): error C2780: 'bool itk::CurvilinearArraySpecialCoordinatesImage<float,3>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,3> &,itk::ContinuousIndex<TIndexRep,3> &) const': expects 2 arguments - 1 provided
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(194): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<float,3>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(153012,77): error C2672: 'itk::CurvilinearArraySpecialCoordinatesImage<short,2>::TransformPhysicalPointToContinuousIndex': no matching overloaded function found
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(153012,77): error C2783: 'itk::ContinuousIndex<TIndexRep,2> itk::CurvilinearArraySpecialCoordinatesImage<short,2>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,2> &) const': could not deduce template argument for 'TIndexRep'
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(244): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<short,2>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(153012,144): error C2780: 'bool itk::CurvilinearArraySpecialCoordinatesImage<short,2>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,2> &,itk::ContinuousIndex<TIndexRep,2> &) const': expects 2 arguments - 1 provided
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(194): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<short,2>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(153758,77): error C2672: 'itk::CurvilinearArraySpecialCoordinatesImage<short,3>::TransformPhysicalPointToContinuousIndex': no matching overloaded function found
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(153758,77): error C2783: 'itk::ContinuousIndex<TIndexRep,3> itk::CurvilinearArraySpecialCoordinatesImage<short,3>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,3> &) const': could not deduce template argument for 'TIndexRep'
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(244): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<short,3>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(153758,144): error C2780: 'bool itk::CurvilinearArraySpecialCoordinatesImage<short,3>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,3> &,itk::ContinuousIndex<TIndexRep,3> &) const': expects 2 arguments - 1 provided
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(194): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<short,3>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(154504,77): error C2672: 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,2>::TransformPhysicalPointToContinuousIndex': no matching overloaded function found
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(154504,77): error C2783: 'itk::ContinuousIndex<TIndexRep,2> itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,2>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,2> &) const': could not deduce template argument for 'TIndexRep'
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(244): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,2>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(154504,144): error C2780: 'bool itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,2>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,2> &,itk::ContinuousIndex<TIndexRep,2> &) const': expects 2 arguments - 1 provided
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(194): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,2>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(155250,77): error C2672: 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,3>::TransformPhysicalPointToContinuousIndex': no matching overloaded function found
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(155250,77): error C2783: 'itk::ContinuousIndex<TIndexRep,3> itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,3>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,3> &) const': could not deduce template argument for 'TIndexRep'
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(244): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,3>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(155250,144): error C2780: 'bool itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,3>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,3> &,itk::ContinuousIndex<TIndexRep,3> &) const': expects 2 arguments - 1 provided
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(194): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned char,3>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(155996,77): error C2672: 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,2>::TransformPhysicalPointToContinuousIndex': no matching overloaded function found
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(155996,77): error C2783: 'itk::ContinuousIndex<TIndexRep,2> itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,2>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,2> &) const': could not deduce template argument for 'TIndexRep'
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(244): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,2>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(155996,144): error C2780: 'bool itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,2>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,2> &,itk::ContinuousIndex<TIndexRep,2> &) const': expects 2 arguments - 1 provided
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(194): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,2>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(156742,77): error C2672: 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,3>::TransformPhysicalPointToContinuousIndex': no matching overloaded function found
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(156742,77): error C2783: 'itk::ContinuousIndex<TIndexRep,3> itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,3>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,3> &) const': could not deduce template argument for 'TIndexRep'
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(244): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,3>::TransformPhysicalPointToContinuousIndex'
14>C:\Dev\ITKUltrasound-2019\Wrapping\Modules\Ultrasound\itkCurvilinearArraySpecialCoordinatesImagePython.cpp(156742,144): error C2780: 'bool itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,3>::TransformPhysicalPointToContinuousIndex(const itk::Point<TCoordRep,3> &,itk::ContinuousIndex<TIndexRep,3> &) const': expects 2 arguments - 1 provided
14>C:\Dev\ITKUltrasound\include\itkCurvilinearArraySpecialCoordinatesImage.h(194): message : see declaration of 'itk::CurvilinearArraySpecialCoordinatesImage<unsigned short,3>::TransformPhysicalPointToContinuousIndex'
14>itkFrequencyDomain1DFilterFunctionPython.cpp
14>itkTimeGainCompensationImageFilterPython.cpp
14>Generating Code...
14>Done building project "UltrasoundPython.vcxproj" -- FAILED.
15>------ Skipped Build: Project: INSTALL, Configuration: RelWithDebInfo x64 ------
15>Project not selected to build for this solution configuration 
========== Build: 7 succeeded, 1 failed, 6 up-to-date, 7 skipped ==========

[tbirdso]

Verified that I am able to reproduce the same issue on my Linux machine building against the main branches of ITK and ITKUltrasound.

[dzenanz]

Could this be related to #172?

[tbirdso]

Potentially, as FFT factory methods are arguably the biggest structural change from RC2 to RC3. I'm not sure how TransformPhysicalPointToContinuousIndex argument mismatches here would fit in though.

[tbirdso]

@dzenanz FYI this is still on my radar but I've had trouble making time for significant investigation so far other than verifying reproducibility. If you have the bandwidth to take the lead on this I can weigh in and answer questions, otherwise it will probably be at least another week before I can make significant headway here.

[tbirdso]

Found where we seem to be doing special handling of member template functions in ImageBase in ITK's pyBase.i. Guessing we will need to introduce similar handling here in ITKUltrasound to get the wrapping behavior we want for CurvilinearArraySpecialCoordinatesImage, though I'm still not clear on why wrapping previously succeeded and fails with the most recent pre-release.

[dzenanz]

That's a good find. I had no idea why it was failing 😄

It would be good if you tackled this on Monday.

[tbirdso]

Still having trouble working with SWIG to explicitly define member function specializations. I'm confident that the .i file I've added is being referenced by SWIG (when I add bad syntax I get errors). However, function overrides do not appear in SWIG-generated cxx files.

I'm wondering if there is a difference in how ITK proper vs remote modules need to handle their SWIG variable names and wrapping functions, as it seems like there are some differences between the two. For instance, in a similar block in itkImagePython.cpp in ITK proper:

result = itkImageBase2_TransformPhysicalPointToContinuousIndex(arg1,*arg2);

Equivalent in ITKUltrasound, which throws a compile-time error because TransformPhysicalPointToContinuousIndex requires a template argument:

result = ((itkCurvilinearArraySpecialCoordinatesImageF2 const *)arg1)->TransformPhysicalPointToContinuousIndex((itkPointD2 const &)*arg2);

@thewtex @dzenanz Do you know of any external modules doing advanced wrapping with their own .i files that I may be able to reference for this fix? Will try to add changes for reference in #173, but dependency on #161 for v5.3rc03 compatibility makes it a bit difficult to highlight changes related to this issue at the moment.

[dzenanz]

external modules doing advanced wrapping with their own .i files

My first two guesses were https://github.com/SimonRit/RTK and https://github.com/InsightSoftwareConsortium/LesionSizingToolkit. But neither seems to have .i files. Maybe Matt knows of an example? But most likely, there is none. I think you will be making precedent 😄

[tbirdso]

Digging in even deeper, the code for ImageBase member function template specialization is defined in pyBase.i:

%define DECL_PYTHON_IMAGEBASE_CLASS(swig_name, template_params)
    %inline %{
    #include "itkContinuousIndexSwigInterface.h"
    %}
    %rename(__SetDirection_orig__) swig_name::SetDirection;
    %extend swig_name {
        itkIndex##template_params TransformPhysicalPointToIndex( itkPointD##template_params & point ) {
            itkIndex##template_params idx;
            self->TransformPhysicalPointToIndex<double>( point, idx );
            return idx;
         }
    ...

The parameters for that function are passed in itk_wrap_simple_type_python in ITK/Wrapping/Generators/Python/CMakeLists.txt:

  if("${cpp_name}" STREQUAL "itk::ImageBase" AND NOT "${swig_name}" MATCHES "Pointer$")
    # add the templated method non seen by gccxml, in a more python-friendly way
    # than the c++ version
    ADD_PYTHON_OUTPUT_RETURN_BY_VALUE_CLASS("${swig_name}" "GetBufferedRegion")
    ADD_PYTHON_OUTPUT_RETURN_BY_VALUE_CLASS("${swig_name}" "GetLargestPossibleRegion")
    ADD_PYTHON_OUTPUT_RETURN_BY_VALUE_CLASS("${swig_name}" "GetRequestedRegion")
    set(ITK_WRAP_PYTHON_SWIG_EXT "${ITK_WRAP_PYTHON_SWIG_EXT}DECL_PYTHON_IMAGEBASE_CLASS(${swig_name}, ${template_params})\n")
    set(ITK_WRAP_PYTHON_SWIG_EXT "${ITK_WRAP_PYTHON_SWIG_EXT}%inline %{\n")
    set(ITK_WRAP_PYTHON_SWIG_EXT "${ITK_WRAP_PYTHON_SWIG_EXT}#include \"itkContinuousIndexSwigInterface.h\"\n")
    set(ITK_WRAP_PYTHON_SWIG_EXT "${ITK_WRAP_PYTHON_SWIG_EXT}%}\n")
  endif()

From testing it looks like external modules do set the ITK_WRAP_PYTHON_SWIG_EXT variable but I'm unclear on the extent to which this can impact wrapping.

@thewtex when you get a chance could you please weigh in on the CMake/SWIG architecture for ITK vs remote modules? Wondering whether we will need to expose functionality in ITK for this to succeed, but I'm far from confident in my CMake tracing here.