SimpleITK  
sitkCropImageFilter.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 sitkCropImageFilter_h
19 #define sitkCropImageFilter_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 ~CropImageFilter();
49 
53 
56 \
57 
61  SITK_RETURN_SELF_TYPE_HEADER SetLowerBoundaryCropSize ( std::vector<unsigned int> LowerBoundaryCropSize ) { this->m_LowerBoundaryCropSize = std::move(LowerBoundaryCropSize); return *this; }
62 
66  std::vector<unsigned int> GetLowerBoundaryCropSize() const { return this->m_LowerBoundaryCropSize; }\
67 
71  SITK_RETURN_SELF_TYPE_HEADER SetUpperBoundaryCropSize ( std::vector<unsigned int> UpperBoundaryCropSize ) { this->m_UpperBoundaryCropSize = std::move(UpperBoundaryCropSize); return *this; }
72 
76  std::vector<unsigned int> GetUpperBoundaryCropSize() const { return this->m_UpperBoundaryCropSize; }
77 
79  std::string GetName() const { return std::string ("CropImageFilter"); }
80 
82  std::string ToString() const;
83 
84 
86 #ifndef SWIG
87  Image Execute ( Image&& image1 );
88 #endif
89  Image Execute ( const Image& image1 );
90 
91  private:
92 
95  using MemberFunctionType = Image (Self::*)( const Image& image1 );
96  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
97 
98 
100 
101  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
102 
103 
104  /* odo what does this itk_type attribute do? */
105  std::vector<unsigned int> m_LowerBoundaryCropSize{std::vector<unsigned int>(3, 0)};
106 
107  /* odo what does this itk_type attribute do? */
108  std::vector<unsigned int> m_UpperBoundaryCropSize{std::vector<unsigned int>(3, 0)};
109 
110 
111  bool m_InPlace{false};
112  };
113 
123 #ifndef SWIG
124  SITKBasicFilters_EXPORT Image Crop ( Image&& image1, std::vector<unsigned int> lowerBoundaryCropSize = std::vector<unsigned int>(3, 0), std::vector<unsigned int> upperBoundaryCropSize = std::vector<unsigned int>(3, 0) );
125 #endif
126  SITKBasicFilters_EXPORT Image Crop ( const Image& image1, std::vector<unsigned int> lowerBoundaryCropSize = std::vector<unsigned int>(3, 0), std::vector<unsigned int> upperBoundaryCropSize = std::vector<unsigned int>(3, 0) );
127 
129 }
130 #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::CropImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkCropImageFilter.h:55
sitkImageFilter.h
itk::simple::Crop
Image Crop(Image &&image1, std::vector< unsigned int > lowerBoundaryCropSize=std::vector< unsigned int >(3, 0), std::vector< unsigned int > upperBoundaryCropSize=std::vector< unsigned int >(3, 0))
Decrease the image size by cropping the image by an itk::Size at both the upper and lower bounds of t...
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::CropImageFilter::GetUpperBoundaryCropSize
std::vector< unsigned int > GetUpperBoundaryCropSize() const
Definition: sitkCropImageFilter.h:76
itk::simple::CropImageFilter::SetUpperBoundaryCropSize
Self & SetUpperBoundaryCropSize(std::vector< unsigned int > UpperBoundaryCropSize)
Definition: sitkCropImageFilter.h:71
itk::simple::CropImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkCropImageFilter.h:95
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::CropImageFilter::SetLowerBoundaryCropSize
Self & SetLowerBoundaryCropSize(std::vector< unsigned int > LowerBoundaryCropSize)
Definition: sitkCropImageFilter.h:61
itk::simple::CropImageFilter::GetLowerBoundaryCropSize
std::vector< unsigned int > GetLowerBoundaryCropSize() const
Definition: sitkCropImageFilter.h:66
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::CropImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCropImageFilter.h:101
itk::simple::CropImageFilter
Decrease the image size by cropping the image by an itk::Size at both the upper and lower bounds of t...
Definition: sitkCropImageFilter.h:43
itk::simple::CropImageFilter::GetName
std::string GetName() const
Definition: sitkCropImageFilter.h:79