itkSpatialObject.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSpatialObject.h,v $
  Language:  C++
  Date:      $Date: 2002/10/18 19:20:51 $
  Version:   $Revision: 1.12 $

  Copyright (c) 2002 Insight Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.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 __itkSpatialObject_h 
#define __itkSpatialObject_h 
 
#include "itkNDimensionalSpatialObject.h"
#include "itkBoundingBox.h"
#include "itkPoint.h"
#include "itkAffineTransform.h"
#include "itkSmartPointer.h" 
#include "itkVector.h"
#include "itkCovariantVector.h"
#include "itkExceptionObject.h" 
#include <list> 

namespace itk  
{ 

template< unsigned int NDimensions = 3, 
          typename TTransform = AffineTransform< double, 
                                                 NDimensions
          > ,
          unsigned int PipelineDimension = 3 
        > 
class SpatialObject 
:public NDimensionalSpatialObject<PipelineDimension>
{ 

public: 

  typedef double ScalarType;

  typedef SpatialObject<NDimensions,TTransform,PipelineDimension> Self;
  typedef NDimensionalSpatialObject<PipelineDimension> Superclass; 
  
  typedef SmartPointer< Self > Pointer;
  typedef SmartPointer< const Self > ConstPointer;
  
  typedef Point < ScalarType, NDimensions > PointType; 
  typedef PointType * PointPointer; 
  
  typedef Vector< ScalarType, NDimensions > VectorType; 
  typedef VectorType * VectorPointer;

  typedef CovariantVector< double, NDimensions > OutputVectorType; 
  typedef OutputVectorType * OutputVectorPointer;

  typedef TTransform            TransformType;
  typedef typename TransformType::Pointer  TransformPointer;
  typedef const TransformType*             TransformConstPointer;
  
  typedef std::list< TransformType * > TransformListType;
  
  typedef VectorContainer< unsigned long int, PointType > VectorContainerType;
  
  typedef BoundingBox< unsigned long int, NDimensions, ScalarType, VectorContainerType > BoundingBoxType; 
  typedef typename BoundingBoxType::Pointer BoundingBoxPointer; 

  typedef std::list< Self * > ChildrenListType; 

  itkStaticConstMacro(ObjectDimension, unsigned int, NDimensions);

  itkNewMacro( Self );
 
  itkTypeMacro( Self, Superclass );

  void SetBounds( BoundingBoxPointer bounds ); 

  BoundingBoxType * GetBounds( void ) const; 

  void SetLocalToGlobalTransform( TransformType * transform ); 
  const TransformType * GetLocalToGlobalTransform( void ); 
  
  void SetGlobalToLocalTransform( TransformType * transform ); 
  const TransformType * GetGlobalToLocalTransform( void );

  virtual void ValueAt( const PointType & point, double & value ); //purposely not implemented
     
  virtual bool IsEvaluableAt( const PointType & point ); // purposely not implemented

  virtual bool IsInside( const PointType & point ); // purposely not implemented

  void SetParent( const Superclass * parent );

  virtual void DerivativeAt( const PointType & point, short unsigned int order, OutputVectorType & value );

  void TransformPointToLocalCoordinate( PointType & p ) const;

  void TransformPointToGlobalCoordinate( PointType & p ) const; 

  void BuildLocalToGlobalTransformList( TransformListType & list, bool init ) const;

  void BuildGlobalToLocalTransformList( TransformListType & list, bool init ) const;

  TransformListType & GetLocalToGlobalTransformList( void );

  TransformListType & GetGlobalToLocalTransformList( void );

  virtual void ComputeBounds( void ); // purposely not implemented 

  void SetSpacing( const double spacing[ObjectDimension] );

  const double* GetSpacing() const {return m_Spacing;}

  unsigned long GetMTime( void ) const;

  virtual void RebuildLocalToGlobalTransformList( void ) ;

  virtual void RebuildGlobalToLocalTransformList( void ) ;

  virtual void RebuildAllTransformLists( void ) ;

  void AddSpatialObject( Self * pointer ); 
     
  void RemoveSpatialObject( Self * object ); 

  ChildrenListType & GetChildren( void );

  unsigned int GetNumberOfChildren( void ); 

  void SetChildren( ChildrenListType & children ); 

protected: 

  BoundingBoxPointer  m_Bounds; 
  TimeStamp           m_BoundsMTime;
  double              m_Spacing[ObjectDimension]; 

  TransformListType   m_LocalToGlobalTransformList;
  TransformListType   m_GlobalToLocalTransformList;

  TransformPointer    m_LocalToGlobalTransform; 
  TransformPointer    m_GlobalToLocalTransform; 

  SpatialObject(); 

  virtual ~SpatialObject(); 

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

  ChildrenListType m_Children; 

}; 

} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION 
  #include "itkSpatialObject.txx" 
#endif 
 
#endif // __itkSpatialObject_h

---