itkImageMaskSpatialObject.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkImageMaskSpatialObject_h
#define itkImageMaskSpatialObject_h
 
#include "itkNumericTraits.h"
#include "itkImageSpatialObject.h"
#include "itkImageSliceConstIteratorWithIndex.h"
 
namespace itk
{
 
template <unsigned int TDimension = 3, typename TPixel = unsigned char>
class ITK_TEMPLATE_EXPORT ImageMaskSpatialObject : public ImageSpatialObject<TDimension, TPixel>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageMaskSpatialObject);
 
  using Self = ImageMaskSpatialObject<TDimension, TPixel>;
  using Superclass = ImageSpatialObject<TDimension, TPixel>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using typename Superclass::ScalarType;
  using typename Superclass::PixelType;
  using typename Superclass::ImageType;
  using typename Superclass::ImagePointer;
  using typename Superclass::IndexType;
  using typename Superclass::RegionType;
  using typename Superclass::SizeType;
  using typename Superclass::TransformType;
  using typename Superclass::PointType;
  using typename Superclass::BoundingBoxType;
  using typename Superclass::InterpolatorType;
 
  using SliceIteratorType = itk::ImageSliceConstIteratorWithIndex<ImageType>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ImageMaskSpatialObject);

  bool
  IsInsideInObjectSpace(const PointType & point) const override;

  itkSetMacro(MaskValue, PixelType);
  itkGetConstReferenceMacro(MaskValue, PixelType);
 
  itkBooleanMacro(UseMaskValue);
  itkSetMacro(UseMaskValue, bool);
  itkGetConstReferenceMacro(UseMaskValue, bool);
 
  /* Avoid hiding the overload that supports depth and name arguments */
  using Superclass::IsInsideInObjectSpace;

  RegionType
  ComputeMyBoundingBoxInIndexSpace() const;
 
#if !defined(ITK_LEGACY_REMOVE)
  itkLegacyMacro(RegionType GetAxisAlignedBoundingBoxRegion() const;)
 
#endif
 
protected:
  void
  ComputeMyBoundingBox() override;
 
  ImageMaskSpatialObject();
  ~ImageMaskSpatialObject() override = default;
 
  typename LightObject::Pointer
  InternalClone() const override;
 
private:
  bool      m_UseMaskValue{ false };
  PixelType m_MaskValue{ NumericTraits<PixelType>::OneValue() };
};
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageMaskSpatialObject.hxx"
#endif
 
#endif // itkImageMaskSpatialObject_h