itkBoundingBox.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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkBoundingBox_h
#define itkBoundingBox_h
 
#include "itkPoint.h"
#include "itkVectorContainer.h"
#include "itkIntTypes.h"
 
#include <array>
 
namespace itk
{

template <typename TPointIdentifier = IdentifierType,
          unsigned int VPointDimension = 3,
          typename TCoordinate = float,
          typename TPointsContainer = VectorContainer<TPointIdentifier, Point<TCoordinate, VPointDimension>>>
class ITK_TEMPLATE_EXPORT BoundingBox : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BoundingBox);

  using Self = BoundingBox;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(BoundingBox);

  itkNewMacro(Self);
 
  /* Number of corners of this bounding box. Equals `pow(2, VPointDimension)` */
  static constexpr SizeValueType NumberOfCorners = SizeValueType{ 1 } << VPointDimension;

  using PointIdentifier = TPointIdentifier;
  using CoordinateType = TCoordinate;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif
  using PointsContainer = TPointsContainer;
  using PointsContainerPointer = typename PointsContainer::Pointer;
  using PointsContainerConstPointer = typename PointsContainer::ConstPointer;
 
  using PointType = Point<CoordinateType, VPointDimension>;
  using BoundsArrayType = FixedArray<CoordinateType, VPointDimension * 2>;

  static constexpr unsigned int PointDimension = VPointDimension;

  using PointsContainerConstIterator = typename PointsContainer::ConstIterator;
  using PointsContainerIterator = typename PointsContainer::Iterator;

  void
  SetPoints(const PointsContainer *);
 
  const PointsContainer *
  GetPoints() const;

  std::array<PointType, NumberOfCorners>
  ComputeCorners() const;

  itkLegacyMacro(const PointsContainer * GetCorners();)

  bool
  ComputeBoundingBox() const;

  itkGetConstReferenceMacro(Bounds, BoundsArrayType);

  PointType
  GetCenter() const;

  PointType
  GetMinimum() const;

  void
  SetMinimum(const PointType &);

  PointType
  GetMaximum() const;

  void
  SetMaximum(const PointType &);

  void
  ConsiderPoint(const PointType &);

  using AccumulateType = typename NumericTraits<CoordinateType>::AccumulateType;
  AccumulateType
  GetDiagonalLength2() const;

  bool
  IsInside(const PointType &) const;

  ModifiedTimeType
  GetMTime() const override;

  Pointer
  DeepCopy() const;
 
protected:
  BoundingBox() = default;
  ~BoundingBox() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  using ConstIterator = typename PointsContainer::ConstIterator;
 
private:
  PointsContainerConstPointer m_PointsContainer{};
#if !defined(ITK_LEGACY_REMOVE)
  PointsContainerPointer m_CornersContainer{ PointsContainer::New() };
#endif
  mutable BoundsArrayType m_Bounds{};
  mutable TimeStamp       m_BoundsMTime{}; // The last time the bounds
                                           // were computed.
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBoundingBox.hxx"
#endif
 
#endif