SimpleITK  2.0.0rc2.post21
sitkRegionalMinimaImageFilter.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 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 
56  public:
58 
60  virtual ~RegionalMinimaImageFilter();
61 
65 
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 SetFlatIsMinima ( bool FlatIsMinima ) { this->m_FlatIsMinima = FlatIsMinima; return *this; }
108 
110  SITK_RETURN_SELF_TYPE_HEADER FlatIsMinimaOn() { return this->SetFlatIsMinima(true); }
111  SITK_RETURN_SELF_TYPE_HEADER FlatIsMinimaOff() { return this->SetFlatIsMinima(false); }
112 
116  bool GetFlatIsMinima() const { return this->m_FlatIsMinima; }
117 
119  std::string GetName() const { return std::string ("RegionalMinimaImageFilter"); }
120 
122  std::string ToString() const;
123 
124 
127  Image Execute ( const Image& image1 );
128 
129  private:
130 
133  using MemberFunctionType = Image (Self::*)( const Image& image1 );
134  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
135 
136 
138 
139  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
140 
141 
142  /* */
143  double m_BackgroundValue{0.0};
144 
145  /* */
146  double m_ForegroundValue{1.0};
147 
148  /* */
149  bool m_FullyConnected{false};
150 
151  bool m_FlatIsMinima{true};
152 
153 
154  };
155 
166  SITKBasicFilters_EXPORT Image RegionalMinima ( const Image& image1, double backgroundValue = 0.0, double foregroundValue = 1.0, bool fullyConnected = false, bool flatIsMinima = true );
167 
169  }
170 }
171 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::RegionalMinimaImageFilter::SetFullyConnected
Self & SetFullyConnected(bool FullyConnected)
Definition: sitkRegionalMinimaImageFilter.h:93
itk::simple::RegionalMinimaImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkRegionalMinimaImageFilter.h:88
itk::simple::RegionalMinimaImageFilter::GetFullyConnected
bool GetFullyConnected() const
Definition: sitkRegionalMinimaImageFilter.h:102
itk::simple::RegionalMinimaImageFilter::SetFlatIsMinima
Self & SetFlatIsMinima(bool FlatIsMinima)
Definition: sitkRegionalMinimaImageFilter.h:107
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RegionalMinimaImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkRegionalMinimaImageFilter.h:73
itk::simple::ScalarPixelIDTypeList
BasicPixelIDTypeList ScalarPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:59
sitkImageFilter.h
itk::simple::RegionalMinimaImageFilter::PixelIDTypeList
ScalarPixelIDTypeList PixelIDTypeList
Definition: sitkRegionalMinimaImageFilter.h:67
itk::simple::RegionalMinimaImageFilter::GetName
std::string GetName() const
Definition: sitkRegionalMinimaImageFilter.h:119
itk::simple::RegionalMinimaImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRegionalMinimaImageFilter.h:139
itk::simple::RegionalMinimaImageFilter
Produce a binary image where foreground is the regional minima of the input image.
Definition: sitkRegionalMinimaImageFilter.h:55
itk::simple::RegionalMinimaImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkRegionalMinimaImageFilter.h:78
itk::simple::RegionalMinimaImageFilter::GetFlatIsMinima
bool GetFlatIsMinima() const
Definition: sitkRegionalMinimaImageFilter.h:116
itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOn
Self & FlatIsMinimaOn()
Definition: sitkRegionalMinimaImageFilter.h:110
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOff
Self & FlatIsMinimaOff()
Definition: sitkRegionalMinimaImageFilter.h:111
itk
itk::simple::RegionalMinimaImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkRegionalMinimaImageFilter.h:83
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::RegionalMinimaImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkRegionalMinimaImageFilter.h:133
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::RegionalMinimaImageFilter::FullyConnectedOn
Self & FullyConnectedOn()
Definition: sitkRegionalMinimaImageFilter.h:96
itk::simple::RegionalMinimaImageFilter::FullyConnectedOff
Self & FullyConnectedOff()
Definition: sitkRegionalMinimaImageFilter.h:97
itk::simple::RegionalMinima
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.