SimpleITK  2.0.0rc2.post21
sitkLabelMapMaskImageFilter.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 sitkLabelMapMaskImageFilter_h
19 #define sitkLabelMapMaskImageFilter_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 sitkDualImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkImageFilter.h"
31 #include "sitkBasicFilters.h"
32 
33 namespace itk {
34  namespace simple {
35 
51  public:
53 
55  virtual ~LabelMapMaskImageFilter();
56 
60 
63 
64 \
65 
69  SITK_RETURN_SELF_TYPE_HEADER SetLabel ( uint64_t Label ) { this->m_Label = Label; return *this; }
70 
74  uint64_t GetLabel() const { return this->m_Label; }\
75 
79  SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }
80 
84  double GetBackgroundValue() const { return this->m_BackgroundValue; }\
85 
89  SITK_RETURN_SELF_TYPE_HEADER SetNegated ( bool Negated ) { this->m_Negated = Negated; return *this; }
90 
92  SITK_RETURN_SELF_TYPE_HEADER NegatedOn() { return this->SetNegated(true); }
93  SITK_RETURN_SELF_TYPE_HEADER NegatedOff() { return this->SetNegated(false); }
94 
98  bool GetNegated() const { return this->m_Negated; }\
99 
103  SITK_RETURN_SELF_TYPE_HEADER SetCrop ( bool Crop ) { this->m_Crop = Crop; return *this; }
104 
106  SITK_RETURN_SELF_TYPE_HEADER CropOn() { return this->SetCrop(true); }
107  SITK_RETURN_SELF_TYPE_HEADER CropOff() { return this->SetCrop(false); }
108 
112  bool GetCrop() const { return this->m_Crop; }\
113 
117  SITK_RETURN_SELF_TYPE_HEADER SetCropBorder ( std::vector<unsigned int> CropBorder ) { this->m_CropBorder = std::move(CropBorder); return *this; }
118 
120  SITK_RETURN_SELF_TYPE_HEADER SetCropBorder( unsigned int value ) { this->m_CropBorder = std::vector<unsigned int>(3, value); return *this; }
121 
125  std::vector<unsigned int> GetCropBorder() const { return this->m_CropBorder; }
126 
128  std::string GetName() const { return std::string ("LabelMapMaskImageFilter"); }
129 
131  std::string ToString() const;
132 
133 
136  Image Execute ( const Image & labelMapImage, const Image & featureImage );
137 
138 
139  private:
141  using MemberFunctionType = Image (Self::*)( const Image * labelMapImage, const Image * featureImage );
142 
144  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * labelMapImage, const Image * featureImage );
145 
146 
147  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
148 
149 
150 
151  /* */
152  uint64_t m_Label{1u};
153 
154  /* */
155  double m_BackgroundValue{0};
156 
157  /* */
158  bool m_Negated{false};
159 
160  /* */
161  bool m_Crop{false};
162 
163  std::vector<unsigned int> m_CropBorder{std::vector<unsigned int>(3, 0)};
164 
165 
166  };
167 
178  SITKBasicFilters_EXPORT Image LabelMapMask ( const Image & labelMapImage, const Image & featureImage, uint64_t label = 1u, double backgroundValue = 0, bool negated = false, bool crop = false, std::vector<unsigned int> cropBorder = std::vector<unsigned int>(3, 0) );
179 
181  }
182 }
183 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::LabelMapMaskImageFilter::CropOn
Self & CropOn()
Definition: sitkLabelMapMaskImageFilter.h:106
itk::simple::LabelMapMaskImageFilter::SetCropBorder
Self & SetCropBorder(unsigned int value)
Definition: sitkLabelMapMaskImageFilter.h:120
itk::simple::LabelMapMaskImageFilter::MemberFunctionType
Image(Self::*)(const Image *labelMapImage, const Image *featureImage) MemberFunctionType
Definition: sitkLabelMapMaskImageFilter.h:141
itk::simple::LabelMapMask
Image LabelMapMask(const Image &labelMapImage, const Image &featureImage, uint64_t label=1u, double backgroundValue=0, bool negated=false, bool crop=false, std::vector< unsigned int > cropBorder=std::vector< unsigned int >(3, 0))
Mask and image with a LabelMap .
itk::simple::LabelMapMaskImageFilter::GetCrop
bool GetCrop() const
Definition: sitkLabelMapMaskImageFilter.h:112
itk::simple::LabelMapMaskImageFilter::PixelIDTypeList
LabelPixelIDTypeList PixelIDTypeList
Definition: sitkLabelMapMaskImageFilter.h:62
itk::simple::LabelMapMaskImageFilter::GetCropBorder
std::vector< unsigned int > GetCropBorder() const
Definition: sitkLabelMapMaskImageFilter.h:125
itk::simple::LabelMapMaskImageFilter::SetNegated
Self & SetNegated(bool Negated)
Definition: sitkLabelMapMaskImageFilter.h:89
itk::simple::LabelMapMaskImageFilter::SetCropBorder
Self & SetCropBorder(std::vector< unsigned int > CropBorder)
Definition: sitkLabelMapMaskImageFilter.h:117
itk::simple::LabelMapMaskImageFilter::GetLabel
uint64_t GetLabel() const
Definition: sitkLabelMapMaskImageFilter.h:74
itk::simple::LabelMapMaskImageFilter::CropOff
Self & CropOff()
Definition: sitkLabelMapMaskImageFilter.h:107
sitkImageFilter.h
itk::uint64_t
::uint64_t uint64_t
itk::simple::LabelMapMaskImageFilter::SetBackgroundValue
Self & SetBackgroundValue(double BackgroundValue)
Definition: sitkLabelMapMaskImageFilter.h:79
itk::simple::LabelMapMaskImageFilter::GetName
std::string GetName() const
Definition: sitkLabelMapMaskImageFilter.h:128
itk::simple::LabelMapMaskImageFilter::NegatedOn
Self & NegatedOn()
Definition: sitkLabelMapMaskImageFilter.h:92
itk::simple::Crop
Image Crop(Image &&image1, std::vector< unsigned int > lowerBoundaryCropSize=std::vector< unsigned int >(3, 0), std::vector< unsigned int > upperBoundaryCropSize=std::vector< unsigned int >(3, 0))
Decrease the image size by cropping the image by an itk::Size at both the upper and lower bounds of t...
sitkDualMemberFunctionFactory.h
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::LabelMapMaskImageFilter::GetBackgroundValue
double GetBackgroundValue() const
Definition: sitkLabelMapMaskImageFilter.h:84
itk::simple::LabelMapMaskImageFilter::m_DualMemberFactory
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkLabelMapMaskImageFilter.h:147
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:44
itk
Label
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::LabelMapMaskImageFilter::SetCrop
Self & SetCrop(bool Crop)
Definition: sitkLabelMapMaskImageFilter.h:103
itk::simple::LabelMapMaskImageFilter::SetLabel
Self & SetLabel(uint64_t Label)
Definition: sitkLabelMapMaskImageFilter.h:69
itk::simple::LabelMapMaskImageFilter::GetNegated
bool GetNegated() const
Definition: sitkLabelMapMaskImageFilter.h:98
itk::simple::LabelMapMaskImageFilter
Mask and image with a LabelMap .
Definition: sitkLabelMapMaskImageFilter.h:50
itk::simple::LabelPixelIDTypeList
typelist::MakeTypeList< LabelPixelID< uint8_t >, LabelPixelID< uint16_t >, LabelPixelID< uint32_t > >::Type LabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:165
itk::simple::LabelMapMaskImageFilter::NegatedOff
Self & NegatedOff()
Definition: sitkLabelMapMaskImageFilter.h:93