SimpleITK  1.3.0.dev466
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 
53  public:
55 
57  virtual ~DerivativeImageFilter();
58 
62 
65 
66 
67 
71  SITK_RETURN_SELF_TYPE_HEADER SetDirection ( unsigned int Direction ) { this->m_Direction = Direction; return *this; }
72 
76  unsigned int GetDirection() const { return this->m_Direction; }
77 
81  SITK_RETURN_SELF_TYPE_HEADER SetOrder ( unsigned int Order ) { this->m_Order = Order; return *this; }
82 
86  unsigned int GetOrder() const { return this->m_Order; }
87 
91  SITK_RETURN_SELF_TYPE_HEADER SetUseImageSpacing ( bool UseImageSpacing ) { this->m_UseImageSpacing = UseImageSpacing; return *this; }
92 
94  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOn() { return this->SetUseImageSpacing(true); }
95  SITK_RETURN_SELF_TYPE_HEADER UseImageSpacingOff() { return this->SetUseImageSpacing(false); }
96 
100  bool GetUseImageSpacing() const { return this->m_UseImageSpacing; }
102  std::string GetName() const { return std::string ("DerivativeImageFilter"); }
103 
105  std::string ToString() const;
106 
107 
109  Image Execute ( const Image& image1 );
110 
111 
113  Image Execute ( const Image& image1, unsigned int direction, unsigned int order, bool useImageSpacing );
114 
115  private:
116 
119  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
120  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
122  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
123 
124  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
125  friend struct detail::ExecuteInternalVectorImageAddressor<MemberFunctionType>;
126  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
127 
128 
129  unsigned int m_Direction;
130  unsigned int m_Order;
132  };
133 
134 
143  SITKBasicFilters_EXPORT Image Derivative ( const Image& image1, unsigned int direction = 0u, unsigned int order = 1u, bool useImageSpacing = true );
144 
145  }
146 }
147 #endif
Computes the directional derivative of an image. The directional derivative at each pixel location is...
#define SITKBasicFilters_EXPORT
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...
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Self & SetUseImageSpacing(bool UseImageSpacing)
typelist::MakeTypeList< BasicPixelID< float >, BasicPixelID< double > >::Type RealPixelIDTypeList
Self & SetDirection(unsigned int Direction)
The Image class for SimpleITK.
Definition: sitkImage.h:78
The base interface for SimpleITK filters that take one input image.