SimpleITK  1.1.0
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 
65  virtual ~RegionalMaximaImageFilter();
66 
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  private:
138 
141  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
142  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
143 
144 
145  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
146 
147  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
148 
149 
150  /* */
152  /* */
154  /* */
157  };
158 
159 
168  SITKBasicFilters_EXPORT Image RegionalMaxima ( const Image& image1, double backgroundValue = 0.0, double foregroundValue = 1.0, bool fullyConnected = false, bool flatIsMaxima = true );
169 
170  }
171 }
172 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
itk::simple::RegionalMaximaImageFilter::PixelIDTypeList
ScalarPixelIDTypeList PixelIDTypeList
Definition: sitkRegionalMaximaImageFilter.h:72
sitkBasicFilters.h
itk::simple::RegionalMaximaImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkRegionalMaximaImageFilter.h:84
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RegionalMaximaImageFilter::SetFullyConnected
Self & SetFullyConnected(bool FullyConnected)
Definition: sitkRegionalMaximaImageFilter.h:99
itk::simple::RegionalMaximaImageFilter::m_FullyConnected
bool m_FullyConnected
Definition: sitkRegionalMaximaImageFilter.h:155
itk::simple::RegionalMaximaImageFilter::GetFlatIsMaxima
bool GetFlatIsMaxima() const
Definition: sitkRegionalMaximaImageFilter.h:122
itk::simple::RegionalMaximaImageFilter::GetFullyConnected
bool GetFullyConnected() const
Definition: sitkRegionalMaximaImageFilter.h:108
itk::simple::RegionalMaximaImageFilter::FullyConnectedOff
Self & FullyConnectedOff()
Definition: sitkRegionalMaximaImageFilter.h:103
itk::simple::RegionalMaximaImageFilter::m_BackgroundValue
double m_BackgroundValue
Definition: sitkRegionalMaximaImageFilter.h:151
itk::simple::RegionalMaximaImageFilter::FullyConnectedOn
Self & FullyConnectedOn()
Definition: sitkRegionalMaximaImageFilter.h:102
sitkImageFilter.h
itk::simple::RegionalMaximaImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkRegionalMaximaImageFilter.h:79
itk::simple::RegionalMaximaImageFilter::GetName
std::string GetName() const
Definition: sitkRegionalMaximaImageFilter.h:124
itk::simple::RegionalMaximaImageFilter::Self
RegionalMaximaImageFilter Self
Definition: sitkRegionalMaximaImageFilter.h:62
itk::simple::RegionalMaximaImageFilter::m_FlatIsMaxima
bool m_FlatIsMaxima
Definition: sitkRegionalMaximaImageFilter.h:156
itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOff
Self & FlatIsMaximaOff()
Definition: sitkRegionalMaximaImageFilter.h:117
itk::simple::RegionalMaximaImageFilter
Produce a binary image where foreground is the regional maxima of the input image.
Definition: sitkRegionalMaximaImageFilter.h:60
itk::simple::RegionalMaxima
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.
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::RegionalMaximaImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRegionalMaximaImageFilter.h:147
itk::simple::RegionalMaximaImageFilter::m_ForegroundValue
double m_ForegroundValue
Definition: sitkRegionalMaximaImageFilter.h:153
itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOn
Self & FlatIsMaximaOn()
Definition: sitkRegionalMaximaImageFilter.h:116
itk::simple::RegionalMaximaImageFilter::SetFlatIsMaxima
Self & SetFlatIsMaxima(bool FlatIsMaxima)
Definition: sitkRegionalMaximaImageFilter.h:113
itk
itk::simple::RegionalMaximaImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkRegionalMaximaImageFilter.h:89
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::RegionalMaximaImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkRegionalMaximaImageFilter.h:94
itk::simple::ScalarPixelIDTypeList
BasicPixelIDTypeList ScalarPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:59