SimpleITK  1.3.0.dev466
sitkRegionalMinimaImageFilter.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 sitkRegionalMinimaImageFilter_h
19 #define sitkRegionalMinimaImageFilter_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 ~RegionalMinimaImageFilter();
58 
62 
65 
66 
67 
71  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
72 
76  double GetBackgroundValue() const { return this->m_BackgroundValue; }
77 
81  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
82 
86  double GetForegroundValue() const { return this->m_ForegroundValue; }
87 
91  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
92 
94  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
95  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
96 
100  bool GetFullyConnected() const { return this->m_FullyConnected; }
101 
105  SITK_RETURN_SELF_TYPE_HEADER SetFlatIsMinima ( bool FlatIsMinima ) { this->m_FlatIsMinima = FlatIsMinima; return *this; }
106 
108  SITK_RETURN_SELF_TYPE_HEADER FlatIsMinimaOn() { return this->SetFlatIsMinima(true); }
109  SITK_RETURN_SELF_TYPE_HEADER FlatIsMinimaOff() { return this->SetFlatIsMinima(false); }
110 
114  bool GetFlatIsMinima() const { return this->m_FlatIsMinima; }
116  std::string GetName() const { return std::string ("RegionalMinimaImageFilter"); }
117 
119  std::string ToString() const;
120 
121 
123  Image Execute ( const Image& image1 );
124 
125 
127  Image Execute ( const Image& image1, double backgroundValue, double foregroundValue, bool fullyConnected, bool flatIsMinima );
128 
129  private:
130 
133  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
134  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
135 
136 
137  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
138 
139  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
140 
141 
142  /* */
144  /* */
146  /* */
149  };
150 
151 
160  SITKBasicFilters_EXPORT Image RegionalMinima ( const Image& image1, double backgroundValue = 0.0, double foregroundValue = 1.0, bool fullyConnected = false, bool flatIsMinima = true );
161 
162  }
163 }
164 #endif
#define SITKBasicFilters_EXPORT
Produce a binary image where foreground is the regional minima of the input image.
The Image class for SimpleITK.
Definition: sitkImage.h:78
Image RegionalMinima(const Image &image1, double backgroundValue=0.0, double foregroundValue=1.0, bool fullyConnected=false, bool flatIsMinima=true)
Produce a binary image where foreground is the regional minima of the input image.
BasicPixelIDTypeList ScalarPixelIDTypeList
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
The base interface for SimpleITK filters that take one input image.