ENH: Add curvilinear image factory manual registration for testing

KitwareMedical · Feb 7, 2022 · 8dfad42 · 8dfad42
1 parent 382b074
commit 8dfad42
Show file tree

Hide file tree

Showing 3 changed files with 243 additions and 0 deletions.
diff --git a/include/itkCurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory.h b/include/itkCurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory.h
@@ -0,0 +1,119 @@
+/*=========================================================================
+ *
+ *  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 itkCurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory_h
+#define itkCurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory_h
+
+#include "itkImage.h"
+#include "itkCurvilinearArraySpecialCoordinatesImage.h"
+
+#include "itkFFTImageFilterFactory.h"
+#include "itkObjectFactoryBase.h"
+#include "itkVersion.h"
+
+namespace itk
+{
+/** \class CurvilinearArraySpecialCoordinatesFFTImageFilterFactory
+ *
+ * \brief Object Factory implementation for FFT filters
+ *
+ * \sa CurvilinearArraySpecialCoordinatesImage
+ * \sa itkFFTImageFilterFactory
+ *
+ * \ingroup FourierTransform
+ * \ingroup ITKFFT
+ * \ingroup Ultrasound
+ */
+template <template <typename, typename> class TFFTImageFilter>
+class CurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory : public itk::ObjectFactoryBase
+{
+public:
+  ITK_DISALLOW_COPY_AND_MOVE(CurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory);
+
+  using Self = CurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory;
+  using Superclass = ObjectFactoryBase;
+  using Pointer = SmartPointer<Self>;
+  using ConstPointer = SmartPointer<const Self>;
+
+  /** Class methods used to interface with the registered factories. */
+  const char *
+  GetITKSourceVersion() const override
+  {
+    return ITK_SOURCE_VERSION;
+  }
+  const char *
+  GetDescription() const override
+  {
+    return "An FFTImageFilter factory";
+  }
+
+  /** Method for class instantiation. */
+  itkFactorylessNewMacro(Self);
+
+  /** Run-time type information (and related methods). */
+  itkTypeMacro(CurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory, itk::ObjectFactoryBase);
+
+  /** Register one factory of this type  */
+  static void
+  RegisterOneFactory()
+  {
+    CurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory::Pointer factory =
+      CurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory::New();
+
+    ObjectFactoryBase::RegisterFactory(factory);
+  }
+
+protected:
+  /** Override base FFT image filter constructor with the given TFFTImageFilter template
+   * with distinct specialization.
+   * Requires TFFTImageFilter to have the template signature <InputImageType, OutputImageType>.
+   */
+  template <typename InputPixelType, typename OutputPixelType, unsigned int D, unsigned int... ImageDimensions>
+  void
+  OverrideFFTImageFilterType(const std::integer_sequence<unsigned int, D, ImageDimensions...> &)
+  {
+    using InputImageType = CurvilinearArraySpecialCoordinatesImage<InputPixelType, D>;
+    using OutputImageType = Image<OutputPixelType, D>;
+    this->RegisterOverride(typeid(typename TFFTImageFilter<InputImageType, OutputImageType>::Superclass).name(),
+                           typeid(TFFTImageFilter<InputImageType, OutputImageType>).name(),
+                           "FFT CurvilinearArraySpecialCoordinatesImage Filter Override",
+                           true,
+                           CreateObjectFunction<TFFTImageFilter<InputImageType, OutputImageType>>::New());
+    OverrideFFTImageFilterType<InputPixelType, OutputPixelType>(
+      std::integer_sequence<unsigned int, ImageDimensions...>{});
+  }
+  template <typename InputPixelType, typename OutputPixelType>
+  void
+  OverrideFFTImageFilterType(const std::integer_sequence<unsigned int> &)
+  {}
+
+  CurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory()
+  {
+    OverrideFFTImageFilterType<typename FFTImageFilterTraits<TFFTImageFilter>::template InputPixelType<float>,
+                               typename FFTImageFilterTraits<TFFTImageFilter>::template OutputPixelType<float>>(
+      std::integer_sequence<unsigned int, 4, 3, 2, 1>{});
+
+    OverrideFFTImageFilterType<typename FFTImageFilterTraits<TFFTImageFilter>::template InputPixelType<double>,
+                               typename FFTImageFilterTraits<TFFTImageFilter>::template OutputPixelType<double>>(
+      std::integer_sequence<unsigned int, 4, 3, 2, 1>{});
+  }
+};
+
+} // namespace itk
+
+#endif // itkCurvilinearArraySpecialCoordinatesFFTImageFilterFactory_h
diff --git a/include/itkCurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory.h b/include/itkCurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory.h
@@ -0,0 +1,119 @@
+/*=========================================================================
+ *
+ *  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 itkCurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory_h
+#define itkCurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory_h
+
+#include "itkImage.h"
+#include "itkCurvilinearArraySpecialCoordinatesImage.h"
+
+#include "itkFFTImageFilterFactory.h"
+#include "itkObjectFactoryBase.h"
+#include "itkVersion.h"
+
+namespace itk
+{
+/** \class CurvilinearArraySpecialCoordinatesFFTImageFilterFactory
+ *
+ * \brief Object Factory implementation for FFT filters
+ *
+ * \sa CurvilinearArraySpecialCoordinatesImage
+ * \sa itkFFTImageFilterFactory
+ *
+ * \ingroup FourierTransform
+ * \ingroup ITKFFT
+ * \ingroup Ultrasound
+ */
+template <template <typename, typename> class TFFTImageFilter>
+class CurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory : public itk::ObjectFactoryBase
+{
+public:
+  ITK_DISALLOW_COPY_AND_MOVE(CurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory);
+
+  using Self = CurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory;
+  using Superclass = ObjectFactoryBase;
+  using Pointer = SmartPointer<Self>;
+  using ConstPointer = SmartPointer<const Self>;
+
+  /** Class methods used to interface with the registered factories. */
+  const char *
+  GetITKSourceVersion() const override
+  {
+    return ITK_SOURCE_VERSION;
+  }
+  const char *
+  GetDescription() const override
+  {
+    return "An FFTImageFilter factory";
+  }
+
+  /** Method for class instantiation. */
+  itkFactorylessNewMacro(Self);
+
+  /** Run-time type information (and related methods). */
+  itkTypeMacro(CurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory, itk::ObjectFactoryBase);
+
+  /** Register one factory of this type  */
+  static void
+  RegisterOneFactory()
+  {
+    CurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory::Pointer factory =
+      CurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory::New();
+
+    ObjectFactoryBase::RegisterFactory(factory);
+  }
+
+protected:
+  /** Override base FFT image filter constructor with the given TFFTImageFilter template
+   * with distinct specialization.
+   * Requires TFFTImageFilter to have the template signature <InputImageType, OutputImageType>.
+   */
+  template <typename InputPixelType, typename OutputPixelType, unsigned int D, unsigned int... ImageDimensions>
+  void
+  OverrideFFTImageFilterType(const std::integer_sequence<unsigned int, D, ImageDimensions...> &)
+  {
+    using InputImageType = Image<InputPixelType, D>;
+    using OutputImageType = CurvilinearArraySpecialCoordinatesImage<OutputPixelType, D>;
+    this->RegisterOverride(typeid(typename TFFTImageFilter<InputImageType, OutputImageType>::Superclass).name(),
+                           typeid(TFFTImageFilter<InputImageType, OutputImageType>).name(),
+                           "FFT CurvilinearArraySpecialCoordinatesImage Filter Override",
+                           true,
+                           CreateObjectFunction<TFFTImageFilter<InputImageType, OutputImageType>>::New());
+    OverrideFFTImageFilterType<InputPixelType, OutputPixelType>(
+      std::integer_sequence<unsigned int, ImageDimensions...>{});
+  }
+  template <typename InputPixelType, typename OutputPixelType>
+  void
+  OverrideFFTImageFilterType(const std::integer_sequence<unsigned int> &)
+  {}
+
+  CurvilinearArraySpecialCoordinatesInverseFFTImageFilterFactory()
+  {
+    OverrideFFTImageFilterType<typename FFTImageFilterTraits<TFFTImageFilter>::template InputPixelType<float>,
+                               typename FFTImageFilterTraits<TFFTImageFilter>::template OutputPixelType<float>>(
+      std::integer_sequence<unsigned int, 4, 3, 2, 1>{});
+
+    OverrideFFTImageFilterType<typename FFTImageFilterTraits<TFFTImageFilter>::template InputPixelType<double>,
+                               typename FFTImageFilterTraits<TFFTImageFilter>::template OutputPixelType<double>>(
+      std::integer_sequence<unsigned int, 4, 3, 2, 1>{});
+  }
+};
+
+} // namespace itk
+
+#endif // itkCurvilinearArraySpecialCoordinatesFFTImageFilterFactory_h
diff --git a/test/itkTimeGainCompensationImageFilterTest.cxx b/test/itkTimeGainCompensationImageFilterTest.cxx
@@ -18,6 +18,7 @@
 
 #include "itkTimeGainCompensationImageFilter.h"
 #include "itkCurvilinearArraySpecialCoordinatesImage.h"
+#include "itkCurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory.h"
 #include "itkBModeImageFilter.h"
 #include "itkCastImageFilter.h"
 #include "itkRescaleIntensityImageFilter.h"
@@ -89,6 +90,10 @@ itkTimeGainCompensationImageFilterTest(int argc, char * argv[])
   CasterType::Pointer caster = CasterType::New();
   caster->SetInput(tgcFilter->GetOutput());
 
+  using FFTFactoryType =
+    itk::CurvilinearArraySpecialCoordinatesForwardFFTImageFilterFactory<itk::VnlForward1DFFTImageFilter>;
+  FFTFactoryType::RegisterOneFactory();
+
   using BModeFilterType = itk::BModeImageFilter<RealImageType, RealImageType>;
   BModeFilterType::Pointer bmodeFilter = BModeFilterType::New();
   bmodeFilter->SetInput(caster->GetOutput());