SimpleITK  2.0.0rc2.post50
sitkDerivativeImageFilter.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 sitkDerivativeImageFilter_h
19 #define sitkDerivativeImageFilter_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 ~DerivativeImageFilter();
61 
65 
68 \
69 
73  SITK_RETURN_SELF_TYPE_HEADER SetDirection ( unsigned int Direction ) { this->m_Direction = Direction; return *this; }
74 
78  unsigned int GetDirection() const { return this->m_Direction; }\
79 
83  SITK_RETURN_SELF_TYPE_HEADER SetOrder ( unsigned int Order ) { this->m_Order = Order; return *this; }
84 
88  unsigned int GetOrder() const { return this->m_Order; }\
89 
93  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
94 
96  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
97  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
98 
102  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
103 
105  std::string GetName() const { return std::string ("DerivativeImageFilter"); }
106 
108  std::string ToString() const;
109 
110 
113  Image Execute ( const Image& image1 );
114 
115  private:
116 
119  using MemberFunctionType = Image (Self::*)( const Image& image1 );
120  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
122  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
123 
126  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
127 
128 
129  unsigned int m_Direction{0u};
130 
131  unsigned int m_Order{1u};
132 
133  bool m_UseImageSpacing{true};
134 
135 
136  };
137 
148  SITKBasicFilters_EXPORT Image Derivative ( const Image& image1, unsigned int direction = 0u, unsigned int order = 1u, bool useImageSpacing = true );
149 
151  }
152 }
153 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::detail::ExecuteInternalVectorImageAddressor
Definition: sitkDetail.h:59
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RealPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< float >, BasicPixelID< double > >::Type RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:96
itk::simple::DerivativeImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkDerivativeImageFilter.h:126
itk::simple::Derivative
Image Derivative(const Image &image1, unsigned int direction=0u, unsigned int order=1u, bool useImageSpacing=true)
Computes the directional derivative of an image. The directional derivative at each pixel location is...
itk::simple::DerivativeImageFilter::SetDirection
Self & SetDirection(unsigned int Direction)
Definition: sitkDerivativeImageFilter.h:73
sitkImageFilter.h
itk::simple::DerivativeImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkDerivativeImageFilter.h:119
itk::simple::DerivativeImageFilter::GetOrder
unsigned int GetOrder() const
Definition: sitkDerivativeImageFilter.h:88
itk::simple::DerivativeImageFilter::SetOrder
Self & SetOrder(unsigned int Order)
Definition: sitkDerivativeImageFilter.h:83
itk::simple::DerivativeImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkDerivativeImageFilter.h:67
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::DerivativeImageFilter::GetDirection
unsigned int GetDirection() const
Definition: sitkDerivativeImageFilter.h:78
itk::simple::DerivativeImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkDerivativeImageFilter.h:102
itk::simple::DerivativeImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkDerivativeImageFilter.h:93
itk
itk::simple::DerivativeImageFilter::GetName
std::string GetName() const
Definition: sitkDerivativeImageFilter.h:105
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::DerivativeImageFilter
Computes the directional derivative of an image. The directional derivative at each pixel location is...
Definition: sitkDerivativeImageFilter.h:55
itk::simple::DerivativeImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkDerivativeImageFilter.h:96
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::DerivativeImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkDerivativeImageFilter.h:97