SimpleITK  
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::simple {
33 
55  public:
57 
59  virtual ~RegionalMinimaImageFilter();
60 
64 
67 \
68 
72  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
73 
77  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
78 
82  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
83 
87  double GetForegroundValue() const { return this->m_ForegroundValue; }\
88 
92  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
93 
95  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
96  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
97 
101  bool GetFullyConnected() const { return this->m_FullyConnected; }\
102 
106  SITK_RETURN_SELF_TYPE_HEADER SetFlatIsMinima ( bool FlatIsMinima ) { this->m_FlatIsMinima = FlatIsMinima; return *this; }
107 
109  SITK_RETURN_SELF_TYPE_HEADER FlatIsMinimaOn() { return this->SetFlatIsMinima(true); }
110  SITK_RETURN_SELF_TYPE_HEADER FlatIsMinimaOff() { return this->SetFlatIsMinima(false); }
111 
115  bool GetFlatIsMinima() const { return this->m_FlatIsMinima; }
116 
118  std::string GetName() const { return std::string ("RegionalMinimaImageFilter"); }
119 
121  std::string ToString() const;
122 
123 
126  Image Execute ( const Image& image1 );
127 
128  private:
129 
132  using MemberFunctionType = Image (Self::*)( const Image& image1 );
133  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
134 
135 
137 
138  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
139 
140 
141  /* */
142  double m_BackgroundValue{0.0};
143 
144  /* */
145  double m_ForegroundValue{1.0};
146 
147  /* */
148  bool m_FullyConnected{false};
149 
150  bool m_FlatIsMinima{true};
151 
152 
153  };
154 
165  SITKBasicFilters_EXPORT Image RegionalMinima ( const Image& image1, double backgroundValue = 0.0, double foregroundValue = 1.0, bool fullyConnected = false, bool flatIsMinima = true );
166 
168 }
169 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::RegionalMinimaImageFilter::SetFullyConnected
Self & SetFullyConnected(bool FullyConnected)
Definition: sitkRegionalMinimaImageFilter.h:92
itk::simple::RegionalMinimaImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkRegionalMinimaImageFilter.h:87
itk::simple::RegionalMinimaImageFilter::GetFullyConnected
bool GetFullyConnected() const
Definition: sitkRegionalMinimaImageFilter.h:101
itk::simple::RegionalMinimaImageFilter::SetFlatIsMinima
Self & SetFlatIsMinima(bool FlatIsMinima)
Definition: sitkRegionalMinimaImageFilter.h:106
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::RegionalMinimaImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkRegionalMinimaImageFilter.h:72
itk::simple::ScalarPixelIDTypeList
BasicPixelIDTypeList ScalarPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:57
sitkImageFilter.h
itk::simple::RegionalMinimaImageFilter::PixelIDTypeList
ScalarPixelIDTypeList PixelIDTypeList
Definition: sitkRegionalMinimaImageFilter.h:66
itk::simple::RegionalMinimaImageFilter::GetName
std::string GetName() const
Definition: sitkRegionalMinimaImageFilter.h:118
itk::simple::RegionalMinimaImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRegionalMinimaImageFilter.h:138
itk::simple::RegionalMinimaImageFilter
Produce a binary image where foreground is the regional minima of the input image.
Definition: sitkRegionalMinimaImageFilter.h:54
itk::simple::RegionalMinimaImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkRegionalMinimaImageFilter.h:77
itk::simple::RegionalMinimaImageFilter::GetFlatIsMinima
bool GetFlatIsMinima() const
Definition: sitkRegionalMinimaImageFilter.h:115
itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOn
Self & FlatIsMinimaOn()
Definition: sitkRegionalMinimaImageFilter.h:109
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOff
Self & FlatIsMinimaOff()
Definition: sitkRegionalMinimaImageFilter.h:110
itk::simple::RegionalMinimaImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkRegionalMinimaImageFilter.h:82
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::RegionalMinimaImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkRegionalMinimaImageFilter.h:132
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::RegionalMinimaImageFilter::FullyConnectedOn
Self & FullyConnectedOn()
Definition: sitkRegionalMinimaImageFilter.h:95
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::RegionalMinimaImageFilter::FullyConnectedOff
Self & FullyConnectedOff()
Definition: sitkRegionalMinimaImageFilter.h:96
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.