SimpleITK  2.0.0rc2.post21
sitkCannyEdgeDetectionImageFilter.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 sitkCannyEdgeDetectionImageFilter_h
19 #define sitkCannyEdgeDetectionImageFilter_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 
72  public:
74 
77 
81 
84 \
85 
88  SITK_RETURN_SELF_TYPE_HEADER SetLowerThreshold ( double LowerThreshold ) { this->m_LowerThreshold = LowerThreshold; return *this; }
89 
92  double GetLowerThreshold() const { return this->m_LowerThreshold; }\
93 
98  SITK_RETURN_SELF_TYPE_HEADER SetUpperThreshold ( double UpperThreshold ) { this->m_UpperThreshold = UpperThreshold; return *this; }
99 
102  double GetUpperThreshold() const { return this->m_UpperThreshold; }\
103 
107  SITK_RETURN_SELF_TYPE_HEADER SetVariance ( std::vector<double> Variance ) { this->m_Variance = std::move(Variance); return *this; }
108 
110  SITK_RETURN_SELF_TYPE_HEADER SetVariance( double value ) { this->m_Variance = std::vector<double>(3, value); return *this; }
111 
115  std::vector<double> GetVariance() const { return this->m_Variance; }\
116 
120  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( std::vector<double> MaximumError ) { this->m_MaximumError = std::move(MaximumError); return *this; }
121 
123  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError( double value ) { this->m_MaximumError = std::vector<double>(3, value); return *this; }
124 
128  std::vector<double> GetMaximumError() const { return this->m_MaximumError; }
129 
131  std::string GetName() const { return std::string ("CannyEdgeDetectionImageFilter"); }
132 
134  std::string ToString() const;
135 
136 
139  Image Execute ( const Image& image1 );
140 
141  private:
142 
145  using MemberFunctionType = Image (Self::*)( const Image& image1 );
146  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
147 
148 
150 
151  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
152 
153 
154  double m_LowerThreshold{0.0};
155 
156  double m_UpperThreshold{0.0};
157 
158  /* */
159  std::vector<double> m_Variance{std::vector<double>(3, 0.0)};
160 
161  /* */
162  std::vector<double> m_MaximumError{std::vector<double>(3, 0.01)};
163 
164 
165  };
166 
177  SITKBasicFilters_EXPORT Image CannyEdgeDetection ( const Image& image1, double lowerThreshold = 0.0, double upperThreshold = 0.0, std::vector<double> variance = std::vector<double>(3, 0.0), std::vector<double> maximumError = std::vector<double>(3, 0.01) );
178 
180  }
181 }
182 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::CannyEdgeDetectionImageFilter::SetLowerThreshold
Self & SetLowerThreshold(double LowerThreshold)
Definition: sitkCannyEdgeDetectionImageFilter.h:88
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RealPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< float >, BasicPixelID< double > >::Type RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:96
itk::simple::CannyEdgeDetectionImageFilter::SetMaximumError
Self & SetMaximumError(double value)
Definition: sitkCannyEdgeDetectionImageFilter.h:123
itk::simple::CannyEdgeDetectionImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkCannyEdgeDetectionImageFilter.h:83
sitkImageFilter.h
itk::simple::CannyEdgeDetectionImageFilter
This filter is an implementation of a Canny edge detector for scalar-valued images.
Definition: sitkCannyEdgeDetectionImageFilter.h:71
itk::simple::CannyEdgeDetectionImageFilter::SetMaximumError
Self & SetMaximumError(std::vector< double > MaximumError)
Definition: sitkCannyEdgeDetectionImageFilter.h:120
itk::simple::CannyEdgeDetectionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkCannyEdgeDetectionImageFilter.h:145
itk::simple::CannyEdgeDetectionImageFilter::GetVariance
std::vector< double > GetVariance() const
Definition: sitkCannyEdgeDetectionImageFilter.h:115
itk::simple::CannyEdgeDetectionImageFilter::SetUpperThreshold
Self & SetUpperThreshold(double UpperThreshold)
Set the Threshold value for detected edges. TODO: Document in the ITKv4 migration guide that the SetT...
Definition: sitkCannyEdgeDetectionImageFilter.h:98
itk::simple::CannyEdgeDetectionImageFilter::GetName
std::string GetName() const
Definition: sitkCannyEdgeDetectionImageFilter.h:131
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::CannyEdgeDetectionImageFilter::GetMaximumError
std::vector< double > GetMaximumError() const
Definition: sitkCannyEdgeDetectionImageFilter.h:128
itk::simple::CannyEdgeDetectionImageFilter::SetVariance
Self & SetVariance(double value)
Definition: sitkCannyEdgeDetectionImageFilter.h:110
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::CannyEdgeDetection
Image CannyEdgeDetection(const Image &image1, double lowerThreshold=0.0, double upperThreshold=0.0, std::vector< double > variance=std::vector< double >(3, 0.0), std::vector< double > maximumError=std::vector< double >(3, 0.01))
This filter is an implementation of a Canny edge detector for scalar-valued images.
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::CannyEdgeDetectionImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCannyEdgeDetectionImageFilter.h:151
itk::simple::CannyEdgeDetectionImageFilter::SetVariance
Self & SetVariance(std::vector< double > Variance)
Definition: sitkCannyEdgeDetectionImageFilter.h:107
itk::simple::CannyEdgeDetectionImageFilter::GetUpperThreshold
double GetUpperThreshold() const
Definition: sitkCannyEdgeDetectionImageFilter.h:102
itk::simple::CannyEdgeDetectionImageFilter::GetLowerThreshold
double GetLowerThreshold() const
Definition: sitkCannyEdgeDetectionImageFilter.h:92