sitkInvertDisplacementFieldImageFilter.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 sitkInvertDisplacementFieldImageFilter_h
#define sitkInvertDisplacementFieldImageFilter_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 InvertDisplacementFieldImageFilter : public ImageFilter {
public:
  using Self = InvertDisplacementFieldImageFilter;

  virtual ~InvertDisplacementFieldImageFilter();

  InvertDisplacementFieldImageFilter();

  using PixelIDTypeList = RealVectorPixelIDTypeList;
 
 
 

  void
  SetMaximumNumberOfIterations(uint32_t MaximumNumberOfIterations )
    { this->m_MaximumNumberOfIterations = MaximumNumberOfIterations; }

  uint32_t
  GetMaximumNumberOfIterations() const { return this->m_MaximumNumberOfIterations; }
 

  void
  SetMaxErrorToleranceThreshold(double MaxErrorToleranceThreshold )
    { this->m_MaxErrorToleranceThreshold = MaxErrorToleranceThreshold; }

  double
  GetMaxErrorToleranceThreshold() const { return this->m_MaxErrorToleranceThreshold; }
 

  void
  SetMeanErrorToleranceThreshold(double MeanErrorToleranceThreshold )
    { this->m_MeanErrorToleranceThreshold = MeanErrorToleranceThreshold; }

  double
  GetMeanErrorToleranceThreshold() const { return this->m_MeanErrorToleranceThreshold; }
 

  void
  SetEnforceBoundaryCondition(bool EnforceBoundaryCondition )
    { this->m_EnforceBoundaryCondition = EnforceBoundaryCondition; }

  void
  EnforceBoundaryConditionOn() { return this->SetEnforceBoundaryCondition(true); }
  void
  EnforceBoundaryConditionOff() { return this->SetEnforceBoundaryCondition(false); }
  bool
  GetEnforceBoundaryCondition() const { return this->m_EnforceBoundaryCondition; }
 

  double GetMaxErrorNorm() const { return this->m_MaxErrorNorm; }

  double GetMeanErrorNorm() const { return this->m_MeanErrorNorm; }

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

  std::string ToString() const;
 

  Image Execute(const Image &displacementField, const Image &inverseFieldInitialEstimate);
  Image Execute(const Image &displacementField);
 
 
private:
  using MemberFunctionType = Image (Self::*)(const Image *
    displacementField, const Image *
    inverseFieldInitialEstimate);
  template <class TImageType> Image ExecuteInternal(const Image *
    displacementField, const Image *
    inverseFieldInitialEstimate);
    friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
  /* Number of iterations to run */
    uint32_t m_MaximumNumberOfIterations{ 10u };
 
    double m_MaxErrorToleranceThreshold{ 0.1 };
 
    double m_MeanErrorToleranceThreshold{ 0.001 };
 
    bool m_EnforceBoundaryCondition{ true };
 
 
 
    double m_MaxErrorNorm{ 0.0 };
    double m_MeanErrorNorm{ 0.0 };
 
 
 
 
};
 

SITKBasicFilters_EXPORT Image InvertDisplacementField(
    const Image &displacementField, const Image &inverseFieldInitialEstimate, uint32_t maximumNumberOfIterations = 10u, double maxErrorToleranceThreshold = 0.1, double meanErrorToleranceThreshold = 0.001, bool enforceBoundaryCondition = true
);
 
SITKBasicFilters_EXPORT Image InvertDisplacementField(
    const Image &displacementField, uint32_t maximumNumberOfIterations = 10u, double maxErrorToleranceThreshold = 0.1, double meanErrorToleranceThreshold = 0.001, bool enforceBoundaryCondition = true
);

 
}
#endif