SimpleITK  
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::simple {
33 
54  public:
56 
58  virtual ~RelabelComponentImageFilter();
59 
63 
66 \
67 
71  SITK_RETURN_SELF_TYPE_HEADER SetMinimumObjectSize ( uint64_t MinimumObjectSize ) { this->m_MinimumObjectSize = MinimumObjectSize; return *this; }
72 
76  uint64_t GetMinimumObjectSize() const { return this->m_MinimumObjectSize; }\
77 
81  SITK_RETURN_SELF_TYPE_HEADER SetSortByObjectSize ( bool SortByObjectSize ) { this->m_SortByObjectSize = SortByObjectSize; return *this; }
82 
84  SITK_RETURN_SELF_TYPE_HEADER SortByObjectSizeOn() { return this->SetSortByObjectSize(true); }
85  SITK_RETURN_SELF_TYPE_HEADER SortByObjectSizeOff() { return this->SetSortByObjectSize(false); }
86 
90  bool GetSortByObjectSize() const { return this->m_SortByObjectSize; }
97  uint32_t GetNumberOfObjects() const { return this->m_NumberOfObjects; };
98 
105  uint32_t GetOriginalNumberOfObjects() const { return this->m_OriginalNumberOfObjects; };
106 
113  std::vector<float> GetSizeOfObjectsInPhysicalUnits() const { return this->m_SizeOfObjectsInPhysicalUnits; };
114 
121  std::vector<uint64_t> GetSizeOfObjectsInPixels() const { return this->m_SizeOfObjectsInPixels; };
122 
123 
125  std::string GetName() const { return std::string ("RelabelComponentImageFilter"); }
126 
128  std::string ToString() const;
129 
130 
132 #ifndef SWIG
133  Image Execute ( Image&& image1 );
134 #endif
135  Image Execute ( const Image& image1 );
136 
137  private:
138 
141  using MemberFunctionType = Image (Self::*)( const Image& image1 );
142  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
143 
144 
146 
147  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
148 
149 
150  uint64_t m_MinimumObjectSize{0u};
151 
152  bool m_SortByObjectSize{true};
153 
154  /* */
155  uint32_t m_NumberOfObjects{0u};
156  /* */
157  uint32_t m_OriginalNumberOfObjects{0u};
158  /* */
159  std::vector<float> m_SizeOfObjectsInPhysicalUnits{std::vector<float>()};
160  /* */
161  std::vector<uint64_t> m_SizeOfObjectsInPixels{std::vector<uint64_t>()};
162 
163 
164  bool m_InPlace{false};
165  };
166 
176 #ifndef SWIG
177  SITKBasicFilters_EXPORT Image RelabelComponent ( Image&& image1, uint64_t minimumObjectSize = 0u, bool sortByObjectSize = true );
178 #endif
179  SITKBasicFilters_EXPORT Image RelabelComponent ( const Image& image1, uint64_t minimumObjectSize = 0u, bool sortByObjectSize = true );
180 
182 }
183 #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::RelabelComponentImageFilter::SortByObjectSizeOff
Self & SortByObjectSizeOff()
Definition: sitkRelabelComponentImageFilter.h:85
itk::simple::RelabelComponentImageFilter::SetSortByObjectSize
Self & SetSortByObjectSize(bool SortByObjectSize)
Definition: sitkRelabelComponentImageFilter.h:81
itk::simple::RelabelComponentImageFilter::GetName
std::string GetName() const
Definition: sitkRelabelComponentImageFilter.h:125
sitkImageFilter.h
itk::simple::RelabelComponentImageFilter::GetNumberOfObjects
uint32_t GetNumberOfObjects() const
Definition: sitkRelabelComponentImageFilter.h:97
itk::simple::RelabelComponentImageFilter
Relabel the components in an image such that consecutive labels are used.
Definition: sitkRelabelComponentImageFilter.h:53
itk::simple::RelabelComponentImageFilter::SortByObjectSizeOn
Self & SortByObjectSizeOn()
Definition: sitkRelabelComponentImageFilter.h:84
itk::simple::RelabelComponentImageFilter::GetSizeOfObjectsInPixels
std::vector< uint64_t > GetSizeOfObjectsInPixels() const
Definition: sitkRelabelComponentImageFilter.h:121
itk::simple::RelabelComponentImageFilter::SetMinimumObjectSize
Self & SetMinimumObjectSize(uint64_t MinimumObjectSize)
Definition: sitkRelabelComponentImageFilter.h:71
itk::simple::RelabelComponentImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRelabelComponentImageFilter.h:147
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::RelabelComponentImageFilter::GetSizeOfObjectsInPhysicalUnits
std::vector< float > GetSizeOfObjectsInPhysicalUnits() const
Definition: sitkRelabelComponentImageFilter.h:113
itk::simple::RelabelComponentImageFilter::GetMinimumObjectSize
uint64_t GetMinimumObjectSize() const
Definition: sitkRelabelComponentImageFilter.h:76
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::RelabelComponentImageFilter::GetSortByObjectSize
bool GetSortByObjectSize() const
Definition: sitkRelabelComponentImageFilter.h:90
itk::simple::IntegerPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t > > IntegerPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:75
itk::simple::RelabelComponentImageFilter::GetOriginalNumberOfObjects
uint32_t GetOriginalNumberOfObjects() const
Definition: sitkRelabelComponentImageFilter.h:105
itk::simple::RelabelComponentImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkRelabelComponentImageFilter.h:141
itk::simple
Definition: sitkAdditionalProcedures.h:28
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:65