SimpleITK  1.1.0
sitkCropImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
51  public:
53 
55  virtual ~CropImageFilter();
56 
60 
63 
64 
65 
69  SITK_RETURN_SELF_TYPE_HEADER SetLowerBoundaryCropSize ( const std::vector<unsigned int> & LowerBoundaryCropSize ) { this->m_LowerBoundaryCropSize = LowerBoundaryCropSize; return *this; }
70 
74  std::vector<unsigned int> GetLowerBoundaryCropSize() const { return this->m_LowerBoundaryCropSize; }
75 
79  SITK_RETURN_SELF_TYPE_HEADER SetUpperBoundaryCropSize ( const std::vector<unsigned int> & UpperBoundaryCropSize ) { this->m_UpperBoundaryCropSize = UpperBoundaryCropSize; return *this; }
80 
84  std::vector<unsigned int> GetUpperBoundaryCropSize() const { return this->m_UpperBoundaryCropSize; }
86  std::string GetName() const { return std::string ("CropImageFilter"); }
87 
89  std::string ToString() const;
90 
91 
93  Image Execute ( const Image& image1 );
94 
95 
97  Image Execute ( const Image& image1, const std::vector<unsigned int> & lowerBoundaryCropSize, const std::vector<unsigned int> & upperBoundaryCropSize );
98 
99  private:
100 
103  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
104  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
105 
106 
107  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
108 
109  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
110 
111 
112  /* odo what does this itk_type attribute do? */
113  std::vector<unsigned int> m_LowerBoundaryCropSize;
114  /* odo what does this itk_type attribute do? */
115  std::vector<unsigned int> m_UpperBoundaryCropSize;
116  };
117 
118 
127  SITKBasicFilters_EXPORT Image Crop ( const Image& image1, const std::vector<unsigned int> & lowerBoundaryCropSize = std::vector<unsigned int>(3, 0), const std::vector<unsigned int> & upperBoundaryCropSize = std::vector<unsigned int>(3, 0) );
128 
129  }
130 }
131 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::CropImageFilter::m_UpperBoundaryCropSize
std::vector< unsigned int > m_UpperBoundaryCropSize
Definition: sitkCropImageFilter.h:115
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::NonLabelPixelIDTypeList
typelist::Append< typelist::Append< BasicPixelIDTypeList, ComplexPixelIDTypeList >::Type, VectorPixelIDTypeList >::Type NonLabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:180
itk::simple::CropImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCropImageFilter.h:109
sitkImageFilter.h
itk::simple::CropImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkCropImageFilter.h:62
itk::simple::CropImageFilter::m_LowerBoundaryCropSize
std::vector< unsigned int > m_LowerBoundaryCropSize
Definition: sitkCropImageFilter.h:113
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::CropImageFilter::GetUpperBoundaryCropSize
std::vector< unsigned int > GetUpperBoundaryCropSize() const
Definition: sitkCropImageFilter.h:84
itk::simple::CropImageFilter::SetUpperBoundaryCropSize
Self & SetUpperBoundaryCropSize(const std::vector< unsigned int > &UpperBoundaryCropSize)
Definition: sitkCropImageFilter.h:79
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::CropImageFilter::GetLowerBoundaryCropSize
std::vector< unsigned int > GetLowerBoundaryCropSize() const
Definition: sitkCropImageFilter.h:74
itk::simple::CropImageFilter::Self
CropImageFilter Self
Definition: sitkCropImageFilter.h:52
itk::simple::CropImageFilter::SetLowerBoundaryCropSize
Self & SetLowerBoundaryCropSize(const std::vector< unsigned int > &LowerBoundaryCropSize)
Definition: sitkCropImageFilter.h:69
itk::simple::Crop
Image Crop(const Image &image1, const std::vector< unsigned int > &lowerBoundaryCropSize=std::vector< unsigned int >(3, 0), const 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...
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:50
itk::simple::CropImageFilter::GetName
std::string GetName() const
Definition: sitkCropImageFilter.h:86