SimpleITK  2.0.0rc2.post50
sitkGradientImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright NumFOCUS
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18 #ifndef sitkGradientImageFilter_h
19 #define sitkGradientImageFilter_h
20 
21 /*
22  * WARNING: DO NOT EDIT THIS FILE!
23  * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24  * Please look at sitkImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkBasicFilters.h"
30 #include "sitkImageFilter.h"
31 
32 namespace itk {
33  namespace simple {
34 
56  public:
58 
60  virtual ~GradientImageFilter();
61 
65 
68 \
69 
73  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
74 
76  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
77  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
78 
81  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }\
82 
86  SITK_RETURN_SELF_TYPE_HEADER SetUseImageDirection ( bool UseImageDirection ) { this->m_UseImageDirection = UseImageDirection; return *this; }
87 
89  SITK_RETURN_SELF_TYPE_HEADER UseImageDirectionOn() { return this->SetUseImageDirection(true); }
90  SITK_RETURN_SELF_TYPE_HEADER UseImageDirectionOff() { return this->SetUseImageDirection(false); }
91 
95  bool GetUseImageDirection() const { return this->m_UseImageDirection; }
96 
98  std::string GetName() const { return std::string ("GradientImageFilter"); }
99 
101  std::string ToString() const;
102 
103 
106  Image Execute ( const Image& image1 );
107 
108  private:
109 
112  using MemberFunctionType = Image (Self::*)( const Image& image1 );
113  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
114 
115 
117 
118  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
119 
120 
121  bool m_UseImageSpacing{true};
122 
123  bool m_UseImageDirection{false};
124 
125 
126  };
127 
138  SITKBasicFilters_EXPORT Image Gradient ( const Image& image1, bool useImageSpacing = true, bool useImageDirection = false );
139 
141  }
142 }
143 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::GradientImageFilter::UseImageDirectionOff
Self & UseImageDirectionOff()
Definition: sitkGradientImageFilter.h:90
sitkBasicFilters.h
itk::simple::GradientImageFilter
Computes the gradient of an image using directional derivatives.
Definition: sitkGradientImageFilter.h:55
itk::simple::GradientImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGradientImageFilter.h:118
itk::simple::GradientImageFilter::GetName
std::string GetName() const
Definition: sitkGradientImageFilter.h:98
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::GradientImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkGradientImageFilter.h:76
itk::simple::Gradient
Image Gradient(const Image &image1, bool useImageSpacing=true, bool useImageDirection=false)
Computes the gradient of an image using directional derivatives.
itk::simple::GradientImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkGradientImageFilter.h:73
itk::simple::GradientImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkGradientImageFilter.h:67
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::GradientImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkGradientImageFilter.h:112
itk::simple::GradientImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkGradientImageFilter.h:81
itk::simple::GradientImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkGradientImageFilter.h:77
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::GradientImageFilter::SetUseImageDirection
Self & SetUseImageDirection(bool UseImageDirection)
Definition: sitkGradientImageFilter.h:86
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::GradientImageFilter::UseImageDirectionOn
Self & UseImageDirectionOn()
Definition: sitkGradientImageFilter.h:89
itk::simple::GradientImageFilter::GetUseImageDirection
bool GetUseImageDirection() const
Definition: sitkGradientImageFilter.h:95