SimpleITK  1.1.0
sitkRegionalMinimaImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 sitkRegionalMinimaImageFilter_h
19 #define sitkRegionalMinimaImageFilter_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 
59  public:
61 
63  virtual ~RegionalMinimaImageFilter();
64 
68 
71 
72 
73 
77  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
78 
82  double GetBackgroundValue() const { return this->m_BackgroundValue; }
83 
87  SITK_RETURN_SELF_TYPE_HEADER SetForegroundValue ( double ForegroundValue ) { this->m_ForegroundValue = ForegroundValue; return *this; }
88 
92  double GetForegroundValue() const { return this->m_ForegroundValue; }
93 
97  SITK_RETURN_SELF_TYPE_HEADER SetFullyConnected ( bool FullyConnected ) { this->m_FullyConnected = FullyConnected; return *this; }
98 
100  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOn() { return this->SetFullyConnected(true); }
101  SITK_RETURN_SELF_TYPE_HEADER FullyConnectedOff() { return this->SetFullyConnected(false); }
102 
106  bool GetFullyConnected() const { return this->m_FullyConnected; }
107 
111  SITK_RETURN_SELF_TYPE_HEADER SetFlatIsMinima ( bool FlatIsMinima ) { this->m_FlatIsMinima = FlatIsMinima; return *this; }
112 
114  SITK_RETURN_SELF_TYPE_HEADER FlatIsMinimaOn() { return this->SetFlatIsMinima(true); }
115  SITK_RETURN_SELF_TYPE_HEADER FlatIsMinimaOff() { return this->SetFlatIsMinima(false); }
116 
120  bool GetFlatIsMinima() const { return this->m_FlatIsMinima; }
122  std::string GetName() const { return std::string ("RegionalMinimaImageFilter"); }
123 
125  std::string ToString() const;
126 
127 
129  Image Execute ( const Image& image1 );
130 
131 
133  Image Execute ( const Image& image1, double backgroundValue, double foregroundValue, bool fullyConnected, bool flatIsMinima );
134 
135  private:
136 
139  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
140  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
141 
142 
143  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
144 
145  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
146 
147 
148  /* */
150  /* */
152  /* */
155  };
156 
157 
166  SITKBasicFilters_EXPORT Image RegionalMinima ( const Image& image1, double backgroundValue = 0.0, double foregroundValue = 1.0, bool fullyConnected = false, bool flatIsMinima = true );
167 
168  }
169 }
170 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::RegionalMinimaImageFilter::SetFullyConnected
Self & SetFullyConnected(bool FullyConnected)
Definition: sitkRegionalMinimaImageFilter.h:97
itk::simple::RegionalMinimaImageFilter::GetForegroundValue
double GetForegroundValue() const
Definition: sitkRegionalMinimaImageFilter.h:92
itk::simple::RegionalMinimaImageFilter::GetFullyConnected
bool GetFullyConnected() const
Definition: sitkRegionalMinimaImageFilter.h:106
itk::simple::RegionalMinimaImageFilter::SetFlatIsMinima
Self & SetFlatIsMinima(bool FlatIsMinima)
Definition: sitkRegionalMinimaImageFilter.h:111
itk::simple::RegionalMinimaImageFilter::m_FullyConnected
bool m_FullyConnected
Definition: sitkRegionalMinimaImageFilter.h:153
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::RegionalMinimaImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkRegionalMinimaImageFilter.h:77
itk::simple::RegionalMinimaImageFilter::m_FlatIsMinima
bool m_FlatIsMinima
Definition: sitkRegionalMinimaImageFilter.h:154
itk::simple::RegionalMinimaImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkRegionalMinimaImageFilter.h:145
sitkImageFilter.h
itk::simple::RegionalMinimaImageFilter::Self
RegionalMinimaImageFilter Self
Definition: sitkRegionalMinimaImageFilter.h:60
itk::simple::RegionalMinimaImageFilter::m_BackgroundValue
double m_BackgroundValue
Definition: sitkRegionalMinimaImageFilter.h:149
itk::simple::RegionalMinimaImageFilter::GetName
std::string GetName() const
Definition: sitkRegionalMinimaImageFilter.h:122
itk::simple::RegionalMinimaImageFilter
Produce a binary image where foreground is the regional minima of the input image.
Definition: sitkRegionalMinimaImageFilter.h:58
itk::simple::RegionalMinimaImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkRegionalMinimaImageFilter.h:82
itk::simple::RegionalMinimaImageFilter::GetFlatIsMinima
bool GetFlatIsMinima() const
Definition: sitkRegionalMinimaImageFilter.h:120
itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOn
Self & FlatIsMinimaOn()
Definition: sitkRegionalMinimaImageFilter.h:114
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::RegionalMinimaImageFilter::FlatIsMinimaOff
Self & FlatIsMinimaOff()
Definition: sitkRegionalMinimaImageFilter.h:115
itk::simple::RegionalMinimaImageFilter::m_ForegroundValue
double m_ForegroundValue
Definition: sitkRegionalMinimaImageFilter.h:151
itk
itk::simple::RegionalMinimaImageFilter::SetForegroundValue
Self & SetForegroundValue(double ForegroundValue)
Definition: sitkRegionalMinimaImageFilter.h:87
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::RegionalMinimaImageFilter::FullyConnectedOn
Self & FullyConnectedOn()
Definition: sitkRegionalMinimaImageFilter.h:100
itk::simple::RegionalMinimaImageFilter::FullyConnectedOff
Self & FullyConnectedOff()
Definition: sitkRegionalMinimaImageFilter.h:101
itk::simple::RegionalMinima
Image RegionalMinima(const Image &image1, double backgroundValue=0.0, double foregroundValue=1.0, bool fullyConnected=false, bool flatIsMinima=true)
Produce a binary image where foreground is the regional minima of the input image.
itk::simple::ScalarPixelIDTypeList
BasicPixelIDTypeList ScalarPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:59
itk::simple::RegionalMinimaImageFilter::PixelIDTypeList
ScalarPixelIDTypeList PixelIDTypeList
Definition: sitkRegionalMinimaImageFilter.h:70