SimpleITK  2.0.0
sitkRelabelComponentImageFilter.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 sitkRelabelComponentImageFilter_h
19 #define sitkRelabelComponentImageFilter_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 
55  public:
57 
59  virtual ~RelabelComponentImageFilter();
60 
64 
67 \
68 
72  SITK_RETURN_SELF_TYPE_HEADER SetMinimumObjectSize ( uint64_t MinimumObjectSize ) { this->m_MinimumObjectSize = MinimumObjectSize; return *this; }
73 
77  uint64_t GetMinimumObjectSize() const { return this->m_MinimumObjectSize; }\
78 
82  SITK_RETURN_SELF_TYPE_HEADER SetSortByObjectSize ( bool SortByObjectSize ) { this->m_SortByObjectSize = SortByObjectSize; return *this; }
83 
85  SITK_RETURN_SELF_TYPE_HEADER SortByObjectSizeOn() { return this->SetSortByObjectSize(true); }
86  SITK_RETURN_SELF_TYPE_HEADER SortByObjectSizeOff() { return this->SetSortByObjectSize(false); }
87 
91  bool GetSortByObjectSize() const { return this->m_SortByObjectSize; }
98  uint32_t GetNumberOfObjects() const { return this->m_NumberOfObjects; };
99 
106  uint32_t GetOriginalNumberOfObjects() const { return this->m_OriginalNumberOfObjects; };
107 
114  std::vector<float> GetSizeOfObjectsInPhysicalUnits() const { return this->m_SizeOfObjectsInPhysicalUnits; };
115 
122  std::vector<uint64_t> GetSizeOfObjectsInPixels() const { return this->m_SizeOfObjectsInPixels; };
123 
124 
126  std::string GetName() const { return std::string ("RelabelComponentImageFilter"); }
127 
129  std::string ToString() const;
130 
131 
133 #ifndef SWIG
134  Image Execute ( Image&& image1 );
135 #endif
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  uint64_t m_MinimumObjectSize{0u};
152 
153  bool m_SortByObjectSize{true};
154 
155  /* */
156  uint32_t m_NumberOfObjects{0u};
157  /* */
158  uint32_t m_OriginalNumberOfObjects{0u};
159  /* */
160  std::vector<float> m_SizeOfObjectsInPhysicalUnits{std::vector<float>()};
161  /* */
162  std::vector<uint64_t> m_SizeOfObjectsInPixels{std::vector<uint64_t>()};
163 
164 
165  bool m_InPlace{false};
166  };
167 
177 #ifndef SWIG
178  SITKBasicFilters_EXPORT Image RelabelComponent ( Image&& image1, uint64_t minimumObjectSize = 0u, bool sortByObjectSize = true );
179 #endif
180  SITKBasicFilters_EXPORT Image RelabelComponent ( const Image& image1, uint64_t minimumObjectSize = 0u, bool sortByObjectSize = true );
181 
183  }
184 }
185 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RelabelComponentImageFilter::SortByObjectSizeOff
Self & SortByObjectSizeOff()
Definition: sitkRelabelComponentImageFilter.h:86
itk::simple::RelabelComponentImageFilter::SetSortByObjectSize
Self & SetSortByObjectSize(bool SortByObjectSize)
Definition: sitkRelabelComponentImageFilter.h:82
itk::simple::RelabelComponentImageFilter::GetName
std::string GetName() const
Definition: sitkRelabelComponentImageFilter.h:126
sitkImageFilter.h
itk::simple::RelabelComponentImageFilter::GetNumberOfObjects
uint32_t GetNumberOfObjects() const
Definition: sitkRelabelComponentImageFilter.h:98
itk::simple::RelabelComponentImageFilter
Relabel the components in an image such that consecutive labels are used.
Definition: sitkRelabelComponentImageFilter.h:54
itk::simple::RelabelComponentImageFilter::SortByObjectSizeOn
Self & SortByObjectSizeOn()
Definition: sitkRelabelComponentImageFilter.h:85
itk::uint64_t
::uint64_t uint64_t
itk::simple::RelabelComponentImageFilter::GetSizeOfObjectsInPixels
std::vector< uint64_t > GetSizeOfObjectsInPixels() const
Definition: sitkRelabelComponentImageFilter.h:122
itk::simple::RelabelComponentImageFilter::SetMinimumObjectSize
Self & SetMinimumObjectSize(uint64_t MinimumObjectSize)
Definition: sitkRelabelComponentImageFilter.h:72
itk::simple::RelabelComponentImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRelabelComponentImageFilter.h:148
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::RelabelComponentImageFilter::GetSizeOfObjectsInPhysicalUnits
std::vector< float > GetSizeOfObjectsInPhysicalUnits() const
Definition: sitkRelabelComponentImageFilter.h:114
itk::simple::RelabelComponentImageFilter::GetMinimumObjectSize
uint64_t GetMinimumObjectSize() const
Definition: sitkRelabelComponentImageFilter.h:77
itk
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::RelabelComponentImageFilter::GetSortByObjectSize
bool GetSortByObjectSize() const
Definition: sitkRelabelComponentImageFilter.h:91
itk::uint32_t
::uint32_t uint32_t
itk::simple::RelabelComponentImageFilter::GetOriginalNumberOfObjects
uint32_t GetOriginalNumberOfObjects() const
Definition: sitkRelabelComponentImageFilter.h:106
itk::simple::RelabelComponentImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkRelabelComponentImageFilter.h:142
itk::simple::RelabelComponent
Image RelabelComponent(Image &&image1, uint64_t minimumObjectSize=0u, bool sortByObjectSize=true)
Relabel the components in an image such that consecutive labels are used.
itk::simple::RelabelComponentImageFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkRelabelComponentImageFilter.h:66
itk::simple::IntegerPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > >::Type IntegerPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:76