SimpleITK  1.0.1
sitkRegionalMaximaImageFilter.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 sitkRegionalMaximaImageFilter_h
19 #define sitkRegionalMaximaImageFilter_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 
61  public:
63 
67 
70 
73 
74 
75 
79  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
80 
84  double GetBackgroundValue() const { return this->m_BackgroundValue; }
85 
89  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
90 
94  double GetForegroundValue() const { return this->m_ForegroundValue; }
95 
99  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
100 
102  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
103  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
104 
108  bool GetFullyConnected() const { return this->m_FullyConnected; }
109 
113  SITK_RETURN_SELF_TYPE_HEADER SetFlatIsMaxima ( bool FlatIsMaxima ) { this->m_FlatIsMaxima = FlatIsMaxima; return *this; }
114 
116  SITK_RETURN_SELF_TYPE_HEADER FlatIsMaximaOn() { return this->SetFlatIsMaxima(true); }
117  SITK_RETURN_SELF_TYPE_HEADER FlatIsMaximaOff() { return this->SetFlatIsMaxima(false); }
118 
122  bool GetFlatIsMaxima() const { return this->m_FlatIsMaxima; }
124  std::string GetName() const { return std::string ("RegionalMaximaImageFilter"); }
125 
127  std::string ToString() const;
128 
129 
131  Image Execute ( const Image& image1 );
132 
133 
135  Image Execute ( const Image& image1, double backgroundValue, double foregroundValue, bool fullyConnected, bool flatIsMaxima );
136 
137 
138  private:
139 
142  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
143  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
144 
145 
146 
147  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
148 
149  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
150 
151 
152  /* */
154  /* */
156  /* */
159  };
160 
161 
162 
171  SITKBasicFilters_EXPORT Image RegionalMaxima ( const Image& image1, double backgroundValue = 0.0, double foregroundValue = 1.0, bool fullyConnected = false, bool flatIsMaxima = true );
172 
173  }
174 }
175 #endif
#define SITKBasicFilters_EXPORT
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Produce a binary image where foreground is the regional maxima of the input image.
Image RegionalMaxima(const Image &image1, double backgroundValue=0.0, double foregroundValue=1.0, bool fullyConnected=false, bool flatIsMaxima=true)
Produce a binary image where foreground is the regional maxima of the input image.
The main Image class for SimpleITK.
Definition: sitkImage.h:54
BasicPixelIDTypeList ScalarPixelIDTypeList
The base interface for SimpleITK filters that take one input image.