SimpleITK  1.3.0.dev466
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 
55  public:
57 
59  virtual ~RegionalMaximaImageFilter();
60 
64 
67 
68 
69 
73  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
74 
78  double GetBackgroundValue() const { return this->m_BackgroundValue; }
79 
83  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
84 
88  double GetForegroundValue() const { return this->m_ForegroundValue; }
89 
93  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
94 
96  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
97  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
98 
102  bool GetFullyConnected() const { return this->m_FullyConnected; }
103 
107  SITK_RETURN_SELF_TYPE_HEADER SetFlatIsMaxima ( bool FlatIsMaxima ) { this->m_FlatIsMaxima = FlatIsMaxima; return *this; }
108 
110  SITK_RETURN_SELF_TYPE_HEADER FlatIsMaximaOn() { return this->SetFlatIsMaxima(true); }
111  SITK_RETURN_SELF_TYPE_HEADER FlatIsMaximaOff() { return this->SetFlatIsMaxima(false); }
112 
116  bool GetFlatIsMaxima() const { return this->m_FlatIsMaxima; }
118  std::string GetName() const { return std::string ("RegionalMaximaImageFilter"); }
119 
121  std::string ToString() const;
122 
123 
125  Image Execute ( const Image& image1 );
126 
127 
129  Image Execute ( const Image& image1, double backgroundValue, double foregroundValue, bool fullyConnected, bool flatIsMaxima );
130 
131  private:
132 
135  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
136  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
137 
138 
139  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
140 
141  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
142 
143 
144  /* */
146  /* */
148  /* */
151  };
152 
153 
162  SITKBasicFilters_EXPORT Image RegionalMaxima ( const Image& image1, double backgroundValue = 0.0, double foregroundValue = 1.0, bool fullyConnected = false, bool flatIsMaxima = true );
163 
164  }
165 }
166 #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 Image class for SimpleITK.
Definition: sitkImage.h:78
BasicPixelIDTypeList ScalarPixelIDTypeList
The base interface for SimpleITK filters that take one input image.