SimpleITK  
sitkPasteImageFilter.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 sitkPasteImageFilter_h
19 #define sitkPasteImageFilter_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 
55  public:
57 
59  virtual ~PasteImageFilter();
60 
64 
67 \
68 
71  SITK_RETURN_SELF_TYPE_HEADER SetSourceSize ( std::vector<unsigned int> SourceSize ) { this->m_SourceSize = std::move(SourceSize); return *this; }
72 
75  std::vector<unsigned int> GetSourceSize() const { return this->m_SourceSize; }\
76 
79  SITK_RETURN_SELF_TYPE_HEADER SetSourceIndex ( std::vector<int> SourceIndex ) { this->m_SourceIndex = std::move(SourceIndex); return *this; }
80 
83  std::vector<int> GetSourceIndex() const { return this->m_SourceIndex; }\
84 
88  SITK_RETURN_SELF_TYPE_HEADER SetDestinationIndex ( std::vector<int> DestinationIndex ) { this->m_DestinationIndex = std::move(DestinationIndex); return *this; }
89 
93  std::vector<int> GetDestinationIndex() const { return this->m_DestinationIndex; }
94 
95 
104  SITK_RETURN_SELF_TYPE_HEADER SetDestinationSkipAxes ( std::vector<bool> DestinationSkipAxes ) { this->m_DestinationSkipAxes = std::move(DestinationSkipAxes); return *this; }
105 
114  std::vector<bool> GetDestinationSkipAxes() const { return this->m_DestinationSkipAxes; }
115 
116 
117 
119  std::string GetName() const { return std::string ("PasteImageFilter"); }
120 
122  std::string ToString() const;
123 
124 
126 #ifndef SWIG
127  Image Execute ( Image && destinationImage, const Image & sourceImage );
128  Image Execute ( Image && destinationImage, double constant);
129 #endif
130  Image Execute ( const Image & destinationImage, const Image & sourceImage );
131  Image Execute ( const Image & destinationImage, double constant);
132 
133 
134  private:
135 
138  using MemberFunctionType = Image (Self::*)( const Image * destinationImage, const Image * sourceImage );
139  template <class TImageType> Image ExecuteInternal ( const Image * destinationImage, const Image * sourceImage );
140 
141  template <class TImageType, unsigned int OutputDimension>
142  Image ExecuteInternal ( const TImageType *destinationImage, const Image * sourceImage, std::integral_constant<unsigned int, OutputDimension> meta );
143  template <class TImageType>
144  Image ExecuteInternal ( const TImageType *destinationImage, const Image * sourceImage, std::integral_constant<unsigned int, 1> meta );
145 
146 
148 
149  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
150 
151  using MemberFunction2Type = Image (Self::*)( const Image* image, double constant );
152  template <class TImageType> Image ExecuteInternal ( const Image* image, double constant );
154  std::unique_ptr<detail::MemberFunctionFactory<MemberFunction2Type> > m_MemberFactory2;
155 
156 
157  std::vector<unsigned int> m_SourceSize{std::vector<unsigned int>(SITK_MAX_DIMENSION, 1)};
158 
159  std::vector<int> m_SourceIndex{std::vector<int>(SITK_MAX_DIMENSION, 0)};
160 
161  std::vector<int> m_DestinationIndex{std::vector<int>(SITK_MAX_DIMENSION, 0)};
162 
163  std::vector<bool> m_DestinationSkipAxes{};
164 
165  bool m_InPlace{false};
166  };
167 
177 #ifndef SWIG
178  SITKBasicFilters_EXPORT Image Paste ( Image && destinationImage, const Image & sourceImage, std::vector<unsigned int> sourceSize = std::vector<unsigned int>(SITK_MAX_DIMENSION, 1), std::vector<int> sourceIndex = std::vector<int>(SITK_MAX_DIMENSION, 0), std::vector<int> destinationIndex = std::vector<int>(SITK_MAX_DIMENSION, 0), std::vector<bool> DestinationSkipAxes = std::vector<bool>() );
179 #endif
180  SITKBasicFilters_EXPORT Image Paste ( const Image & destinationImage, const Image & sourceImage, std::vector<unsigned int> sourceSize = std::vector<unsigned int>(SITK_MAX_DIMENSION, 1), std::vector<int> sourceIndex = std::vector<int>(SITK_MAX_DIMENSION, 0), std::vector<int> destinationIndex = std::vector<int>(SITK_MAX_DIMENSION, 0), std::vector<bool> DestinationSkipAxes = std::vector<bool>() );
181 
183  }
184 #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::PasteImageFilter::GetSourceIndex
std::vector< int > GetSourceIndex() const
Definition: sitkPasteImageFilter.h:83
itk::simple::PasteImageFilter::GetDestinationIndex
std::vector< int > GetDestinationIndex() const
Definition: sitkPasteImageFilter.h:93
itk::simple::PasteImageFilter::GetDestinationSkipAxes
std::vector< bool > GetDestinationSkipAxes() const
Definition: sitkPasteImageFilter.h:114
sitkImageFilter.h
itk::simple::Paste
Image Paste(Image &&destinationImage, const Image &sourceImage, std::vector< unsigned int > sourceSize=std::vector< unsigned int >(SITK_MAX_DIMENSION, 1), std::vector< int > sourceIndex=std::vector< int >(SITK_MAX_DIMENSION, 0), std::vector< int > destinationIndex=std::vector< int >(SITK_MAX_DIMENSION, 0), std::vector< bool > DestinationSkipAxes=std::vector< bool >())
Paste an image into another image.
itk::simple::PasteImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkPasteImageFilter.h:149
itk::simple::PasteImageFilter::SetDestinationSkipAxes
Self & SetDestinationSkipAxes(std::vector< bool > DestinationSkipAxes)
Definition: sitkPasteImageFilter.h:104
SITK_MAX_DIMENSION
#define SITK_MAX_DIMENSION
Definition: sitkConfigure.h:30
itk::simple::PasteImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkPasteImageFilter.h:66
itk::simple::PasteImageFilter::MemberFunctionType
Image(Self::*)(const Image *destinationImage, const Image *sourceImage) MemberFunctionType
Definition: sitkPasteImageFilter.h:138
itk::simple::PasteImageFilter
Paste an image (or a constant value) into another image.
Definition: sitkPasteImageFilter.h:54
itk::simple::PasteImageFilter::SetDestinationIndex
Self & SetDestinationIndex(std::vector< int > DestinationIndex)
Definition: sitkPasteImageFilter.h:88
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::PasteImageFilter::SetSourceIndex
Self & SetSourceIndex(std::vector< int > SourceIndex)
Definition: sitkPasteImageFilter.h:79
itk::simple::PasteImageFilter::SetSourceSize
Self & SetSourceSize(std::vector< unsigned int > SourceSize)
Definition: sitkPasteImageFilter.h:71
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::PasteImageFilter::GetSourceSize
std::vector< unsigned int > GetSourceSize() const
Definition: sitkPasteImageFilter.h:75
itk::simple::PasteImageFilter::m_MemberFactory2
std::unique_ptr< detail::MemberFunctionFactory< MemberFunction2Type > > m_MemberFactory2
Definition: sitkPasteImageFilter.h:154
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::PasteImageFilter::MemberFunction2Type
Image(Self::*)(const Image *image, double constant) MemberFunction2Type
Definition: sitkPasteImageFilter.h:151
itk::simple::PasteImageFilter::GetName
std::string GetName() const
Definition: sitkPasteImageFilter.h:119