SimpleITK  
sitkMaskImageFilter.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 sitkMaskImageFilter_h
19#define sitkMaskImageFilter_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.jinja to make changes.
25 */
26
27#include <memory>
28
29#include "sitkImageFilter.h"
31#include "sitkBasicFilters.h"
33
34namespace itk::simple {
35
70public:
72
75
79
82
83
84
85
89 void
90 SetOutsideValue(double OutsideValue )
91 { this->m_OutsideValue = OutsideValue; }
92
94 double
95 GetOutsideValue() const { return this->m_OutsideValue; }
96
97
101 void
102 SetMaskingValue(double MaskingValue )
103 { this->m_MaskingValue = MaskingValue; }
104
107 double
108 GetMaskingValue() const { return this->m_MaskingValue; }
109
110
112 std::string GetName() const { return std::string("MaskImageFilter"); }
113
115 std::string ToString() const;
116
117
119#ifndef SWIG
120 Image Execute(Image &&image, const Image &maskImage);
121#endif
122 Image Execute(const Image &image, const Image &maskImage);
123
124private:
125
127 using MemberFunctionType = Image (Self::*)(const Image *
128 image, const Image *
129 maskImage);
130
132 template <class TImageType1, class TImageType2> Image DualExecuteInternal(const Image *
133 image, const Image *
134 maskImage);
135
136
138
139
140
141 double m_OutsideValue{ 0 };
142
143 double m_MaskingValue{ 0 };
144
145
146
147
148
149
150
151 bool m_InPlace{false};
152
153};
154
155
164#ifndef SWIG
166 Image &&image, const Image &maskImage, double outsideValue = 0, double maskingValue = 0
167);
168
169
170#endif
172 const Image &image, const Image &maskImage, double outsideValue = 0, double maskingValue = 0
173);
174
176
177}
178#endif
The Image class for SimpleITK.
Definition sitkImage.h:77
void SetOutsideValue(double OutsideValue)
void SetMaskingValue(double MaskingValue)
NonLabelPixelIDTypeList PixelIDTypeList
static const detail::DualMemberFunctionFactory< MemberFunctionType > & GetMemberFunctionFactory()
std::string ToString() const
Image DualExecuteInternal(const Image *image, const Image *maskImage)
Image(Self::*)(const Image * image, const Image * maskImage) MemberFunctionType
Image Execute(Image &&image, const Image &maskImage)
A class used to instantiate and generate function objects of templated member functions with two temp...
typelist2::append< BasicPixelIDTypeList, ComplexPixelIDTypeList, VectorPixelIDTypeList >::type NonLabelPixelIDTypeList
Image Mask(Image &&image, const Image &maskImage, double outsideValue=0, double maskingValue=0)
Mask an image with a mask.
#define SITKBasicFilters_EXPORT