SimpleITK  
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::simple {
33 
46  public:
48 
51 
55 
58 \
59 
63  SITK_RETURN_SELF_TYPE_HEADER SetSeedList ( std::vector< std::vector<unsigned int> > SeedList ) { this->m_SeedList = std::move(SeedList); return *this; }
64 
68  std::vector< std::vector< unsigned int > > GetSeedList() const { return this->m_SeedList; }
70  SITK_RETURN_SELF_TYPE_HEADER AddSeed( std::vector< unsigned int > point ) { this->m_SeedList.push_back(std::move(point)); return *this;}
72  SITK_RETURN_SELF_TYPE_HEADER ClearSeeds( ) { this->m_SeedList.clear(); return *this;}
73 \
74 
78  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfIterations ( unsigned int NumberOfIterations ) { this->m_NumberOfIterations = NumberOfIterations; return *this; }
79 
83  unsigned int GetNumberOfIterations() const { return this->m_NumberOfIterations; }\
84 
88  SITK_RETURN_SELF_TYPE_HEADER SetMultiplier ( double Multiplier ) { this->m_Multiplier = Multiplier; return *this; }
89 
93  double GetMultiplier() const { return this->m_Multiplier; }\
94 
98  SITK_RETURN_SELF_TYPE_HEADER SetInitialNeighborhoodRadius ( unsigned int InitialNeighborhoodRadius ) { this->m_InitialNeighborhoodRadius = InitialNeighborhoodRadius; return *this; }
99 
103  unsigned int GetInitialNeighborhoodRadius() const { return this->m_InitialNeighborhoodRadius; }\
104 
108  SITK_RETURN_SELF_TYPE_HEADER SetReplaceValue ( uint8_t ReplaceValue ) { this->m_ReplaceValue = ReplaceValue; return *this; }
109 
113  uint8_t GetReplaceValue() const { return this->m_ReplaceValue; }
120  double GetMean() const { return this->m_Mean; };
121 
128  double GetVariance() const { return this->m_Variance; };
129 
130 
132  std::string GetName() const { return std::string ("ConfidenceConnectedImageFilter"); }
133 
135  std::string ToString() const;
136 
137 
140  Image Execute ( const Image& image1 );
141 
142  private:
143 
146  using MemberFunctionType = Image (Self::*)( const Image& image1 );
147  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
148 
149 
151 
152  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
153 
154 
155  std::vector< std::vector<unsigned int> > m_SeedList{std::vector< std::vector<unsigned int > >()};
156 
157  unsigned int m_NumberOfIterations{4u};
158 
159  double m_Multiplier{4.5};
160 
161  unsigned int m_InitialNeighborhoodRadius{1u};
162 
163  uint8_t m_ReplaceValue{1u};
164 
165  /* Some global documentation */
166  double m_Mean{0.0};
167  /* Some global documentation */
168  double m_Variance{0.0};
169 
170 
171  };
172 
183  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 );
184 
186 }
187 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::ConfidenceConnectedImageFilter::ClearSeeds
Self & ClearSeeds()
Remove all SeedList points.
Definition: sitkConfidenceConnectedImageFilter.h:72
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::ConfidenceConnectedImageFilter::SetSeedList
Self & SetSeedList(std::vector< std::vector< unsigned int > > SeedList)
Set list of image indexes for seeds.
Definition: sitkConfidenceConnectedImageFilter.h:63
itk::simple::ConfidenceConnectedImageFilter::GetName
std::string GetName() const
Definition: sitkConfidenceConnectedImageFilter.h:132
itk::simple::ConfidenceConnectedImageFilter::SetNumberOfIterations
Self & SetNumberOfIterations(unsigned int NumberOfIterations)
Definition: sitkConfidenceConnectedImageFilter.h:78
sitkImageFilter.h
itk::simple::ConfidenceConnectedImageFilter::GetMean
double GetMean() const
Definition: sitkConfidenceConnectedImageFilter.h:120
itk::simple::ConfidenceConnectedImageFilter::GetVariance
double GetVariance() const
Definition: sitkConfidenceConnectedImageFilter.h:128
itk::simple::ConfidenceConnectedImageFilter::GetMultiplier
double GetMultiplier() const
Definition: sitkConfidenceConnectedImageFilter.h:93
itk::simple::ConfidenceConnectedImageFilter::GetInitialNeighborhoodRadius
unsigned int GetInitialNeighborhoodRadius() const
Definition: sitkConfidenceConnectedImageFilter.h:103
itk::simple::ConfidenceConnectedImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkConfidenceConnectedImageFilter.h:146
itk::point
*par Constraints *The filter requires an image with at least two dimensions and a vector *length of at least The theory supports extension to scalar but *the implementation of the itk vector classes do not **The template parameter TRealType must be floating point(float or double) or *a user-defined "real" numerical type with arithmetic operations defined *sufficient to compute derivatives. **\par Performance *This filter will automatically multithread if run with *SetUsePrincipleComponents
itk::simple::ConfidenceConnectedImageFilter
Segment pixels with similar statistics using connectivity.
Definition: sitkConfidenceConnectedImageFilter.h:45
itk::simple::ConfidenceConnectedImageFilter::GetSeedList
std::vector< std::vector< unsigned int > > GetSeedList() const
Get list of seeds.
Definition: sitkConfidenceConnectedImageFilter.h:68
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ConfidenceConnectedImageFilter::SetReplaceValue
Self & SetReplaceValue(uint8_t ReplaceValue)
Definition: sitkConfidenceConnectedImageFilter.h:108
itk::simple::ConfidenceConnectedImageFilter::GetReplaceValue
uint8_t GetReplaceValue() const
Definition: sitkConfidenceConnectedImageFilter.h:113
itk::simple::ConfidenceConnectedImageFilter::SetInitialNeighborhoodRadius
Self & SetInitialNeighborhoodRadius(unsigned int InitialNeighborhoodRadius)
Definition: sitkConfidenceConnectedImageFilter.h:98
itk::simple::ConfidenceConnectedImageFilter::GetNumberOfIterations
unsigned int GetNumberOfIterations() const
Definition: sitkConfidenceConnectedImageFilter.h:83
itk::simple::ConfidenceConnectedImageFilter::SetMultiplier
Self & SetMultiplier(double Multiplier)
Definition: sitkConfidenceConnectedImageFilter.h:88
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::ConfidenceConnectedImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkConfidenceConnectedImageFilter.h:152
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::ConfidenceConnectedImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkConfidenceConnectedImageFilter.h:57
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
Definition: sitkAdditionalProcedures.h:28
itk::simple::ConfidenceConnectedImageFilter::AddSeed
Self & AddSeed(std::vector< unsigned int > point)
Add SeedList point.
Definition: sitkConfidenceConnectedImageFilter.h:70