1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkMaskImageFilter_h
#define itkMaskImageFilter_h
#include "itkBinaryGeneratorImageFilter.h"
#include "itkNumericTraits.h"
#include "itkVariableLengthVector.h"
#include "itkMath.h"
namespace itk
{
namespace Functor
{
/**
* \class MaskInput
* \brief
* \ingroup ITKImageIntensity
*/
template <typename TInput, typename TMask, typename TOutput = TInput>
class MaskInput
{
public:
using AccumulatorType = typename NumericTraits<TInput>::AccumulateType;
MaskInput() = default;
~MaskInput() = default;
bool
operator==(const MaskInput &) const
{
return true;
}
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(MaskInput);
inline TOutput
operator()(const TInput & A, const TMask & B) const
{
if (B != m_MaskingValue)
{
return static_cast<TOutput>(A);
}
else
{
return m_OutsideValue;
}
}
/** Method to explicitly set the outside value of the mask */
void
SetOutsideValue(const TOutput & outsideValue)
{
m_OutsideValue = outsideValue;
}
/** Method to get the outside value of the mask */
const TOutput &
GetOutsideValue() const
{
return m_OutsideValue;
}
/** Method to explicitly set the masking value */
void
SetMaskingValue(const TMask & maskingValue)
{
m_MaskingValue = maskingValue;
}
/** Method to get the masking value */
const TMask &
GetMaskingValue() const
{
return m_MaskingValue;
}
private:
template <typename TPixelType>
TPixelType
DefaultOutsideValue(TPixelType *)
{
return TPixelType{};
}
template <typename TValue>
VariableLengthVector<TValue>
DefaultOutsideValue(VariableLengthVector<TValue> *)
{
// set the outside value to be of zero length
return VariableLengthVector<TValue>(0);
}
TOutput m_OutsideValue{ DefaultOutsideValue(static_cast<TOutput *>(nullptr)) };
TMask m_MaskingValue{};
};
} // namespace Functor
/**
* \class MaskImageFilter
* \brief Mask an image with a mask.
*
* This class is templated over the types of the
* input image type, the mask image type and the type of the output image.
* Numeric conversions (castings) are done by the C++ defaults.
*
* The pixel type of the input 2 image must have a valid definition of the
* operator != with zero. This condition is required because internally this
* filter will perform the operation
*
\code
if pixel_from_mask_image != masking_value
pixel_output_image = pixel_input_image
else
pixel_output_image = outside_value
\endcode
*
* The pixel from the input 1 is cast to the pixel type of the output image.
*
* Note that the input and the mask images must be of the same size.
*
* \warning Any pixel value other than masking value (0 by default) will not be masked out.
*
* \sa MaskNegatedImageFilter
* \ingroup IntensityImageFilters
* \ingroup MultiThreaded
* \ingroup ITKImageIntensity
*
* \sphinx
* \sphinxexample{Filtering/ImageIntensity/MaskImage,Mask Image}
* \endsphinx
*/
template <typename TInputImage, typename TMaskImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT MaskImageFilter : public BinaryGeneratorImageFilter<TInputImage, TMaskImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(MaskImageFilter);
/** Standard class type aliases. */
using Self = MaskImageFilter;
using Superclass = BinaryGeneratorImageFilter<TInputImage, TMaskImage, TOutputImage>;
using FunctorType = Functor::
MaskInput<typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(MaskImageFilter);
/** Typedefs **/
using MaskImageType = TMaskImage;
/** Set/Get the mask image. Pixels set in the mask image will retain
* the original value of the input image while pixels not set in
* the mask will be set to the "OutsideValue".
*/
void
SetMaskImage(const MaskImageType * maskImage)
{
// Process object is not const-correct so the const casting is required.
this->SetNthInput(1, const_cast<MaskImageType *>(maskImage));
}
const MaskImageType *
GetMaskImage()
{
return static_cast<const MaskImageType *>(this->ProcessObject::GetInput(1));
}
/** Method to explicitly set the outside value of the mask. Defaults to 0 */
void
SetOutsideValue(const typename TOutputImage::PixelType & outsideValue)
{
if (Math::NotExactlyEquals(this->GetOutsideValue(), outsideValue))
{
this->Modified();
this->GetFunctor().SetOutsideValue(outsideValue);
}
}
const typename TOutputImage::PixelType &
GetOutsideValue() const
{
return this->GetFunctor().GetOutsideValue();
}
/** Method to explicitly set the masking value of the mask. Defaults to 0 */
void
SetMaskingValue(const typename TMaskImage::PixelType & maskingValue)
{
if (this->GetMaskingValue() != maskingValue)
{
this->Modified();
this->GetFunctor().SetMaskingValue(maskingValue);
}
}
/** Method to get the masking value of the mask. */
const typename TMaskImage::PixelType &
GetMaskingValue() const
{
return this->GetFunctor().GetMaskingValue();
}
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro(MaskEqualityComparableCheck, (Concept::EqualityComparable<typename TMaskImage::PixelType>));
itkConceptMacro(InputConvertibleToOutputCheck,
(Concept::Convertible<typename TInputImage::PixelType, typename TOutputImage::PixelType>));
// End concept checking
#endif
protected:
MaskImageFilter() = default;
~MaskImageFilter() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override
{
Superclass::PrintSelf(os, indent);
os << indent << "OutsideValue: " << this->GetOutsideValue() << std::endl;
}
void
BeforeThreadedGenerateData() override
{
using PixelType = typename TOutputImage::PixelType;
this->CheckOutsideValue(static_cast<PixelType *>(nullptr));
this->SetFunctor(this->GetFunctor());
}
private:
itkGetConstReferenceMacro(Functor, FunctorType);
FunctorType &
GetFunctor()
{
return m_Functor;
}
FunctorType m_Functor{};
template <typename TPixelType>
void
CheckOutsideValue(const TPixelType *)
{}
template <typename TValue>
void
CheckOutsideValue(const VariableLengthVector<TValue> *)
{
// Check to see if the outside value contains only zeros. If so,
// resize it to have the same number of zeros as the output
// image. Otherwise, check that the number of components in the
// outside value is the same as the number of components in the
// output image. If not, throw an exception.
VariableLengthVector<TValue> currentValue = this->GetFunctor().GetOutsideValue();
VariableLengthVector<TValue> zeroVector(currentValue.GetSize());
zeroVector.Fill(TValue{});
if (currentValue == zeroVector)
{
zeroVector.SetSize(this->GetOutput()->GetVectorLength());
zeroVector.Fill(TValue{});
this->GetFunctor().SetOutsideValue(zeroVector);
}
else if (this->GetFunctor().GetOutsideValue().GetSize() != this->GetOutput()->GetVectorLength())
{
itkExceptionMacro("Number of components in OutsideValue: "
<< this->GetFunctor().GetOutsideValue().GetSize() << " is not the same as the "
<< "number of components in the image: " << this->GetOutput()->GetVectorLength());
}
}
};
} // end namespace itk
#endif
|