SimpleITK  2.0.0
sitkIsolatedWatershedImageFilter.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 sitkIsolatedWatershedImageFilter_h
19 #define sitkIsolatedWatershedImageFilter_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 
43  public:
45 
48 
52 
55 \
56 
60  SITK_RETURN_SELF_TYPE_HEADER SetSeed1 ( std::vector<uint32_t> Seed1 ) { this->m_Seed1 = std::move(Seed1); return *this; }
61 
65  std::vector<uint32_t> GetSeed1() const { return this->m_Seed1; }\
66 
70  SITK_RETURN_SELF_TYPE_HEADER SetSeed2 ( std::vector<uint32_t> Seed2 ) { this->m_Seed2 = std::move(Seed2); return *this; }
71 
75  std::vector<uint32_t> GetSeed2() const { return this->m_Seed2; }\
76 
80  SITK_RETURN_SELF_TYPE_HEADER SetThreshold ( double Threshold ) { this->m_Threshold = Threshold; return *this; }
81 
85  double GetThreshold() const { return this->m_Threshold; }\
86 
90  SITK_RETURN_SELF_TYPE_HEADER SetUpperValueLimit ( double UpperValueLimit ) { this->m_UpperValueLimit = UpperValueLimit; return *this; }
91 
95  double GetUpperValueLimit() const { return this->m_UpperValueLimit; }\
96 
100  SITK_RETURN_SELF_TYPE_HEADER SetIsolatedValueTolerance ( double IsolatedValueTolerance ) { this->m_IsolatedValueTolerance = IsolatedValueTolerance; return *this; }
101 
105  double GetIsolatedValueTolerance() const { return this->m_IsolatedValueTolerance; }\
106 
110  SITK_RETURN_SELF_TYPE_HEADER SetReplaceValue1 ( uint8_t ReplaceValue1 ) { this->m_ReplaceValue1 = ReplaceValue1; return *this; }
111 
115  uint8_t GetReplaceValue1() const { return this->m_ReplaceValue1; }\
116 
120  SITK_RETURN_SELF_TYPE_HEADER SetReplaceValue2 ( uint8_t ReplaceValue2 ) { this->m_ReplaceValue2 = ReplaceValue2; return *this; }
121 
125  uint8_t GetReplaceValue2() const { return this->m_ReplaceValue2; }
126 
128  std::string GetName() const { return std::string ("IsolatedWatershedImageFilter"); }
129 
131  std::string ToString() const;
132 
133 
136  Image Execute ( const Image& image1 );
137 
138  private:
139 
142  using MemberFunctionType = Image (Self::*)( const Image& image1 );
143  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
144 
145 
147 
148  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
149 
150 
151  /* */
152  std::vector<uint32_t> m_Seed1{std::vector<uint32_t>(3, 0)};
153 
154  /* */
155  std::vector<uint32_t> m_Seed2{std::vector<uint32_t>(3, 0)};
156 
157  double m_Threshold{0.0};
158 
159  double m_UpperValueLimit{1.0};
160 
161  double m_IsolatedValueTolerance{0.001};
162 
163  uint8_t m_ReplaceValue1{1u};
164 
165  uint8_t m_ReplaceValue2{2u};
166 
167 
168  };
169 
180  SITKBasicFilters_EXPORT Image IsolatedWatershed ( const Image& image1, std::vector<uint32_t> seed1 = std::vector<uint32_t>(3, 0), std::vector<uint32_t> seed2 = std::vector<uint32_t>(3, 0), double threshold = 0.0, double upperValueLimit = 1.0, double isolatedValueTolerance = 0.001, uint8_t replaceValue1 = 1u, uint8_t replaceValue2 = 2u );
181 
183  }
184 }
185 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::IsolatedWatershedImageFilter::GetReplaceValue1
uint8_t GetReplaceValue1() const
Definition: sitkIsolatedWatershedImageFilter.h:115
sitkBasicFilters.h
itk::uint8_t
::uint8_t uint8_t
itk::simple::IsolatedWatershedImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkIsolatedWatershedImageFilter.h:148
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::IsolatedWatershedImageFilter::GetSeed2
std::vector< uint32_t > GetSeed2() const
Definition: sitkIsolatedWatershedImageFilter.h:75
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
itk::simple::IsolatedWatershedImageFilter::GetSeed1
std::vector< uint32_t > GetSeed1() const
Definition: sitkIsolatedWatershedImageFilter.h:65
sitkImageFilter.h
itk::simple::IsolatedWatershedImageFilter::SetSeed1
Self & SetSeed1(std::vector< uint32_t > Seed1)
Definition: sitkIsolatedWatershedImageFilter.h:60
itk::simple::IsolatedWatershedImageFilter::SetReplaceValue2
Self & SetReplaceValue2(uint8_t ReplaceValue2)
Definition: sitkIsolatedWatershedImageFilter.h:120
itk::simple::IsolatedWatershedImageFilter
Isolate watershed basins using two seeds.
Definition: sitkIsolatedWatershedImageFilter.h:42
itk::simple::IsolatedWatershedImageFilter::GetName
std::string GetName() const
Definition: sitkIsolatedWatershedImageFilter.h:128
itk::simple::IsolatedWatershedImageFilter::SetSeed2
Self & SetSeed2(std::vector< uint32_t > Seed2)
Definition: sitkIsolatedWatershedImageFilter.h:70
itk::simple::IsolatedWatershedImageFilter::GetIsolatedValueTolerance
double GetIsolatedValueTolerance() const
Definition: sitkIsolatedWatershedImageFilter.h:105
itk::simple::IsolatedWatershedImageFilter::GetReplaceValue2
uint8_t GetReplaceValue2() const
Definition: sitkIsolatedWatershedImageFilter.h:125
itk::simple::IsolatedWatershedImageFilter::GetUpperValueLimit
double GetUpperValueLimit() const
Definition: sitkIsolatedWatershedImageFilter.h:95
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::IsolatedWatershedImageFilter::SetThreshold
Self & SetThreshold(double Threshold)
Definition: sitkIsolatedWatershedImageFilter.h:80
itk::simple::IsolatedWatershedImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkIsolatedWatershedImageFilter.h:142
itk::simple::IsolatedWatershedImageFilter::SetReplaceValue1
Self & SetReplaceValue1(uint8_t ReplaceValue1)
Definition: sitkIsolatedWatershedImageFilter.h:110
itk::simple::Threshold
Image Threshold(Image &&image1, double lower=0.0, double upper=1.0, double outsideValue=0.0)
Set image values to a user-specified value if they are below, above, or between simple threshold valu...
itk
itk::simple::IsolatedWatershedImageFilter::SetUpperValueLimit
Self & SetUpperValueLimit(double UpperValueLimit)
Definition: sitkIsolatedWatershedImageFilter.h:90
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::IsolatedWatershed
Image IsolatedWatershed(const Image &image1, std::vector< uint32_t > seed1=std::vector< uint32_t >(3, 0), std::vector< uint32_t > seed2=std::vector< uint32_t >(3, 0), double threshold=0.0, double upperValueLimit=1.0, double isolatedValueTolerance=0.001, uint8_t replaceValue1=1u, uint8_t replaceValue2=2u)
Isolate watershed basins using two seeds.
itk::simple::IsolatedWatershedImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkIsolatedWatershedImageFilter.h:54
itk::simple::IsolatedWatershedImageFilter::GetThreshold
double GetThreshold() const
Definition: sitkIsolatedWatershedImageFilter.h:85
itk::simple::IsolatedWatershedImageFilter::SetIsolatedValueTolerance
Self & SetIsolatedValueTolerance(double IsolatedValueTolerance)
Definition: sitkIsolatedWatershedImageFilter.h:100