SimpleITK  2.0.0rc2.post21
sitkRegionalMaximaImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright NumFOCUS
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 
58  public:
60 
62  virtual ~RegionalMaximaImageFilter();
63 
67 
70 \
71 
75  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
76 
80  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
81 
85  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
86 
90  double GetForegroundValue() const { return this->m_ForegroundValue; }\
91 
95  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
96 
98  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
99  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
100 
104  bool GetFullyConnected() const { return this->m_FullyConnected; }\
105 
109  SITK_RETURN_SELF_TYPE_HEADER SetFlatIsMaxima ( bool FlatIsMaxima ) { this->m_FlatIsMaxima = FlatIsMaxima; return *this; }
110 
112  SITK_RETURN_SELF_TYPE_HEADER FlatIsMaximaOn() { return this->SetFlatIsMaxima(true); }
113  SITK_RETURN_SELF_TYPE_HEADER FlatIsMaximaOff() { return this->SetFlatIsMaxima(false); }
114 
118  bool GetFlatIsMaxima() const { return this->m_FlatIsMaxima; }
119 
121  std::string GetName() const { return std::string ("RegionalMaximaImageFilter"); }
122 
124  std::string ToString() const;
125 
126 
129  Image Execute ( const Image& image1 );
130 
131  private:
132 
135  using MemberFunctionType = Image (Self::*)( const Image& image1 );
136  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
137 
138 
140 
141  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
142 
143 
144  /* */
145  double m_BackgroundValue{0.0};
146 
147  /* */
148  double m_ForegroundValue{1.0};
149 
150  /* */
151  bool m_FullyConnected{false};
152 
153  bool m_FlatIsMaxima{true};
154 
155 
156  };
157 
168  SITKBasicFilters_EXPORT Image RegionalMaxima ( const Image& image1, double backgroundValue = 0.0, double foregroundValue = 1.0, bool fullyConnected = false, bool flatIsMaxima = true );
169 
171  }
172 }
173 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::RegionalMaximaImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkRegionalMaximaImageFilter.h:80
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RegionalMaximaImageFilter::SetFullyConnected
Self & SetFullyConnected(bool FullyConnected)
Definition: sitkRegionalMaximaImageFilter.h:95
itk::simple::RegionalMaximaImageFilter::GetFlatIsMaxima
bool GetFlatIsMaxima() const
Definition: sitkRegionalMaximaImageFilter.h:118
itk::simple::RegionalMaximaImageFilter::GetFullyConnected
bool GetFullyConnected() const
Definition: sitkRegionalMaximaImageFilter.h:104
itk::simple::ScalarPixelIDTypeList
BasicPixelIDTypeList ScalarPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:59
itk::simple::RegionalMaximaImageFilter::FullyConnectedOff
Self & FullyConnectedOff()
Definition: sitkRegionalMaximaImageFilter.h:99
itk::simple::RegionalMaximaImageFilter::FullyConnectedOn
Self & FullyConnectedOn()
Definition: sitkRegionalMaximaImageFilter.h:98
itk::simple::RegionalMaximaImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRegionalMaximaImageFilter.h:141
sitkImageFilter.h
itk::simple::RegionalMaximaImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkRegionalMaximaImageFilter.h:75
itk::simple::RegionalMaximaImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkRegionalMaximaImageFilter.h:135
itk::simple::RegionalMaximaImageFilter::GetName
std::string GetName() const
Definition: sitkRegionalMaximaImageFilter.h:121
itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOff
Self & FlatIsMaximaOff()
Definition: sitkRegionalMaximaImageFilter.h:113
itk::simple::RegionalMaximaImageFilter
Produce a binary image where foreground is the regional maxima of the input image.
Definition: sitkRegionalMaximaImageFilter.h:57
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:52
itk::simple::RegionalMaximaImageFilter::FlatIsMaximaOn
Self & FlatIsMaximaOn()
Definition: sitkRegionalMaximaImageFilter.h:112
itk::simple::RegionalMaximaImageFilter::SetFlatIsMaxima
Self & SetFlatIsMaxima(bool FlatIsMaxima)
Definition: sitkRegionalMaximaImageFilter.h:109
itk::simple::RegionalMaximaImageFilter::PixelIDTypeList
ScalarPixelIDTypeList PixelIDTypeList
Definition: sitkRegionalMaximaImageFilter.h:69
itk
itk::simple::RegionalMaximaImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkRegionalMaximaImageFilter.h:85
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::RegionalMaximaImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkRegionalMaximaImageFilter.h:90