itkCylinderSpatialObject.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkCylinderSpatialObject.h,v $
  Language:  C++
  Date:      $Date: 2009-04-07 14:33:56 $
  Version:   $Revision: 1.6 $

  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 __itkCylinderSpatialObject_h
#define __itkCylinderSpatialObject_h

#include "itkSpatialObject.h"
#include "itkAffineTransform.h"
#include "itkFixedArray.h"

namespace itk
{

class ITK_EXPORT CylinderSpatialObject 
  : public SpatialObject< 3 >
{

public:

  typedef CylinderSpatialObject                     Self;
  typedef double                                    ScalarType;
  typedef SmartPointer < Self >                     Pointer;
  typedef SmartPointer < const Self >               ConstPointer;
  typedef SpatialObject< 3 >                        Superclass;
  typedef SmartPointer<Superclass>                  SuperclassPointer;
  typedef Superclass::PointType                     PointType;
  typedef Superclass::TransformType                 TransformType;
  typedef Superclass::BoundingBoxType               BoundingBoxType;
  typedef VectorContainer<unsigned long,PointType>  PointContainerType;
  typedef SmartPointer<PointContainerType>          PointContainerPointer;

  itkStaticConstMacro(NumberOfDimension, unsigned int,
                      3);

  itkNewMacro( Self );
  itkTypeMacro( CylinderSpatialObject, SpatialObject );


  itkSetMacro(Radius,double);
  itkGetConstReferenceMacro(Radius,double);

  itkSetMacro(Height,double);
  itkGetConstReferenceMacro(Height,double);

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

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

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

  virtual bool IsInside( const PointType & point) const;

  virtual bool ComputeLocalBoundingBox() const;

protected:
  CylinderSpatialObject(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  CylinderSpatialObject( void );
  ~CylinderSpatialObject( void );

  double m_Radius;
  double m_Height;

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

};

} // end namespace itk

#endif // __itkCylinderSpatialObject_h