SimpleITK  2.0.0rc2.post23
sitkFFTNormalizedCorrelationImageFilter.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 sitkFFTNormalizedCorrelationImageFilter_h
19 #define sitkFFTNormalizedCorrelationImageFilter_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 
76  public:
78 
81 
85 
88 \
89 
92  SITK_RETURN_SELF_TYPE_HEADER SetRequiredNumberOfOverlappingPixels ( uint64_t RequiredNumberOfOverlappingPixels ) { this->m_RequiredNumberOfOverlappingPixels = RequiredNumberOfOverlappingPixels; return *this; }
93 
96  uint64_t GetRequiredNumberOfOverlappingPixels() const { return this->m_RequiredNumberOfOverlappingPixels; }
97 
99  std::string GetName() const { return std::string ("FFTNormalizedCorrelationImageFilter"); }
100 
102  std::string ToString() const;
103 
104 
107  Image Execute ( const Image& image1, const Image& image2 );
108 
109  private:
110 
113  using MemberFunctionType = Image (Self::*)( const Image& image1, const Image& image2 );
114  template <class TImageType> Image ExecuteInternal ( const Image& image1, const Image& image2 );
115 
116 
118 
119  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
120 
121 
122  uint64_t m_RequiredNumberOfOverlappingPixels{0u};
123 
124 
125  };
126 
137  SITKBasicFilters_EXPORT Image FFTNormalizedCorrelation ( const Image& image1, const Image& image2, uint64_t requiredNumberOfOverlappingPixels = 0u );
138 
140  }
141 }
142 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::FFTNormalizedCorrelationImageFilter::GetName
std::string GetName() const
Definition: sitkFFTNormalizedCorrelationImageFilter.h:99
itk::simple::FFTNormalizedCorrelationImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1, const Image &image2) MemberFunctionType
Definition: sitkFFTNormalizedCorrelationImageFilter.h:113
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::FFTNormalizedCorrelationImageFilter
Calculate normalized cross correlation using FFTs.
Definition: sitkFFTNormalizedCorrelationImageFilter.h:75
itk::simple::FFTNormalizedCorrelationImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFFTNormalizedCorrelationImageFilter.h:119
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::uint64_t
::uint64_t uint64_t
itk::simple::FFTNormalizedCorrelationImageFilter::SetRequiredNumberOfOverlappingPixels
Self & SetRequiredNumberOfOverlappingPixels(uint64_t RequiredNumberOfOverlappingPixels)
Definition: sitkFFTNormalizedCorrelationImageFilter.h:92
itk::simple::FFTNormalizedCorrelationImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFFTNormalizedCorrelationImageFilter.h:87
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::FFTNormalizedCorrelationImageFilter::GetRequiredNumberOfOverlappingPixels
uint64_t GetRequiredNumberOfOverlappingPixels() const
Definition: sitkFFTNormalizedCorrelationImageFilter.h:96
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::FFTNormalizedCorrelation
Image FFTNormalizedCorrelation(const Image &image1, const Image &image2, uint64_t requiredNumberOfOverlappingPixels=0u)
Calculate normalized cross correlation using FFTs.
itk::Image
Definition: sitkPixelIDTypes.h:26