SimpleITK  
sitkBinaryImageToLabelMapFilter.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 sitkBinaryImageToLabelMapFilter_h
19 #define sitkBinaryImageToLabelMapFilter_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 
51  public:
53 
55  virtual ~BinaryImageToLabelMapFilter();
56 
60 
63 \
64 
68  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
69 
71  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
72  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
73 
77  bool GetFullyConnected() const { return this->m_FullyConnected; }\
78 
82  SITK_RETURN_SELF_TYPE_HEADER SetInputForegroundValue ( double InputForegroundValue ) { this->m_InputForegroundValue = InputForegroundValue; return *this; }
83 
87  double GetInputForegroundValue() const { return this->m_InputForegroundValue; }\
88 
92  SITK_RETURN_SELF_TYPE_HEADER SetOutputBackgroundValue ( double OutputBackgroundValue ) { this->m_OutputBackgroundValue = OutputBackgroundValue; return *this; }
93 
97  double GetOutputBackgroundValue() const { return this->m_OutputBackgroundValue; }
104  uint64_t GetNumberOfObjects() const { return this->m_NumberOfObjects; };
105 
106 
108  std::string GetName() const { return std::string ("BinaryImageToLabelMapFilter"); }
109 
111  std::string ToString() const;
112 
113 
116  Image Execute ( const Image& image1 );
117 
118  private:
119 
122  using MemberFunctionType = Image (Self::*)( const Image& image1 );
123  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
124 
125 
127 
128  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
129 
130 
131  bool m_FullyConnected{false};
132 
133  double m_InputForegroundValue{1.0};
134 
135  double m_OutputBackgroundValue{0.0};
136 
137  /* Docs */
138  uint64_t m_NumberOfObjects{0};
139 
140 
141  };
142 
153  SITKBasicFilters_EXPORT Image BinaryImageToLabelMap ( const Image& image1, bool fullyConnected = false, double inputForegroundValue = 1.0, double outputBackgroundValue = 0.0 );
154 
156 }
157 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::BinaryImageToLabelMap
Image BinaryImageToLabelMap(const Image &image1, bool fullyConnected=false, double inputForegroundValue=1.0, double outputBackgroundValue=0.0)
Label the connected components in a binary image and produce a collection of label objects.
itk::simple::BinaryImageToLabelMapFilter::SetFullyConnected
Self & SetFullyConnected(bool FullyConnected)
Definition: sitkBinaryImageToLabelMapFilter.h:68
itk::simple::BinaryImageToLabelMapFilter::FullyConnectedOn
Self & FullyConnectedOn()
Definition: sitkBinaryImageToLabelMapFilter.h:71
itk::simple::BinaryImageToLabelMapFilter::GetName
std::string GetName() const
Definition: sitkBinaryImageToLabelMapFilter.h:108
sitkImageFilter.h
itk::simple::BinaryImageToLabelMapFilter::SetOutputBackgroundValue
Self & SetOutputBackgroundValue(double OutputBackgroundValue)
Definition: sitkBinaryImageToLabelMapFilter.h:92
itk::simple::BinaryImageToLabelMapFilter::GetFullyConnected
bool GetFullyConnected() const
Definition: sitkBinaryImageToLabelMapFilter.h:77
itk::simple::BinaryImageToLabelMapFilter
Label the connected components in a binary image and produce a collection of label objects.
Definition: sitkBinaryImageToLabelMapFilter.h:50
itk::simple::BinaryImageToLabelMapFilter::SetInputForegroundValue
Self & SetInputForegroundValue(double InputForegroundValue)
Definition: sitkBinaryImageToLabelMapFilter.h:82
itk::simple::BinaryImageToLabelMapFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkBinaryImageToLabelMapFilter.h:122
itk::simple::BinaryImageToLabelMapFilter::GetOutputBackgroundValue
double GetOutputBackgroundValue() const
Definition: sitkBinaryImageToLabelMapFilter.h:97
itk::simple::BinaryImageToLabelMapFilter::GetNumberOfObjects
uint64_t GetNumberOfObjects() const
Definition: sitkBinaryImageToLabelMapFilter.h:104
itk::simple::BinaryImageToLabelMapFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkBinaryImageToLabelMapFilter.h:128
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::BinaryImageToLabelMapFilter::PixelIDTypeList
IntegerPixelIDTypeList PixelIDTypeList
Definition: sitkBinaryImageToLabelMapFilter.h:62
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::Image
Definition: sitkPixelIDTypes.h:26
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::BinaryImageToLabelMapFilter::GetInputForegroundValue
double GetInputForegroundValue() const
Definition: sitkBinaryImageToLabelMapFilter.h:87
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::BinaryImageToLabelMapFilter::FullyConnectedOff
Self & FullyConnectedOff()
Definition: sitkBinaryImageToLabelMapFilter.h:72