SimpleITK  1.3.0.dev466
sitkSpeckleNoiseImageFilter.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 sitkSpeckleNoiseImageFilter_h
19 #define sitkSpeckleNoiseImageFilter_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 ~SpeckleNoiseImageFilter();
64 
68 
71 
72 
73 
77  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviation ( double StandardDeviation ) { this->m_StandardDeviation = StandardDeviation; return *this; }
78 
82  double GetStandardDeviation() const { return this->m_StandardDeviation; }
83 
86  SITK_RETURN_SELF_TYPE_HEADER SetSeed ( uint32_t Seed ) { this->m_Seed = Seed; return *this; }
87 
90  uint32_t GetSeed() const { return this->m_Seed; }
92  std::string GetName() const { return std::string ("SpeckleNoiseImageFilter"); }
93 
95  std::string ToString() const;
96 
97 
99  Image Execute ( const Image& image1 );
100 
101 
103  Image Execute ( const Image& image1, double standardDeviation, uint32_t seed );
104 
105  private:
106 
109  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
110  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
112  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
113 
114  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
115  friend struct detail::ExecuteInternalVectorImageAddressor<MemberFunctionType>;
116  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
117 
118 
121  };
122 
123 
132  SITKBasicFilters_EXPORT Image SpeckleNoise ( const Image& image1, double standardDeviation = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
133 
134  }
135 }
136 #endif
Self & SetStandardDeviation(double StandardDeviation)
#define SITKBasicFilters_EXPORT
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
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
Alter an image with speckle (multiplicative) noise.
Image SpeckleNoise(const Image &image1, double standardDeviation=1.0, uint32_t seed=(uint32_t) itk::simple::sitkWallClock)
Alter an image with speckle (multiplicative) noise.
::uint32_t uint32_t
The Image class for SimpleITK.
Definition: sitkImage.h:78
The base interface for SimpleITK filters that take one input image.