SimpleITK  
sitkScalarImageKmeansImageFilter.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 sitkScalarImageKmeansImageFilter_h
19 #define sitkScalarImageKmeansImageFilter_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 
60 
64 
67 \
68 
71  SITK_RETURN_SELF_TYPE_HEADER SetClassWithInitialMean ( std::vector<double> ClassWithInitialMean ) { this->m_ClassWithInitialMean = ClassWithInitialMean; return *this; }
72 
75  std::vector<double> GetClassWithInitialMean() const { return this->m_ClassWithInitialMean; }\
76 
80  SITK_RETURN_SELF_TYPE_HEADER SetUseNonContiguousLabels ( bool UseNonContiguousLabels ) { this->m_UseNonContiguousLabels = UseNonContiguousLabels; return *this; }
81 
83  SITK_RETURN_SELF_TYPE_HEADER UseNonContiguousLabelsOn() { return this->SetUseNonContiguousLabels(true); }
84  SITK_RETURN_SELF_TYPE_HEADER UseNonContiguousLabelsOff() { return this->SetUseNonContiguousLabels(false); }
85 
89  bool GetUseNonContiguousLabels() const { return this->m_UseNonContiguousLabels; }
96  std::vector<double> GetFinalMeans() const { return this->m_FinalMeans; };
97 
98 
100  std::string GetName() const { return std::string ("ScalarImageKmeansImageFilter"); }
101 
103  std::string ToString() const;
104 
105 
108  Image Execute ( const Image& image1 );
109 
110  private:
111 
114  using MemberFunctionType = Image (Self::*)( const Image& image1 );
115  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
116 
117 
119 
120  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
121 
122 
123  std::vector<double> m_ClassWithInitialMean{std::vector<double>()};
124 
125  /* */
126  bool m_UseNonContiguousLabels{false};
127 
128  /* Docs */
129  std::vector<double> m_FinalMeans{std::vector<double>()};
130 
131 
132  };
133 
144  SITKBasicFilters_EXPORT Image ScalarImageKmeans ( const Image& image1, std::vector<double> classWithInitialMean = std::vector<double>(), bool useNonContiguousLabels = false );
145 
147 }
148 #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::ScalarImageKmeansImageFilter::GetName
std::string GetName() const
Definition: sitkScalarImageKmeansImageFilter.h:100
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::ScalarImageKmeansImageFilter::SetClassWithInitialMean
Self & SetClassWithInitialMean(std::vector< double > ClassWithInitialMean)
Definition: sitkScalarImageKmeansImageFilter.h:71
itk::simple::ScalarImageKmeansImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkScalarImageKmeansImageFilter.h:120
itk::simple::ScalarImageKmeansImageFilter::GetClassWithInitialMean
std::vector< double > GetClassWithInitialMean() const
Definition: sitkScalarImageKmeansImageFilter.h:75
sitkImageFilter.h
itk::simple::ScalarImageKmeansImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkScalarImageKmeansImageFilter.h:114
itk::simple::ScalarImageKmeans
Image ScalarImageKmeans(const Image &image1, std::vector< double > classWithInitialMean=std::vector< double >(), bool useNonContiguousLabels=false)
Classifies the intensity values of a scalar image using the K-Means algorithm.
itk::simple::ScalarImageKmeansImageFilter
Classifies the intensity values of a scalar image using the K-Means algorithm.
Definition: sitkScalarImageKmeansImageFilter.h:54
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ScalarImageKmeansImageFilter::UseNonContiguousLabelsOff
Self & UseNonContiguousLabelsOff()
Definition: sitkScalarImageKmeansImageFilter.h:84
itk::simple::ScalarImageKmeansImageFilter::GetFinalMeans
std::vector< double > GetFinalMeans() const
Definition: sitkScalarImageKmeansImageFilter.h:96
itk::simple::ScalarImageKmeansImageFilter::GetUseNonContiguousLabels
bool GetUseNonContiguousLabels() const
Definition: sitkScalarImageKmeansImageFilter.h:89
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::ScalarImageKmeansImageFilter::UseNonContiguousLabelsOn
Self & UseNonContiguousLabelsOn()
Definition: sitkScalarImageKmeansImageFilter.h:83
itk::simple::ScalarImageKmeansImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkScalarImageKmeansImageFilter.h:66
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::ScalarImageKmeansImageFilter::SetUseNonContiguousLabels
Self & SetUseNonContiguousLabels(bool UseNonContiguousLabels)
Definition: sitkScalarImageKmeansImageFilter.h:80