itkBoundingBox.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkBoundingBox.h,v $
  Language:  C++
  Date:      $Date: 2007-10-27 19:51:42 $
  Version:   $Revision: 1.37 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  Portions of this code are covered under the VTK copyright.
  See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkBoundingBox_h
#define __itkBoundingBox_h

#include "itkObject.h"
#include "itkPoint.h"
#include "itkNumericTraits.h"
#include "itkVectorContainer.h"
#include "itkFixedArray.h"


namespace itk
{

template <
  typename TPointIdentifier = unsigned long,
  int VPointDimension = 3,
  typename TCoordRep = float,
  typename TPointsContainer = 
    VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >
  >
class ITK_EXPORT BoundingBox : public Object
{
public:
  typedef BoundingBox               Self;
  typedef Object                    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkTypeMacro( BoundingBox, Object );

  itkNewMacro(Self);

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

  typedef Point< CoordRepType, VPointDimension >         PointType;
  typedef FixedArray< CoordRepType, VPointDimension*2 >  BoundsArrayType;
  
  itkStaticConstMacro(PointDimension, unsigned int,  VPointDimension);

  typedef typename
          PointsContainer::ConstIterator        PointsContainerConstIterator;
  typedef typename
          PointsContainer::Iterator             PointsContainerIterator;

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

  const PointsContainer * GetCorners(void);

  bool ComputeBoundingBox(void) const;

  itkGetConstReferenceMacro( Bounds, BoundsArrayType );

  PointType GetCenter(void) const;

  PointType GetMinimum(void) const;

  void      SetMinimum(const PointType & );

  PointType GetMaximum(void) const;

  void      SetMaximum(const PointType & );

  void ConsiderPoint( const PointType & );

  typedef typename NumericTraits<CoordRepType>::AccumulateType AccumulateType;
  AccumulateType GetDiagonalLength2(void) const;

  bool IsInside( const PointType & ) const;

  unsigned long GetMTime( void ) const;

  Pointer DeepCopy() const; 

#if 0

  bool IntersectWithLine(CoordRepType origin[PointDimension],
       CoordRepType direction[PointDimension],
       CoordRepType coords[PointDimension],
       CoordRepType* t);

#endif

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

  typedef typename PointsContainer::ConstIterator  ConstIterator; 

private:
  BoundingBox(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  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.txx"
#endif
  
#endif