SimpleITK  2.0.0rc2.post59
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 {
33  namespace simple {
34 
45  public:
47 
49  virtual ~CropImageFilter();
50 
54 
57 \
58 
62  SITK_RETURN_SELF_TYPE_HEADER SetLowerBoundaryCropSize ( std::vector<unsigned int> LowerBoundaryCropSize ) { this->m_LowerBoundaryCropSize = std::move(LowerBoundaryCropSize); return *this; }
63 
67  std::vector<unsigned int> GetLowerBoundaryCropSize() const { return this->m_LowerBoundaryCropSize; }\
68 
72  SITK_RETURN_SELF_TYPE_HEADER SetUpperBoundaryCropSize ( std::vector<unsigned int> UpperBoundaryCropSize ) { this->m_UpperBoundaryCropSize = std::move(UpperBoundaryCropSize); return *this; }
73 
77  std::vector<unsigned int> GetUpperBoundaryCropSize() const { return this->m_UpperBoundaryCropSize; }
78 
80  std::string GetName() const { return std::string ("CropImageFilter"); }
81 
83  std::string ToString() const;
84 
85 
87 #ifndef SWIG
88  Image Execute ( Image&& image1 );
89 #endif
90  Image Execute ( const Image& image1 );
91 
92  private:
93 
96  using MemberFunctionType = Image (Self::*)( const Image& image1 );
97  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
98 
99 
101 
102  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
103 
104 
105  /* odo what does this itk_type attribute do? */
106  std::vector<unsigned int> m_LowerBoundaryCropSize{std::vector<unsigned int>(3, 0)};
107 
108  /* odo what does this itk_type attribute do? */
109  std::vector<unsigned int> m_UpperBoundaryCropSize{std::vector<unsigned int>(3, 0)};
110 
111 
112  bool m_InPlace{false};
113  };
114 
124 #ifndef SWIG
125  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) );
126 #endif
127  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) );
128 
130  }
131 }
132 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::CropImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkCropImageFilter.h:56
itk::simple::NonLabelPixelIDTypeList
typelist::Append< typelist::Append< BasicPixelIDTypeList, ComplexPixelIDTypeList >::Type, VectorPixelIDTypeList >::Type NonLabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:180
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::CropImageFilter::GetUpperBoundaryCropSize
std::vector< unsigned int > GetUpperBoundaryCropSize() const
Definition: sitkCropImageFilter.h:77
itk::simple::CropImageFilter::SetUpperBoundaryCropSize
Self & SetUpperBoundaryCropSize(std::vector< unsigned int > UpperBoundaryCropSize)
Definition: sitkCropImageFilter.h:72
itk
itk::simple::CropImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkCropImageFilter.h:96
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::CropImageFilter::SetLowerBoundaryCropSize
Self & SetLowerBoundaryCropSize(std::vector< unsigned int > LowerBoundaryCropSize)
Definition: sitkCropImageFilter.h:62
itk::simple::CropImageFilter::GetLowerBoundaryCropSize
std::vector< unsigned int > GetLowerBoundaryCropSize() const
Definition: sitkCropImageFilter.h:67
itk::simple::CropImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCropImageFilter.h:102
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:44
itk::simple::CropImageFilter::GetName
std::string GetName() const
Definition: sitkCropImageFilter.h:80