sitkDiffeomorphicDemonsRegistrationFilter.h

Go to the documentation of this file.

/*=========================================================================
*
*  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 sitkDiffeomorphicDemonsRegistrationFilter_h
#define sitkDiffeomorphicDemonsRegistrationFilter_h
 
/*
 * WARNING: DO NOT EDIT THIS FILE!
 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
 * Please look at sitkImageFilterTemplate.h.in to make changes.
 */
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
 
namespace itk::simple {

    class SITKBasicFilters_EXPORT DiffeomorphicDemonsRegistrationFilter : public ImageFilter {
    public:
      using Self = DiffeomorphicDemonsRegistrationFilter;

      virtual ~DiffeomorphicDemonsRegistrationFilter();

      DiffeomorphicDemonsRegistrationFilter();

      using PixelIDTypeList = BasicPixelIDTypeList;
\

      SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations ( std::vector<double> StandardDeviations ) { this->m_StandardDeviations = std::move(StandardDeviations); return *this; }

      SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviations( double value ) { this->m_StandardDeviations = std::vector<double>(3, value); return *this; }

      std::vector<double> GetStandardDeviations() const { return this->m_StandardDeviations; }\

      SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( uint32_t NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }

      uint32_t GetNumberOfIterations() const { return this->m_NumberOfIterations; }\

      SITK_RETURN_SELF_TYPE_HEADER SetMaximumRMSError ( double MaximumRMSError ) { this->m_MaximumRMSError = MaximumRMSError; return *this; }

      double GetMaximumRMSError() const { return this->m_MaximumRMSError; }
 
      typedef enum {Symmetric,Fixed,WarpedMoving,MappedMoving} UseGradientTypeType;\

      SITK_RETURN_SELF_TYPE_HEADER SetUseGradientType ( UseGradientTypeType UseGradientType ) { this->m_UseGradientType = UseGradientType; return *this; }

      UseGradientTypeType GetUseGradientType() const { return this->m_UseGradientType; }\

      SITK_RETURN_SELF_TYPE_HEADER SetUseFirstOrderExp ( bool UseFirstOrderExp ) { this->m_UseFirstOrderExp = UseFirstOrderExp; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER UseFirstOrderExpOn() { return this->SetUseFirstOrderExp(true); }
      SITK_RETURN_SELF_TYPE_HEADER UseFirstOrderExpOff() { return this->SetUseFirstOrderExp(false); }

      bool GetUseFirstOrderExp() const { return this->m_UseFirstOrderExp; }\

      SITK_RETURN_SELF_TYPE_HEADER SetMaximumUpdateStepLength ( double MaximumUpdateStepLength ) { this->m_MaximumUpdateStepLength = MaximumUpdateStepLength; return *this; }

      double GetMaximumUpdateStepLength() const { return this->m_MaximumUpdateStepLength; }\

      SITK_RETURN_SELF_TYPE_HEADER SetSmoothDisplacementField ( bool SmoothDisplacementField ) { this->m_SmoothDisplacementField = SmoothDisplacementField; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOn() { return this->SetSmoothDisplacementField(true); }
      SITK_RETURN_SELF_TYPE_HEADER SmoothDisplacementFieldOff() { return this->SetSmoothDisplacementField(false); }

      bool GetSmoothDisplacementField() const { return this->m_SmoothDisplacementField; }\

      SITK_RETURN_SELF_TYPE_HEADER SetSmoothUpdateField ( bool SmoothUpdateField ) { this->m_SmoothUpdateField = SmoothUpdateField; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOn() { return this->SetSmoothUpdateField(true); }
      SITK_RETURN_SELF_TYPE_HEADER SmoothUpdateFieldOff() { return this->SetSmoothUpdateField(false); }

      bool GetSmoothUpdateField() const { return this->m_SmoothUpdateField; }\

      SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations ( std::vector<double> UpdateFieldStandardDeviations ) { this->m_UpdateFieldStandardDeviations = std::move(UpdateFieldStandardDeviations); return *this; }

      SITK_RETURN_SELF_TYPE_HEADER SetUpdateFieldStandardDeviations( double value ) { this->m_UpdateFieldStandardDeviations = std::vector<double>(3, value); return *this; }

      std::vector<double> GetUpdateFieldStandardDeviations() const { return this->m_UpdateFieldStandardDeviations; }\

      SITK_RETURN_SELF_TYPE_HEADER SetMaximumKernelWidth ( unsigned int MaximumKernelWidth ) { this->m_MaximumKernelWidth = MaximumKernelWidth; return *this; }

      unsigned int GetMaximumKernelWidth() const { return this->m_MaximumKernelWidth; }\

      SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( double MaximumError ) { this->m_MaximumError = MaximumError; return *this; }

      double GetMaximumError() const { return this->m_MaximumError; }\

      SITK_RETURN_SELF_TYPE_HEADER SetIntensityDifferenceThreshold ( double IntensityDifferenceThreshold ) { this->m_IntensityDifferenceThreshold = IntensityDifferenceThreshold; return *this; }

      double GetIntensityDifferenceThreshold() const { return this->m_IntensityDifferenceThreshold; }\

      SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
      SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }

      bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
     uint32_t GetElapsedIterations() const { return this->m_pfGetElapsedIterations(); };

     double GetRMSChange() const { return this->m_RMSChange; };

     double GetMetric() const { return this->m_pfGetMetric(); };

     void StopRegistration() { return this->m_pfGetStopRegistration(); };
 

      std::string GetName() const { return std::string ("DiffeomorphicDemonsRegistrationFilter"); }

      std::string ToString() const;
 

 
      Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & initialDisplacementField );
      Image Execute ( const Image & fixedImage, const Image & movingImage );
 
    private:

 
      using MemberFunctionType = Image (Self::*)( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
      template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField );
 
 
      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
 
      std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
 
 
      std::vector<double>  m_StandardDeviations{std::vector<double>(3, 1.0)};
 
      /* Number of iterations to run */
      uint32_t  m_NumberOfIterations{10u};
 
      /* Value of RMS change below which the filter should stop. This is a convergence criterion. */
      double  m_MaximumRMSError{0.02};
 
      UseGradientTypeType  m_UseGradientType{itk::simple::DiffeomorphicDemonsRegistrationFilter::Symmetric};
 
      bool  m_UseFirstOrderExp{false};
 
      double  m_MaximumUpdateStepLength{0.5};
 
      bool  m_SmoothDisplacementField{true};
 
      bool  m_SmoothUpdateField{false};
 
      std::vector<double>  m_UpdateFieldStandardDeviations{std::vector<double>(3, 1.0)};
 
      unsigned int  m_MaximumKernelWidth{30u};
 
      double  m_MaximumError{0.1};
 
      double  m_IntensityDifferenceThreshold{0.001};
 
      bool  m_UseImageSpacing{true};
 
 
      std::function<uint32_t()> m_pfGetElapsedIterations;
 
      double m_RMSChange{0.0};
 
      std::function<double()> m_pfGetMetric;
 
      std::function<void()> m_pfGetStopRegistration;
 
      // Holder of process object for active measurements
      itk::ProcessObject *m_Filter{nullptr};
 
    };
 
 
}
#endif