SimpleITK  
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::simple {
33 
55  public:
57 
59  virtual ~DerivativeImageFilter();
60 
64 
67 \
68 
72  SITK_RETURN_SELF_TYPE_HEADER SetDirection ( unsigned int Direction ) { this->m_Direction = Direction; return *this; }
73 
77  unsigned int GetDirection() const { return this->m_Direction; }\
78 
82  SITK_RETURN_SELF_TYPE_HEADER SetOrder ( unsigned int Order ) { this->m_Order = Order; return *this; }
83 
87  unsigned int GetOrder() const { return this->m_Order; }\
88 
92  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
93 
95  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
96  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
97 
101  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
102 
104  std::string GetName() const { return std::string ("DerivativeImageFilter"); }
105 
107  std::string ToString() const;
108 
109 
112  Image Execute ( const Image& image1 );
113 
114  private:
115 
118  using MemberFunctionType = Image (Self::*)( const Image& image1 );
119  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
121  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
122 
125  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
126 
127 
128  unsigned int m_Direction{0u};
129 
130  unsigned int m_Order{1u};
131 
132  bool m_UseImageSpacing{true};
133 
134 
135  };
136 
147  SITKBasicFilters_EXPORT Image Derivative ( const Image& image1, unsigned int direction = 0u, unsigned int order = 1u, bool useImageSpacing = true );
148 
150 }
151 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::ExecuteInternalVectorImageAddressor
Definition: sitkDetail.h:66
itk::simple::RealPixelIDTypeList
typelist2::typelist< BasicPixelID< float >, BasicPixelID< double > > RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:98
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::DerivativeImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkDerivativeImageFilter.h:125
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:72
sitkImageFilter.h
itk::simple::DerivativeImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkDerivativeImageFilter.h:118
itk::simple::DerivativeImageFilter::GetOrder
unsigned int GetOrder() const
Definition: sitkDerivativeImageFilter.h:87
itk::simple::DerivativeImageFilter::SetOrder
Self & SetOrder(unsigned int Order)
Definition: sitkDerivativeImageFilter.h:82
itk::simple::DerivativeImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkDerivativeImageFilter.h:66
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::DerivativeImageFilter::GetDirection
unsigned int GetDirection() const
Definition: sitkDerivativeImageFilter.h:77
itk::simple::DerivativeImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkDerivativeImageFilter.h:101
itk::simple::DerivativeImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkDerivativeImageFilter.h:92
itk::simple::DerivativeImageFilter::GetName
std::string GetName() const
Definition: sitkDerivativeImageFilter.h:104
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::DerivativeImageFilter
Computes the directional derivative of an image. The directional derivative at each pixel location is...
Definition: sitkDerivativeImageFilter.h:54
itk::simple::DerivativeImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkDerivativeImageFilter.h:95
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::DerivativeImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkDerivativeImageFilter.h:96