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

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

  virtual ~FastSymmetricForcesDemonsRegistrationFilter();

  FastSymmetricForcesDemonsRegistrationFilter();

  using PixelIDTypeList = BasicPixelIDTypeList;
 
 
 

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

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

  void
  SetNumberOfIterations(uint32_t NumberOfIterations )
    { this->m_NumberOfIterations = NumberOfIterations; }

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

  void
  SetMaximumRMSError(double MaximumRMSError )
    { this->m_MaximumRMSError = MaximumRMSError; }

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

  void
  SetUseGradientType(UseGradientTypeType UseGradientType )
    { this->m_UseGradientType = UseGradientType; }

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

  void
  SetMaximumUpdateStepLength(double MaximumUpdateStepLength )
    { this->m_MaximumUpdateStepLength = MaximumUpdateStepLength; }

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

  void
  SetSmoothDisplacementField(bool SmoothDisplacementField )
    { this->m_SmoothDisplacementField = SmoothDisplacementField; }

  void
  SmoothDisplacementFieldOn() { return this->SetSmoothDisplacementField(true); }
  void
  SmoothDisplacementFieldOff() { return this->SetSmoothDisplacementField(false); }
  bool
  GetSmoothDisplacementField() const { return this->m_SmoothDisplacementField; }
 

  void
  SetSmoothUpdateField(bool SmoothUpdateField )
    { this->m_SmoothUpdateField = SmoothUpdateField; }

  void
  SmoothUpdateFieldOn() { return this->SetSmoothUpdateField(true); }
  void
  SmoothUpdateFieldOff() { return this->SetSmoothUpdateField(false); }
  bool
  GetSmoothUpdateField() const { return this->m_SmoothUpdateField; }
 

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

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

  void
  SetMaximumKernelWidth(unsigned int MaximumKernelWidth )
    { this->m_MaximumKernelWidth = MaximumKernelWidth; }

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

  void
  SetMaximumError(double MaximumError )
    { this->m_MaximumError = MaximumError; }

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

  void
  SetIntensityDifferenceThreshold(double IntensityDifferenceThreshold )
    { this->m_IntensityDifferenceThreshold = IntensityDifferenceThreshold; }

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

  void
  SetUseImageSpacing(bool UseImageSpacing )
    { this->m_UseImageSpacing = UseImageSpacing; }

  void
  UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
  void
  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("FastSymmetricForcesDemonsRegistrationFilter"); }

  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>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
    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::FastSymmetricForcesDemonsRegistrationFilter::Symmetric };
 
    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
    std::unique_ptr<itk::ProcessObject, ProcessObjectDeleter> m_Filter{nullptr};
 
 
 
};
 
 
}
#endif