SimpleITK  2.0.0rc2.post17
sitkMaskedFFTNormalizedCorrelationImageFilter.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 sitkMaskedFFTNormalizedCorrelationImageFilter_h
19 #define sitkMaskedFFTNormalizedCorrelationImageFilter_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 
84  public:
86 
89 
93 
96 \
97 
101  SITK_RETURN_SELF_TYPE_HEADER SetRequiredNumberOfOverlappingPixels ( uint64_t RequiredNumberOfOverlappingPixels ) { this->m_RequiredNumberOfOverlappingPixels = RequiredNumberOfOverlappingPixels; return *this; }
102 
106  uint64_t GetRequiredNumberOfOverlappingPixels() const { return this->m_RequiredNumberOfOverlappingPixels; }\
107 
111  SITK_RETURN_SELF_TYPE_HEADER SetRequiredFractionOfOverlappingPixels ( float RequiredFractionOfOverlappingPixels ) { this->m_RequiredFractionOfOverlappingPixels = RequiredFractionOfOverlappingPixels; return *this; }
112 
116  float GetRequiredFractionOfOverlappingPixels() const { return this->m_RequiredFractionOfOverlappingPixels; }
117 
119  std::string GetName() const { return std::string ("MaskedFFTNormalizedCorrelationImageFilter"); }
120 
122  std::string ToString() const;
123 
124 
127  Image Execute ( const Image & fixedImage, const Image & movingImage, const Image & fixedImageMask, const Image & movingImageMask );
128 
129  private:
130 
133  using MemberFunctionType = Image (Self::*)( const Image * fixedImage, const Image * movingImage, const Image * fixedImageMask, const Image * movingImageMask );
134  template <class TImageType> Image ExecuteInternal ( const Image * fixedImage, const Image * movingImage, const Image * fixedImageMask, const Image * movingImageMask );
135 
136 
138 
139  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
140 
141 
142  uint64_t m_RequiredNumberOfOverlappingPixels{0u};
143 
144  float m_RequiredFractionOfOverlappingPixels{0.0};
145 
146 
147  };
148 
159  SITKBasicFilters_EXPORT Image MaskedFFTNormalizedCorrelation ( const Image & fixedImage, const Image & movingImage, const Image & fixedImageMask, const Image & movingImageMask, uint64_t requiredNumberOfOverlappingPixels = 0u, float requiredFractionOfOverlappingPixels = 0.0 );
160 
162  }
163 }
164 #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::MaskedFFTNormalizedCorrelationImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:95
itk::simple::MaskedFFTNormalizedCorrelationImageFilter
Calculate masked normalized cross correlation using FFTs.
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:83
itk::simple::MaskedFFTNormalizedCorrelationImageFilter::GetRequiredNumberOfOverlappingPixels
uint64_t GetRequiredNumberOfOverlappingPixels() const
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:106
itk::simple::MaskedFFTNormalizedCorrelationImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:139
itk::simple::MaskedFFTNormalizedCorrelationImageFilter::MemberFunctionType
Image(Self::*)(const Image *fixedImage, const Image *movingImage, const Image *fixedImageMask, const Image *movingImageMask) MemberFunctionType
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:133
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::simple::MaskedFFTNormalizedCorrelationImageFilter::GetName
std::string GetName() const
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:119
itk::simple::MaskedFFTNormalizedCorrelationImageFilter::GetRequiredFractionOfOverlappingPixels
float GetRequiredFractionOfOverlappingPixels() const
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:116
itk::uint64_t
::uint64_t uint64_t
itk::simple::MaskedFFTNormalizedCorrelation
Image MaskedFFTNormalizedCorrelation(const Image &fixedImage, const Image &movingImage, const Image &fixedImageMask, const Image &movingImageMask, uint64_t requiredNumberOfOverlappingPixels=0u, float requiredFractionOfOverlappingPixels=0.0)
Calculate masked normalized cross correlation using FFTs.
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk
itk::simple::MaskedFFTNormalizedCorrelationImageFilter::SetRequiredFractionOfOverlappingPixels
Self & SetRequiredFractionOfOverlappingPixels(float RequiredFractionOfOverlappingPixels)
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:111
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::MaskedFFTNormalizedCorrelationImageFilter::SetRequiredNumberOfOverlappingPixels
Self & SetRequiredNumberOfOverlappingPixels(uint64_t RequiredNumberOfOverlappingPixels)
Definition: sitkMaskedFFTNormalizedCorrelationImageFilter.h:101