SimpleITK  2.0.0
sitkConfidenceConnectedImageFilter.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 sitkConfidenceConnectedImageFilter_h
19 #define sitkConfidenceConnectedImageFilter_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 
47  public:
49 
52 
56 
59 \
60 
64  SITK_RETURN_SELF_TYPE_HEADER SetSeedList ( std::vector< std::vector<unsigned int> > SeedList ) { this->m_SeedList = std::move(SeedList); return *this; }
65 
69  std::vector< std::vector< unsigned int > > GetSeedList() const { return this->m_SeedList; }
71  SITK_RETURN_SELF_TYPE_HEADER AddSeed( std::vector< unsigned int > point ) { this->m_SeedList.push_back(std::move(point)); return *this;}
73  SITK_RETURN_SELF_TYPE_HEADER ClearSeeds( ) { this->m_SeedList.clear(); return *this;}
74 \
75 
79  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( unsigned int NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
80 
84  unsigned int GetNumberOfIterations() const { return this->m_NumberOfIterations; }\
85 
89  SITK_RETURN_SELF_TYPE_HEADER SetMultiplier ( double Multiplier ) { this->m_Multiplier = Multiplier; return *this; }
90 
94  double GetMultiplier() const { return this->m_Multiplier; }\
95 
99  SITK_RETURN_SELF_TYPE_HEADER SetInitialNeighborhoodRadius ( unsigned int InitialNeighborhoodRadius ) { this->m_InitialNeighborhoodRadius = InitialNeighborhoodRadius; return *this; }
100 
104  unsigned int GetInitialNeighborhoodRadius() const { return this->m_InitialNeighborhoodRadius; }\
105 
109  SITK_RETURN_SELF_TYPE_HEADER SetReplaceValue ( uint8_t ReplaceValue ) { this->m_ReplaceValue = ReplaceValue; return *this; }
110 
114  uint8_t GetReplaceValue() const { return this->m_ReplaceValue; }
121  double GetMean() const { return this->m_Mean; };
122 
129  double GetVariance() const { return this->m_Variance; };
130 
131 
133  std::string GetName() const { return std::string ("ConfidenceConnectedImageFilter"); }
134 
136  std::string ToString() const;
137 
138 
141  Image Execute ( const Image& image1 );
142 
143  private:
144 
147  using MemberFunctionType = Image (Self::*)( const Image& image1 );
148  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
149 
150 
152 
153  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
154 
155 
156  std::vector< std::vector<unsigned int> > m_SeedList{std::vector< std::vector<unsigned int > >()};
157 
158  unsigned int m_NumberOfIterations{4u};
159 
160  double m_Multiplier{4.5};
161 
162  unsigned int m_InitialNeighborhoodRadius{1u};
163 
164  uint8_t m_ReplaceValue{1u};
165 
166  /* Some global documentation */
167  double m_Mean{0.0};
168  /* Some global documentation */
169  double m_Variance{0.0};
170 
171 
172  };
173 
184  SITKBasicFilters_EXPORT Image ConfidenceConnected ( const Image& image1, std::vector< std::vector<unsigned int> > seedList = std::vector< std::vector<unsigned int > >(), unsigned int numberOfIterations = 4u, double multiplier = 4.5, unsigned int initialNeighborhoodRadius = 1u, uint8_t replaceValue = 1u );
185 
187  }
188 }
189 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::uint8_t
::uint8_t uint8_t
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::ConfidenceConnectedImageFilter::ClearSeeds
Self & ClearSeeds()
Remove all SeedList points.
Definition: sitkConfidenceConnectedImageFilter.h:73
itk::simple::ConfidenceConnectedImageFilter::SetSeedList
Self & SetSeedList(std::vector< std::vector< unsigned int > > SeedList)
Set list of image indexes for seeds.
Definition: sitkConfidenceConnectedImageFilter.h:64
itk::simple::ConfidenceConnectedImageFilter::GetName
std::string GetName() const
Definition: sitkConfidenceConnectedImageFilter.h:133
itk::simple::ConfidenceConnectedImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(unsigned int NumberOfIterations)
Definition: sitkConfidenceConnectedImageFilter.h:79
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
sitkImageFilter.h
itk::simple::ConfidenceConnectedImageFilter::GetMean
double GetMean() const
Definition: sitkConfidenceConnectedImageFilter.h:121
itk::simple::ConfidenceConnectedImageFilter::GetVariance
double GetVariance() const
Definition: sitkConfidenceConnectedImageFilter.h:129
itk::simple::ConfidenceConnectedImageFilter::GetMultiplier
double GetMultiplier() const
Definition: sitkConfidenceConnectedImageFilter.h:94
itk::simple::ConfidenceConnectedImageFilter::GetInitialNeighborhoodRadius
unsigned int GetInitialNeighborhoodRadius() const
Definition: sitkConfidenceConnectedImageFilter.h:104
itk::simple::ConfidenceConnectedImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkConfidenceConnectedImageFilter.h:147
itk::simple::ConfidenceConnectedImageFilter
Segment pixels with similar statistics using connectivity.
Definition: sitkConfidenceConnectedImageFilter.h:46
itk::simple::ConfidenceConnectedImageFilter::GetSeedList
std::vector< std::vector< unsigned int > > GetSeedList() const
Get list of seeds.
Definition: sitkConfidenceConnectedImageFilter.h:69
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ConfidenceConnectedImageFilter::SetReplaceValue
Self & SetReplaceValue(uint8_t ReplaceValue)
Definition: sitkConfidenceConnectedImageFilter.h:109
itk::simple::ConfidenceConnectedImageFilter::GetReplaceValue
uint8_t GetReplaceValue() const
Definition: sitkConfidenceConnectedImageFilter.h:114
itk::simple::ConfidenceConnectedImageFilter::SetInitialNeighborhoodRadius
Self & SetInitialNeighborhoodRadius(unsigned int InitialNeighborhoodRadius)
Definition: sitkConfidenceConnectedImageFilter.h:99
itk
itk::simple::ConfidenceConnectedImageFilter::GetNumberOfIterations
unsigned int GetNumberOfIterations() const
Definition: sitkConfidenceConnectedImageFilter.h:84
itk::simple::ConfidenceConnectedImageFilter::SetMultiplier
Self & SetMultiplier(double Multiplier)
Definition: sitkConfidenceConnectedImageFilter.h:89
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::ConfidenceConnectedImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkConfidenceConnectedImageFilter.h:153
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::ConfidenceConnectedImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkConfidenceConnectedImageFilter.h:58
itk::simple::ConfidenceConnected
Image ConfidenceConnected(const Image &image1, std::vector< std::vector< unsigned int > > seedList=std::vector< std::vector< unsigned int > >(), unsigned int numberOfIterations=4u, double multiplier=4.5, unsigned int initialNeighborhoodRadius=1u, uint8_t replaceValue=1u)
Segment pixels with similar statistics using connectivity.
itk::simple::ConfidenceConnectedImageFilter::AddSeed
Self & AddSeed(std::vector< unsigned int > point)
Add SeedList point.
Definition: sitkConfidenceConnectedImageFilter.h:71