SimpleITK  1.1.0
sitkScalarImageKmeansImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 {
33  namespace simple {
34 
59  public:
61 
64 
68 
71 
72 
73 
76  SITK_RETURN_SELF_TYPE_HEADER SetClassWithInitialMean ( std::vector<double> ClassWithInitialMean ) { this->m_ClassWithInitialMean = ClassWithInitialMean; return *this; }
77 
80  std::vector<double> GetClassWithInitialMean() const { return this->m_ClassWithInitialMean; }
81 
85  SITK_RETURN_SELF_TYPE_HEADER SetUseNonContiguousLabels ( bool UseNonContiguousLabels ) { this->m_UseNonContiguousLabels = UseNonContiguousLabels; return *this; }
86 
88  SITK_RETURN_SELF_TYPE_HEADER UseNonContiguousLabelsOn() { return this->SetUseNonContiguousLabels(true); }
89  SITK_RETURN_SELF_TYPE_HEADER UseNonContiguousLabelsOff() { return this->SetUseNonContiguousLabels(false); }
90 
94  bool GetUseNonContiguousLabels() const { return this->m_UseNonContiguousLabels; }
101  std::vector<double> GetFinalMeans() const { return this->m_FinalMeans; };
102 
104  std::string GetName() const { return std::string ("ScalarImageKmeansImageFilter"); }
105 
107  std::string ToString() const;
108 
109 
111  Image Execute ( const Image& image1 );
112 
113 
115  Image Execute ( const Image& image1, std::vector<double> classWithInitialMean, bool useNonContiguousLabels );
116 
117  private:
118 
121  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
122  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
123 
124 
125  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
126 
127  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
128 
129 
130  std::vector<double> m_ClassWithInitialMean;
131  /* */
133  /* Docs */
134  std::vector<double> m_FinalMeans;
135 
136  };
137 
138 
147  SITKBasicFilters_EXPORT Image ScalarImageKmeans ( const Image& image1, std::vector<double> classWithInitialMean = std::vector<double>(), bool useNonContiguousLabels = false );
148 
149  }
150 }
151 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::ScalarImageKmeansImageFilter::Self
ScalarImageKmeansImageFilter Self
Definition: sitkScalarImageKmeansImageFilter.h:60
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::ScalarImageKmeansImageFilter::GetName
std::string GetName() const
Definition: sitkScalarImageKmeansImageFilter.h:104
itk::simple::ScalarImageKmeansImageFilter::SetClassWithInitialMean
Self & SetClassWithInitialMean(std::vector< double > ClassWithInitialMean)
Definition: sitkScalarImageKmeansImageFilter.h:76
itk::simple::ScalarImageKmeansImageFilter::m_ClassWithInitialMean
std::vector< double > m_ClassWithInitialMean
Definition: sitkScalarImageKmeansImageFilter.h:130
itk::simple::ScalarImageKmeansImageFilter::GetClassWithInitialMean
std::vector< double > GetClassWithInitialMean() const
Definition: sitkScalarImageKmeansImageFilter.h:80
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::ScalarImageKmeansImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkScalarImageKmeansImageFilter.h:127
sitkImageFilter.h
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::m_FinalMeans
std::vector< double > m_FinalMeans
Definition: sitkScalarImageKmeansImageFilter.h:134
itk::simple::ScalarImageKmeansImageFilter
Classifies the intensity values of a scalar image using the K-Means algorithm.
Definition: sitkScalarImageKmeansImageFilter.h:58
itk::simple::ScalarImageKmeansImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkScalarImageKmeansImageFilter.h:70
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::ScalarImageKmeansImageFilter::UseNonContiguousLabelsOff
Self & UseNonContiguousLabelsOff()
Definition: sitkScalarImageKmeansImageFilter.h:89
itk::simple::ScalarImageKmeansImageFilter::GetFinalMeans
std::vector< double > GetFinalMeans() const
Definition: sitkScalarImageKmeansImageFilter.h:101
itk::simple::ScalarImageKmeansImageFilter::GetUseNonContiguousLabels
bool GetUseNonContiguousLabels() const
Definition: sitkScalarImageKmeansImageFilter.h:94
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::ScalarImageKmeansImageFilter::m_UseNonContiguousLabels
bool m_UseNonContiguousLabels
Definition: sitkScalarImageKmeansImageFilter.h:132
itk::simple::ScalarImageKmeansImageFilter::UseNonContiguousLabelsOn
Self & UseNonContiguousLabelsOn()
Definition: sitkScalarImageKmeansImageFilter.h:88
itk::simple::ScalarImageKmeansImageFilter::SetUseNonContiguousLabels
Self & SetUseNonContiguousLabels(bool UseNonContiguousLabels)
Definition: sitkScalarImageKmeansImageFilter.h:85