itkTubeSpatialObject.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkTubeSpatialObject.h,v $
  Language:  C++
  Date:      $Date: 2010-01-21 22:33:38 $
  Version:   $Revision: 1.48 $

  Copyright (c) Insight Software 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 __itkTubeSpatialObject_h
#define __itkTubeSpatialObject_h

#include <list>

#include "itkPointBasedSpatialObject.h"
#include "itkTubeSpatialObjectPoint.h"

namespace itk 
{

template < unsigned int TDimension = 3, 
           typename TTubePointType = TubeSpatialObjectPoint<TDimension> >
class ITK_EXPORT TubeSpatialObject 
  :public PointBasedSpatialObject< TDimension >
{

public:

  typedef TubeSpatialObject                            Self;
  typedef PointBasedSpatialObject< TDimension >        Superclass;
  typedef SmartPointer < Self >                        Pointer;
  typedef SmartPointer < const Self >                  ConstPointer;
  typedef double                                       ScalarType;
  typedef TTubePointType                               TubePointType;
  typedef std::vector< TubePointType >                 PointListType;
  typedef PointListType *                              PointListPointer;
  typedef typename Superclass::PointType               PointType;
  typedef typename Superclass::TransformType           TransformType;
  typedef typename Superclass::SpatialObjectPointType  SpatialObjectPointType;
  typedef VectorContainer<unsigned long,PointType>     PointContainerType;
  typedef SmartPointer<PointContainerType>             PointContainerPointer;
  typedef typename Superclass::VectorType              VectorType;
  typedef typename Superclass::CovariantVectorType     CovariantVectorType;
  typedef typename Superclass::BoundingBoxType         BoundingBoxType;

  itkNewMacro( Self );

  itkTypeMacro( TubeSpatialObject, PointBasedSpatialObject );
    
  virtual PointListType & GetPoints( void );

  virtual const PointListType & GetPoints( void ) const;

  virtual void SetPoints( PointListType & newPoints );

  virtual const SpatialObjectPointType* GetPoint(unsigned long ind) const 
    {return &(m_Points[ind]);}
  
  virtual SpatialObjectPointType* GetPoint(unsigned long ind) 
      {return &(m_Points[ind]);}
  
  virtual void SetPoint(unsigned long ind, const TubePointType & pnt) 
    {m_Points[ind] = pnt;}
  
  virtual void RemovePoint(unsigned long ind)
    {m_Points.erase(m_Points.begin()+ind);}
  
  virtual unsigned long GetNumberOfPoints(void) const 
    {return m_Points.size();}

  itkSetMacro(EndType,unsigned int);
  itkGetConstMacro(EndType,unsigned int);

  void Clear( void );

  bool ComputeTangentAndNormals( void );

  unsigned int RemoveDuplicatePoints(unsigned int step=1);

  bool IsEvaluableAt( const PointType & point,
                      unsigned int depth=0, char * name=NULL ) const;

  bool ValueAt( const PointType & point, double & value,
                unsigned int depth=0, char * name=NULL ) const;

  bool IsInside( const PointType & point, 
                 unsigned int depth, char * name) const;

  virtual bool IsInside( const PointType & point) const;

  bool ComputeLocalBoundingBox( ) const;

  itkSetMacro(ParentPoint,int);
  itkGetConstMacro(ParentPoint,int);

  itkSetMacro(Root, bool);
  itkGetConstMacro(Root, bool);

  itkSetMacro(Artery, bool);
  itkGetConstMacro(Artery, bool);

  void CopyInformation(const DataObject *data);


protected:
  PointListType     m_Points;
  int               m_ParentPoint;
  unsigned int      m_EndType;

  bool              m_Root;
  bool              m_Artery;

  TubeSpatialObject();
  virtual ~TubeSpatialObject();

  virtual void PrintSelf( std::ostream& os, Indent indent ) const;
  
  mutable unsigned long m_OldMTime;
  mutable unsigned long m_IndexToWorldTransformMTime;

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

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION 
#include "itkTubeSpatialObject.txx" 
#endif 

#endif // __itkTubeSpatialObject_h