ENH: Register default curvilinear FFT factory overrides

Leverages ITK Python factory updates introduced in 10320a6 to initialize
default backends to run FFT on
`itk::CurvilinearArraySpecialCoordinatesImage` objects. Includes
additional wrappings for image inputs.

Closes issue #172.

Author: tbirdso

include/itkCurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory.h

@@ -0,0 +1,80 @@
+/*=========================================================================
+ *
+ *  Copyright NumFOCUS
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0.txt
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *=========================================================================*/
+#ifndef itkCurvilinearFFTImageFilterInitFactory_h
+#define itkCurvilinearFFTImageFilterInitFactory_h
+#include "UltrasoundExport.h"
+
+#include "itkLightObject.h"
+
+namespace itk
+{
+/**
+ *\class CurvilinearFFTImageFilterInitFactory
+ * \brief Initialize FFT image filter factory backends.
+ *
+ * The purpose of CurvilinearFFTImageFilterInitFactory is to perform
+ * one-time registration of factory objects that handle
+ * creation of FFT image filter classes as applied to
+ * CurvilinearArraySpecialCoordinatesImage objects
+ * through the ITK object factory singleton mechanism.
+ *
+ * By default ITK registers Vnl FFT backends to operate on
+ * rectangular `itk::Image` inputs and outputs. ITKUltrasound
+ * expands default availability to apply FFTs to
+ * curvilinear images.
+ *
+ * \ingroup FourierTransform
+ * \ingroup ITKFFT
+ * \ingroup ITKSystemObjects
+ * \ingroup Ultrasound
+ */
+class Ultrasound_EXPORT CurvilinearFFTImageFilterInitFactory : public LightObject
+{
+public:
+  ITK_DISALLOW_COPY_AND_MOVE(CurvilinearFFTImageFilterInitFactory);
+
+  /** Standard class type aliases. */
+  using Self = CurvilinearFFTImageFilterInitFactory;
+  using Superclass = LightObject;
+  using Pointer = SmartPointer<Self>;
+  using ConstPointer = SmartPointer<const Self>;
+
+  /** Method for class instantiation. */
+  itkFactorylessNewMacro(Self);
+
+  /** Run-time type information (and related methods). */
+  itkTypeMacro(CurvilinearFFTImageFilterInitFactory, LightObject);
+
+  /** Mimic factory interface for Python initialization  */
+  static void
+  RegisterOneFactory()
+  {
+    RegisterFactories();
+  }
+
+  /** Register all Curvilinear FFT factories */
+  static void
+  RegisterFactories();
+
+protected:
+  CurvilinearFFTImageFilterInitFactory();
+  ~CurvilinearFFTImageFilterInitFactory() override = default;
+};
+} // end namespace itk
+
+#endif // itkCurvilinearFFTImageFilterInitFactory_h

include/itkCurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory.h

@@ -29,6 +29,8 @@ itk_module(Ultrasound
     ITKTestKernel
     ITKVideoCore
     ITKVideoIO
+  FACTORY_NAMES
+    "FFTImageFilterInit::Curvilinear"
   EXCLUDE_FROM_DEFAULT
   ENABLE_SHARED
   DESCRIPTION

include/itkCurvilinearFFTImageFilterInitFactory.h

@@ -1,4 +1,5 @@
 set(Ultrasound_SRCS
+  itkCurvilinearFFTImageFilterInitFactory.cxx
   itkHDF5UltrasoundImageIOFactory.cxx
   itkHDF5UltrasoundImageIO.cxx
   itkTextProgressBarCommand.cxx

itk-module.cmake

@@ -0,0 +1,61 @@
+/*=========================================================================
+ *
+ *  Copyright NumFOCUS
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0.txt
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *=========================================================================*/
+#include "UltrasoundExport.h"
+
+#include "itkObjectFactoryBase.h"
+#include "itkFFTImageFilterFactory.h"
+#include "itkVnlComplexToComplex1DFFTImageFilter.h"
+#include "itkVnlForward1DFFTImageFilter.h"
+#include "itkVnlInverse1DFFTImageFilter.h"
+
+#include "itkCurvilinearArraySpecialCoordinatesImage.h"
+#include "itkCurvilinearFFTImageFilterInitFactory.h"
+
+namespace itk
+{
+CurvilinearFFTImageFilterInitFactory::CurvilinearFFTImageFilterInitFactory()
+{
+  CurvilinearFFTImageFilterInitFactory::RegisterFactories();
+}
+
+void
+CurvilinearFFTImageFilterInitFactory::RegisterFactories()
+{
+  // Curvilinear -> Curvilinear
+  itk::ObjectFactoryBase::RegisterFactory(FFTImageFilterFactory<VnlComplexToComplex1DFFTImageFilter,
+                                                                itk::CurvilinearArraySpecialCoordinatesImage,
+                                                                itk::CurvilinearArraySpecialCoordinatesImage>::New());
+  itk::ObjectFactoryBase::RegisterFactory(
+    FFTImageFilterFactory<VnlForward1DFFTImageFilter, itk::CurvilinearArraySpecialCoordinatesImage, itk::CurvilinearArraySpecialCoordinatesImage>::New());
+  itk::ObjectFactoryBase::RegisterFactory(
+    FFTImageFilterFactory<VnlInverse1DFFTImageFilter, itk::CurvilinearArraySpecialCoordinatesImage, itk::CurvilinearArraySpecialCoordinatesImage>::New());
+  // Curvilinear -> Image
+  itk::ObjectFactoryBase::RegisterFactory(FFTImageFilterFactory<VnlForward1DFFTImageFilter, itk::CurvilinearArraySpecialCoordinatesImage, itk::Image>::New());
+  // Image -> Curvilinear
+  itk::ObjectFactoryBase::RegisterFactory(FFTImageFilterFactory<VnlInverse1DFFTImageFilter, itk::Image, itk::CurvilinearArraySpecialCoordinatesImage>::New());
+}
+
+// Undocumented API used to register during static initialization.
+// DO NOT CALL DIRECTLY.
+void Ultrasound_EXPORT
+CurvilinearFFTImageFilterInitFactoryRegister__Private()
+{
+  CurvilinearFFTImageFilterInitFactory::RegisterFactories();
+}
+
+} // end namespace itk