itkBoundingBox.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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"

namespace itk
{
template<
  typename TPointIdentifier = IdentifierType,
  int VPointDimension = 3,
  typename TCoordRep = float,
  typename TPointsContainer =
    VectorContainer< TPointIdentifier, Point< TCoordRep, VPointDimension > >
  >
class ITK_TEMPLATE_EXPORT BoundingBox:public Object
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(BoundingBox);

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

  itkTypeMacro(BoundingBox, Object);

  itkNewMacro(Self);

  using PointIdentifier = TPointIdentifier;
  using CoordRepType = TCoordRep;
  using PointsContainer = TPointsContainer;
  using PointsContainerPointer = typename PointsContainer::Pointer;
  using PointsContainerConstPointer = typename PointsContainer::ConstPointer;

  using PointType = Point< CoordRepType, VPointDimension >;
  using BoundsArrayType = FixedArray< CoordRepType, 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;

  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< CoordRepType >::AccumulateType;
  AccumulateType GetDiagonalLength2() const;

  bool IsInside(const PointType &) const;

  ModifiedTimeType GetMTime() const override;

  Pointer DeepCopy() const;

protected:
  BoundingBox();
  ~BoundingBox() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  using ConstIterator = typename PointsContainer::ConstIterator;

private:
  PointsContainerConstPointer m_PointsContainer;
  PointsContainerPointer      m_CornersContainer;
  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