SimpleITK  
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::simple {
33 
75  public:
77 
80 
84 
87 \
88 
92  SITK_RETURN_SELF_TYPE_HEADER SetRequiredNumberOfOverlappingPixels ( uint64_t RequiredNumberOfOverlappingPixels ) { this->m_RequiredNumberOfOverlappingPixels = RequiredNumberOfOverlappingPixels; return *this; }
93 
97  uint64_t GetRequiredNumberOfOverlappingPixels() const { return this->m_RequiredNumberOfOverlappingPixels; }\
98 
102  SITK_RETURN_SELF_TYPE_HEADER SetRequiredFractionOfOverlappingPixels ( double RequiredFractionOfOverlappingPixels ) { this->m_RequiredFractionOfOverlappingPixels = RequiredFractionOfOverlappingPixels; return *this; }
103 
107  double GetRequiredFractionOfOverlappingPixels() const { return this->m_RequiredFractionOfOverlappingPixels; }
108 
110  std::string GetName() const { return std::string ("FFTNormalizedCorrelationImageFilter"); }
111 
113  std::string ToString() const;
114 
115 
118  Image Execute ( const Image & fixedImage, const Image & movingImage );
119 
120  private:
121 
124  using MemberFunctionType = Image (Self::*)( const Image * fixedImage, const Image * movingImage );
125  template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage );
126 
127 
129 
130  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
131 
132 
133  uint64_t m_RequiredNumberOfOverlappingPixels{0u};
134 
135  double m_RequiredFractionOfOverlappingPixels{0.0};
136 
137 
138  };
139 
150  SITKBasicFilters_EXPORT Image FFTNormalizedCorrelation ( const Image & fixedImage, const Image & movingImage, uint64_t requiredNumberOfOverlappingPixels = 0u, double requiredFractionOfOverlappingPixels = 0.0 );
151 
153 }
154 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::FFTNormalizedCorrelationImageFilter::GetName
std::string GetName() const
Definition: sitkFFTNormalizedCorrelationImageFilter.h:110
sitkBasicFilters.h
itk::simple::FFTNormalizedCorrelationImageFilter::MemberFunctionType
Image(Self::*)(const Image *fixedImage, const Image *movingImage) MemberFunctionType
Definition: sitkFFTNormalizedCorrelationImageFilter.h:124
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::FFTNormalizedCorrelationImageFilter
Calculate normalized cross correlation using FFTs.
Definition: sitkFFTNormalizedCorrelationImageFilter.h:74
itk::simple::FFTNormalizedCorrelationImageFilter::GetRequiredFractionOfOverlappingPixels
double GetRequiredFractionOfOverlappingPixels() const
Definition: sitkFFTNormalizedCorrelationImageFilter.h:107
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::FFTNormalizedCorrelationImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkFFTNormalizedCorrelationImageFilter.h:130
sitkImageFilter.h
itk::simple::FFTNormalizedCorrelationImageFilter::SetRequiredNumberOfOverlappingPixels
Self & SetRequiredNumberOfOverlappingPixels(uint64_t RequiredNumberOfOverlappingPixels)
Definition: sitkFFTNormalizedCorrelationImageFilter.h:92
itk::simple::FFTNormalizedCorrelationImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkFFTNormalizedCorrelationImageFilter.h:86
itk::simple::FFTNormalizedCorrelation
Image FFTNormalizedCorrelation(const Image &fixedImage, const Image &movingImage, uint64_t requiredNumberOfOverlappingPixels=0u, double requiredFractionOfOverlappingPixels=0.0)
Calculate normalized cross correlation using FFTs.
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::FFTNormalizedCorrelationImageFilter::GetRequiredNumberOfOverlappingPixels
uint64_t GetRequiredNumberOfOverlappingPixels() const
Definition: sitkFFTNormalizedCorrelationImageFilter.h:97
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::FFTNormalizedCorrelationImageFilter::SetRequiredFractionOfOverlappingPixels
Self & SetRequiredFractionOfOverlappingPixels(double RequiredFractionOfOverlappingPixels)
Definition: sitkFFTNormalizedCorrelationImageFilter.h:102