itkBoxSpatialObject.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 itkBoxSpatialObject_h
#define itkBoxSpatialObject_h
 
#include "itkSpatialObject.h"
#include "itkAffineTransform.h"
#include "itkFixedArray.h"
 
namespace itk
{
template <unsigned int TDimension = 3>
class ITK_TEMPLATE_EXPORT BoxSpatialObject : public SpatialObject<TDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BoxSpatialObject);
 
  using Self = BoxSpatialObject;
  using ScalarType = double;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using Superclass = SpatialObject<TDimension>;
  using SuperclassPointer = SmartPointer<Superclass>;
  using typename Superclass::PointType;
  using typename Superclass::TransformType;
  using typename Superclass::BoundingBoxType;
  using SizeType = FixedArray<double, TDimension>;
  using PointsContainerType = typename BoundingBoxType::PointsContainer;
 
  itkNewMacro(Self);
  itkOverrideGetNameOfClassMacro(BoxSpatialObject);

  void
  Clear() override;

  itkSetMacro(SizeInObjectSpace, SizeType);

  itkGetConstReferenceMacro(SizeInObjectSpace, SizeType);

  itkSetMacro(PositionInObjectSpace, PointType);

  itkGetConstReferenceMacro(PositionInObjectSpace, PointType);

  bool
  IsInsideInObjectSpace(const PointType & point) const override;
 
  /* Avoid hiding the overload that supports depth and name arguments */
  using Superclass::IsInsideInObjectSpace;
 
protected:
  void
  ComputeMyBoundingBox() override;
 
  BoxSpatialObject();
  ~BoxSpatialObject() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  typename LightObject::Pointer
  InternalClone() const override;
 
private:
  SizeType  m_SizeInObjectSpace{};
  PointType m_PositionInObjectSpace{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBoxSpatialObject.hxx"
#endif
 
#endif // itkBoxSpatialObject_h