SimpleITK  
sitkRegionOfInterestImageFilter.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 sitkRegionOfInterestImageFilter_h
19 #define sitkRegionOfInterestImageFilter_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 
48  public:
50 
52  virtual ~RegionOfInterestImageFilter();
53 
57 
60 \
61 
65  SITK_RETURN_SELF_TYPE_HEADER SetSize ( std::vector<unsigned int> Size ) { this->m_Size = std::move(Size); return *this; }
66 
69  std::vector<unsigned int> GetSize() const { return this->m_Size; }\
70 
74  SITK_RETURN_SELF_TYPE_HEADER SetIndex ( std::vector<int> Index ) { this->m_Index = std::move(Index); return *this; }
75 
78  std::vector<int> GetIndex() const { return this->m_Index; }
79 
81  std::string GetName() const { return std::string ("RegionOfInterestImageFilter"); }
82 
84  std::string ToString() const;
85 
86 
89  Image Execute ( const Image& image1 );
90 
91 
93  void SetRegionOfInterest(const std::vector<unsigned int> & Region );
94 
95  private:
96 
99  using MemberFunctionType = Image (Self::*)( const Image& image1 );
100  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
101 
102 
104 
105  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
106 
107 
108  std::vector<unsigned int> m_Size{std::vector<unsigned int>(3, 1)};
109 
110  std::vector<int> m_Index{std::vector<int>(3, 0)};
111 
112 
113  };
114 
125  SITKBasicFilters_EXPORT Image RegionOfInterest ( const Image& image1, std::vector<unsigned int> size = std::vector<unsigned int>(3, 1), std::vector<int> index = std::vector<int>(3, 0) );
126 
128 }
129 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::Index
itk::simple::RegionOfInterestImageFilter::GetIndex
std::vector< int > GetIndex() const
Definition: sitkRegionOfInterestImageFilter.h:78
itk::Size
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::RegionOfInterestImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkRegionOfInterestImageFilter.h:99
sitkImageFilter.h
itk::simple::RegionOfInterestImageFilter::SetIndex
Self & SetIndex(std::vector< int > Index)
Set the inclusive starting index of the region extracted.
Definition: sitkRegionOfInterestImageFilter.h:74
itk::simple::RegionOfInterest
Image RegionOfInterest(const Image &image1, std::vector< unsigned int > size=std::vector< unsigned int >(3, 1), std::vector< int > index=std::vector< int >(3, 0))
Extract a region of interest from the input image.
itk::simple::RegionOfInterestImageFilter::SetSize
Self & SetSize(std::vector< unsigned int > Size)
Size in pixels of the region extracted.
Definition: sitkRegionOfInterestImageFilter.h:65
itk::simple::RegionOfInterestImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRegionOfInterestImageFilter.h:105
itk::simple::RegionOfInterestImageFilter::GetName
std::string GetName() const
Definition: sitkRegionOfInterestImageFilter.h:81
itk::Region
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::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::RegionOfInterestImageFilter::GetSize
std::vector< unsigned int > GetSize() const
Definition: sitkRegionOfInterestImageFilter.h:69
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::RegionOfInterestImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkRegionOfInterestImageFilter.h:59
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::RegionOfInterestImageFilter
Extract a region of interest from the input image.
Definition: sitkRegionOfInterestImageFilter.h:47