SimpleITK  1.1.0
sitkDerivativeImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
59  public:
61 
63  virtual ~DerivativeImageFilter();
64 
68 
71 
72 
73 
77  SITK_RETURN_SELF_TYPE_HEADER SetDirection ( unsigned int Direction ) { this->m_Direction = Direction; return *this; }
78 
82  unsigned int GetDirection() const { return this->m_Direction; }
83 
87  SITK_RETURN_SELF_TYPE_HEADER SetOrder ( unsigned int Order ) { this->m_Order = Order; return *this; }
88 
92  unsigned int GetOrder() const { return this->m_Order; }
93 
97  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
98 
100  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
101  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
102 
106  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
108  std::string GetName() const { return std::string ("DerivativeImageFilter"); }
109 
111  std::string ToString() const;
112 
113 
115  Image Execute ( const Image& image1 );
116 
117 
119  Image Execute ( const Image& image1, unsigned int direction, unsigned int order, bool useImageSpacing );
120 
121  private:
122 
125  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
126  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
128  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
129 
130  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
131  friend struct detail::ExecuteInternalVectorImageAddressor<MemberFunctionType>;
132  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
133 
134 
135  unsigned int m_Direction;
136  unsigned int m_Order;
138  };
139 
140 
149  SITKBasicFilters_EXPORT Image Derivative ( const Image& image1, unsigned int direction = 0u, unsigned int order = 1u, bool useImageSpacing = true );
150 
151  }
152 }
153 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
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::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:77
sitkImageFilter.h
itk::simple::DerivativeImageFilter::GetOrder
unsigned int GetOrder() const
Definition: sitkDerivativeImageFilter.h:92
itk::simple::DerivativeImageFilter::SetOrder
Self & SetOrder(unsigned int Order)
Definition: sitkDerivativeImageFilter.h:87
itk::simple::DerivativeImageFilter::m_Order
unsigned int m_Order
Definition: sitkDerivativeImageFilter.h:136
itk::simple::DerivativeImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkDerivativeImageFilter.h:132
itk::simple::DerivativeImageFilter::m_Direction
unsigned int m_Direction
Definition: sitkDerivativeImageFilter.h:135
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::DerivativeImageFilter::GetDirection
unsigned int GetDirection() const
Definition: sitkDerivativeImageFilter.h:82
itk::simple::DerivativeImageFilter::GetUseImageSpacing
bool GetUseImageSpacing() const
Definition: sitkDerivativeImageFilter.h:106
itk::simple::DerivativeImageFilter::SetUseImageSpacing
Self & SetUseImageSpacing(bool UseImageSpacing)
Definition: sitkDerivativeImageFilter.h:97
itk::simple::DerivativeImageFilter::m_UseImageSpacing
bool m_UseImageSpacing
Definition: sitkDerivativeImageFilter.h:137
itk
itk::simple::DerivativeImageFilter::GetName
std::string GetName() const
Definition: sitkDerivativeImageFilter.h:108
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::DerivativeImageFilter
Computes the directional derivative of an image. The directional derivative at each pixel location is...
Definition: sitkDerivativeImageFilter.h:58
itk::simple::DerivativeImageFilter::UseImageSpacingOn
Self & UseImageSpacingOn()
Definition: sitkDerivativeImageFilter.h:100
itk::simple::DerivativeImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkDerivativeImageFilter.h:70
itk::simple::DerivativeImageFilter::Self
DerivativeImageFilter Self
Definition: sitkDerivativeImageFilter.h:60
itk::simple::DerivativeImageFilter::UseImageSpacingOff
Self & UseImageSpacingOff()
Definition: sitkDerivativeImageFilter.h:101