itkTubeSpatialObject.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.
 *
 *=========================================================================*/
#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< IdentifierType, 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(IdentifierType ind) const
  { return &( m_Points[ind] ); }

  virtual SpatialObjectPointType * GetPoint(IdentifierType ind)
  { return &( m_Points[ind] ); }

  virtual void SetPoint(IdentifierType ind, const TubePointType & pnt)
  { m_Points[ind] = pnt; }

  virtual void RemovePoint(IdentifierType ind)
  { m_Points.erase(m_Points.begin() + ind); }

  virtual SizeValueType 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.hxx"
#endif

#endif // __itkTubeSpatialObject_h