sitkGradientImageFilter.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 sitkGradientImageFilter_h
#define sitkGradientImageFilter_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 GradientImageFilter : public ImageFilter {
public:
  using Self = GradientImageFilter;

  virtual ~GradientImageFilter();

  GradientImageFilter();

  using PixelIDTypeList = BasicPixelIDTypeList;
 
 
 

  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; }
 

  void
  SetUseImageDirection(bool UseImageDirection )
    { this->m_UseImageDirection = UseImageDirection; }

  void
  UseImageDirectionOn() { return this->SetUseImageDirection(true); }
  void
  UseImageDirectionOff() { return this->SetUseImageDirection(false); }
  bool
  GetUseImageDirection() const { return this->m_UseImageDirection; }
 

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

  std::string ToString() const;
 

  Image Execute(const Image &image1);
 
 
private:
  using MemberFunctionType = Image (Self::*)(const Image &image1);
  template <class TImageType> Image ExecuteInternal(const Image &image1);
    friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
    bool m_UseImageSpacing{ true };
 
    bool m_UseImageDirection{ false };
 
 
 
 
 
 
 
};
 

SITKBasicFilters_EXPORT Image Gradient(
    const Image &image1, bool useImageSpacing = true, bool useImageDirection = false
);

 
}
#endif