SimpleITK  
sitkEqualImageFilter.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 sitkEqualImageFilter_h
19 #define sitkEqualImageFilter_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 sitkBinaryFunctorFilterTemplate.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 
49  public:
51 
53  virtual ~EqualImageFilter();
54 
58 
61 
62 \
63 
68  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( uint8_t BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
69 
74  uint8_t GetBackgroundValue() const { return this->m_BackgroundValue; }\
75 
80  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( uint8_t ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
81 
86  uint8_t GetForegroundValue() const { return this->m_ForegroundValue; }
87 
89  std::string GetName() const { return std::string ("EqualImageFilter"); }
90 
92  std::string ToString() const;
93 
94 
96 #ifndef SWIG
97  Image Execute ( Image&& image1, const Image& image2 );
98 #endif
99  Image Execute ( const Image& image1, const Image& image2 );
100 
102  Image Execute ( const Image& image1, double constant );
103 #ifndef SWIG
104  Image Execute ( Image&& image1, double constant );
105 #endif
106  Image Execute ( double constant, const Image& image2 );
108  Image Execute ( const Image& image1, double constant, uint8_t backgroundValue, uint8_t foregroundValue );
109  Image Execute ( double constant, const Image& image2, uint8_t backgroundValue, uint8_t foregroundValue );
110 
111  private:
112 
115  using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
116  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
117 
118 
120 
121  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
122  using MemberFunction1Type = Image (Self::*)( double constant, const Image& image2 );
123  template <class TImageType> Image ExecuteInternal ( double constant, const Image& image2 );
125  std::unique_ptr<detail::MemberFunctionFactory<MemberFunction1Type> > m_MemberFactory1;
126 
127  using MemberFunction2Type = Image (Self::*)( const Image& image1, double constant );
128  template <class TImageType> Image ExecuteInternal ( const Image& image1, double constant );
130  std::unique_ptr<detail::MemberFunctionFactory<MemberFunction2Type> > m_MemberFactory2;
131 
132 
133  uint8_t m_BackgroundValue{0u};
134 
135  uint8_t m_ForegroundValue{1u};
136 
137 
138  bool m_InPlace{false};
139  };
140 
150 #ifndef SWIG
151  SITKBasicFilters_EXPORT Image Equal ( Image&& image1, const Image& image2, uint8_t backgroundValue = 0u, uint8_t foregroundValue = 1u );
152 #endif
153  SITKBasicFilters_EXPORT Image Equal ( const Image& image1, const Image& image2, uint8_t backgroundValue = 0u, uint8_t foregroundValue = 1u );
154 
156  SITKBasicFilters_EXPORT Image Equal ( const Image& image1, double constant, uint8_t backgroundValue = 0u, uint8_t foregroundValue = 1u );
157 #ifndef SWIG
158  SITKBasicFilters_EXPORT Image Equal ( Image&& image1, double constant, uint8_t backgroundValue = 0u, uint8_t foregroundValue = 1u );
159 #endif
160  SITKBasicFilters_EXPORT Image Equal ( double constant, const Image& image2, uint8_t backgroundValue = 0u, uint8_t foregroundValue = 1u );
161 }
162 #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::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::EqualImageFilter::GetForegroundValue
uint8_t GetForegroundValue() const
Definition: sitkEqualImageFilter.h:86
sitkImageFilter.h
itk::simple::EqualImageFilter::SetForegroundValue
Self & SetForegroundValue(uint8_t ForegroundValue)
Definition: sitkEqualImageFilter.h:80
itk::simple::EqualImageFilter::MemberFunction2Type
Image(Self::*)(const Image &image1, double constant) MemberFunction2Type
Definition: sitkEqualImageFilter.h:127
itk::simple::EqualImageFilter::GetBackgroundValue
uint8_t GetBackgroundValue() const
Definition: sitkEqualImageFilter.h:74
itk::simple::EqualImageFilter
Implements pixel-wise generic operation of two images, or of an image and a constant.
Definition: sitkEqualImageFilter.h:48
itk::simple::EqualImageFilter::m_MemberFactory2
std::unique_ptr< detail::MemberFunctionFactory< MemberFunction2Type > > m_MemberFactory2
Definition: sitkEqualImageFilter.h:130
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::EqualImageFilter::GetName
std::string GetName() const
Definition: sitkEqualImageFilter.h:89
itk::simple::EqualImageFilter::m_MemberFactory1
std::unique_ptr< detail::MemberFunctionFactory< MemberFunction1Type > > m_MemberFactory1
Definition: sitkEqualImageFilter.h:125
itk::simple::EqualImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1, const Image &image2) MemberFunctionType
Definition: sitkEqualImageFilter.h:115
itk::simple::EqualImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkEqualImageFilter.h:60
itk::simple::EqualImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkEqualImageFilter.h:121
itk::simple::Equal
Image Equal(Image &&image1, const Image &image2, uint8_t backgroundValue=0u, uint8_t foregroundValue=1u)
Implements pixel-wise generic operation of two images, or of an image and a constant.
itk::simple::EqualImageFilter::MemberFunction1Type
Image(Self::*)(double constant, const Image &image2) MemberFunction1Type
Definition: sitkEqualImageFilter.h:122
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::EqualImageFilter::SetBackgroundValue
Self & SetBackgroundValue(uint8_t BackgroundValue)
Definition: sitkEqualImageFilter.h:68
itk::simple
Definition: sitkAdditionalProcedures.h:28