SimpleITK  
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 
89  SITK_RETURN_SELF_TYPE_HEADER SetLowerThreshold ( double LowerThreshold ) { this->m_LowerThreshold = LowerThreshold; return *this; }
90 
93  double GetLowerThreshold() const { return this->m_LowerThreshold; }\
94 
99  SITK_RETURN_SELF_TYPE_HEADER SetUpperThreshold ( double UpperThreshold ) { this->m_UpperThreshold = UpperThreshold; return *this; }
100 
103  double GetUpperThreshold() const { return this->m_UpperThreshold; }\
104 
108  SITK_RETURN_SELF_TYPE_HEADER SetVariance ( std::vector<double> Variance ) { this->m_Variance = std::move(Variance); return *this; }
109 
111  SITK_RETURN_SELF_TYPE_HEADER SetVariance( double value ) { this->m_Variance = std::vector<double>(3, value); return *this; }
112 
116  std::vector<double> GetVariance() const { return this->m_Variance; }\
117 
121  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError ( std::vector<double> MaximumError ) { this->m_MaximumError = std::move(MaximumError); return *this; }
122 
124  SITK_RETURN_SELF_TYPE_HEADER SetMaximumError( double value ) { this->m_MaximumError = std::vector<double>(3, value); return *this; }
125 
129  std::vector<double> GetMaximumError() const { return this->m_MaximumError; }
130 
132  std::string GetName() const { return std::string ("CannyEdgeDetectionImageFilter"); }
133 
135  std::string ToString() const;
136 
137 
140  Image Execute ( const Image& image1 );
141 
142  private:
143 
146  using MemberFunctionType = Image (Self::*)( const Image& image1 );
147  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
148 
149 
151 
152  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
153 
154 
155  double m_LowerThreshold{0.0};
156 
157  double m_UpperThreshold{0.0};
158 
159  /* */
160  std::vector<double> m_Variance{std::vector<double>(3, 0.0)};
161 
162  /* */
163  std::vector<double> m_MaximumError{std::vector<double>(3, 0.01)};
164 
165 
166  };
167 
178  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) );
179 
181  }
182 }
183 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::CannyEdgeDetectionImageFilter::SetLowerThreshold
Self & SetLowerThreshold(double LowerThreshold)
Set the lower threshold value for detected edges.
Definition: sitkCannyEdgeDetectionImageFilter.h:89
sitkBasicFilters.h
itk::simple::RealPixelIDTypeList
typelist2::typelist< BasicPixelID< float >, BasicPixelID< double > > RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:100
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::CannyEdgeDetectionImageFilter::SetMaximumError
Self & SetMaximumError(double value)
Definition: sitkCannyEdgeDetectionImageFilter.h:124
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:121
itk::simple::CannyEdgeDetectionImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkCannyEdgeDetectionImageFilter.h:146
itk::simple::CannyEdgeDetectionImageFilter::GetVariance
std::vector< double > GetVariance() const
Definition: sitkCannyEdgeDetectionImageFilter.h:116
itk::simple::CannyEdgeDetectionImageFilter::SetUpperThreshold
Self & SetUpperThreshold(double UpperThreshold)
Set the upper threshold value for detected edges. TODO: Document in the ITKv4 migration guide that th...
Definition: sitkCannyEdgeDetectionImageFilter.h:99
itk::simple::CannyEdgeDetectionImageFilter::GetName
std::string GetName() const
Definition: sitkCannyEdgeDetectionImageFilter.h:132
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::CannyEdgeDetectionImageFilter::GetMaximumError
std::vector< double > GetMaximumError() const
Definition: sitkCannyEdgeDetectionImageFilter.h:129
itk::simple::CannyEdgeDetectionImageFilter::SetVariance
Self & SetVariance(double value)
Definition: sitkCannyEdgeDetectionImageFilter.h:111
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:152
itk::simple::CannyEdgeDetectionImageFilter::SetVariance
Self & SetVariance(std::vector< double > Variance)
Definition: sitkCannyEdgeDetectionImageFilter.h:108
itk::simple::CannyEdgeDetectionImageFilter::GetUpperThreshold
double GetUpperThreshold() const
Definition: sitkCannyEdgeDetectionImageFilter.h:103
itk::simple::CannyEdgeDetectionImageFilter::GetLowerThreshold
double GetLowerThreshold() const
Definition: sitkCannyEdgeDetectionImageFilter.h:93