SimpleITK  
sitkHistogramMatchingImageFilter.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 sitkHistogramMatchingImageFilter_h
19 #define sitkHistogramMatchingImageFilter_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 
55  public:
57 
60 
64 
67 \
68 
72  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfHistogramLevels ( uint32_t NumberOfHistogramLevels ) { this->m_NumberOfHistogramLevels = NumberOfHistogramLevels; return *this; }
73 
77  uint32_t GetNumberOfHistogramLevels() const { return this->m_NumberOfHistogramLevels; }\
78 
82  SITK_RETURN_SELF_TYPE_HEADER SetNumberOfMatchPoints ( uint32_t NumberOfMatchPoints ) { this->m_NumberOfMatchPoints = NumberOfMatchPoints; return *this; }
83 
87  uint32_t GetNumberOfMatchPoints() const { return this->m_NumberOfMatchPoints; }\
88 
92  SITK_RETURN_SELF_TYPE_HEADER SetThresholdAtMeanIntensity ( bool ThresholdAtMeanIntensity ) { this->m_ThresholdAtMeanIntensity = ThresholdAtMeanIntensity; return *this; }
93 
95  SITK_RETURN_SELF_TYPE_HEADER ThresholdAtMeanIntensityOn() { return this->SetThresholdAtMeanIntensity(true); }
96  SITK_RETURN_SELF_TYPE_HEADER ThresholdAtMeanIntensityOff() { return this->SetThresholdAtMeanIntensity(false); }
97 
101  bool GetThresholdAtMeanIntensity() const { return this->m_ThresholdAtMeanIntensity; }
102 
104  std::string GetName() const { return std::string ("HistogramMatchingImageFilter"); }
105 
107  std::string ToString() const;
108 
109 
112  Image Execute ( const Image & image, const Image & referenceImage );
113 
114  private:
115 
118  using MemberFunctionType = Image (Self::*)( const Image * image, const Image * referenceImage );
119  template <class TImageType> Image ExecuteInternal ( const Image * image, const Image * referenceImage );
120 
121 
123 
124  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
125 
126 
127  uint32_t m_NumberOfHistogramLevels{256u};
128 
129  uint32_t m_NumberOfMatchPoints{1u};
130 
131  bool m_ThresholdAtMeanIntensity{true};
132 
133 
134  };
135 
146  SITKBasicFilters_EXPORT Image HistogramMatching ( const Image & image, const Image & referenceImage, uint32_t numberOfHistogramLevels = 256u, uint32_t numberOfMatchPoints = 1u, bool thresholdAtMeanIntensity = true );
147 
149  }
150 }
151 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::HistogramMatchingImageFilter::SetNumberOfMatchPoints
Self & SetNumberOfMatchPoints(uint32_t NumberOfMatchPoints)
Definition: sitkHistogramMatchingImageFilter.h:82
itk::simple::HistogramMatchingImageFilter::GetName
std::string GetName() const
Definition: sitkHistogramMatchingImageFilter.h:104
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::HistogramMatching
Image HistogramMatching(const Image &image, const Image &referenceImage, uint32_t numberOfHistogramLevels=256u, uint32_t numberOfMatchPoints=1u, bool thresholdAtMeanIntensity=true)
Normalize the grayscale values for a source image by matching the shape of the source image histogram...
itk::simple::HistogramMatchingImageFilter::MemberFunctionType
Image(Self::*)(const Image *image, const Image *referenceImage) MemberFunctionType
Definition: sitkHistogramMatchingImageFilter.h:118
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:53
itk::uint32_t
std::uint32_t uint32_t
itk::simple::HistogramMatchingImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkHistogramMatchingImageFilter.h:124
sitkImageFilter.h
itk::simple::HistogramMatchingImageFilter::GetThresholdAtMeanIntensity
bool GetThresholdAtMeanIntensity() const
Definition: sitkHistogramMatchingImageFilter.h:101
itk::simple::HistogramMatchingImageFilter::ThresholdAtMeanIntensityOff
Self & ThresholdAtMeanIntensityOff()
Definition: sitkHistogramMatchingImageFilter.h:96
itk::simple::HistogramMatchingImageFilter::SetThresholdAtMeanIntensity
Self & SetThresholdAtMeanIntensity(bool ThresholdAtMeanIntensity)
Definition: sitkHistogramMatchingImageFilter.h:92
itk::simple::HistogramMatchingImageFilter::ThresholdAtMeanIntensityOn
Self & ThresholdAtMeanIntensityOn()
Definition: sitkHistogramMatchingImageFilter.h:95
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::HistogramMatchingImageFilter
Normalize the grayscale values for a source image by matching the shape of the source image histogram...
Definition: sitkHistogramMatchingImageFilter.h:54
itk::simple::HistogramMatchingImageFilter::GetNumberOfMatchPoints
uint32_t GetNumberOfMatchPoints() const
Definition: sitkHistogramMatchingImageFilter.h:87
itk
itk::simple::HistogramMatchingImageFilter::SetNumberOfHistogramLevels
Self & SetNumberOfHistogramLevels(uint32_t NumberOfHistogramLevels)
Definition: sitkHistogramMatchingImageFilter.h:72
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::HistogramMatchingImageFilter::GetNumberOfHistogramLevels
uint32_t GetNumberOfHistogramLevels() const
Definition: sitkHistogramMatchingImageFilter.h:77
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::HistogramMatchingImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkHistogramMatchingImageFilter.h:66