SimpleITK  
sitkCheckerBoardImageFilter.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 sitkCheckerBoardImageFilter_h
19 #define sitkCheckerBoardImageFilter_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 
44  public:
46 
48  virtual ~CheckerBoardImageFilter();
49 
53 
56 \
57 
61  SITK_RETURN_SELF_TYPE_HEADER SetCheckerPattern ( std::vector<uint32_t> CheckerPattern ) { this->m_CheckerPattern = std::move(CheckerPattern); return *this; }
62 
64  SITK_RETURN_SELF_TYPE_HEADER SetCheckerPattern( uint32_t value ) { this->m_CheckerPattern = std::vector<uint32_t>(3, value); return *this; }
65 
69  std::vector<uint32_t> GetCheckerPattern() const { return this->m_CheckerPattern; }
70 
72  std::string GetName() const { return std::string ("CheckerBoardImageFilter"); }
73 
75  std::string ToString() const;
76 
77 
80  Image Execute ( const Image& image1, const Image& image2 );
81 
82  private:
83 
86  using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
87  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
88 
89 
91 
92  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
93 
94 
95  std::vector<uint32_t> m_CheckerPattern{std::vector<uint32_t>(3, 4)};
96 
97 
98  };
99 
110  SITKBasicFilters_EXPORT Image CheckerBoard ( const Image& image1, const Image& image2, std::vector<uint32_t> checkerPattern = std::vector<uint32_t>(3, 4) );
111 
113 }
114 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::CheckerBoardImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkCheckerBoardImageFilter.h:55
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::CheckerBoard
Image CheckerBoard(const Image &image1, const Image &image2, std::vector< uint32_t > checkerPattern=std::vector< uint32_t >(3, 4))
Combines two images in a checkerboard pattern.
sitkImageFilter.h
itk::simple::CheckerBoardImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1, const Image &image2) MemberFunctionType
Definition: sitkCheckerBoardImageFilter.h:86
itk::simple::CheckerBoardImageFilter::SetCheckerPattern
Self & SetCheckerPattern(uint32_t value)
Definition: sitkCheckerBoardImageFilter.h:64
itk::simple::CheckerBoardImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCheckerBoardImageFilter.h:92
itk::simple::CheckerBoardImageFilter
Combines two images in a checkerboard pattern.
Definition: sitkCheckerBoardImageFilter.h:43
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::NonLabelPixelIDTypeList
typelist2::append< BasicPixelIDTypeList, ComplexPixelIDTypeList, VectorPixelIDTypeList >::type NonLabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:180
itk::simple::CheckerBoardImageFilter::GetCheckerPattern
std::vector< uint32_t > GetCheckerPattern() const
Definition: sitkCheckerBoardImageFilter.h:69
itk::simple::CheckerBoardImageFilter::GetName
std::string GetName() const
Definition: sitkCheckerBoardImageFilter.h:72
itk::simple::CheckerBoardImageFilter::SetCheckerPattern
Self & SetCheckerPattern(std::vector< uint32_t > CheckerPattern)
Definition: sitkCheckerBoardImageFilter.h:61
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
Definition: sitkAdditionalProcedures.h:28