itkGaussianSpatialObject.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGaussianSpatialObject.h,v $
  Language:  C++
  Date:      $Date: 2009-01-28 20:10:27 $
  Version:   $Revision: 1.13 $

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

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

namespace itk
{

template < unsigned int TDimension = 3 >
class GaussianSpatialObject 
  : public SpatialObject< TDimension >
{

public:

  typedef GaussianSpatialObject                Self;
  typedef double                               ScalarType;
  typedef SmartPointer < Self >                Pointer;
  typedef SmartPointer < const Self >          ConstPointer;
  typedef SpatialObject< TDimension >          Superclass;
  typedef SmartPointer< Superclass >           SuperclassPointer;
  typedef typename Superclass::PointType       PointType;
  typedef typename Superclass::TransformType   TransformType;
  typedef typename Superclass::BoundingBoxType BoundingBoxType;

  itkStaticConstMacro(NumberOfDimensions, unsigned int,
                      TDimension);

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

  itkSetMacro(Radius,ScalarType);
  itkGetConstReferenceMacro(Radius,ScalarType);

  itkSetMacro(Maximum,ScalarType);
  itkGetConstReferenceMacro(Maximum,ScalarType);

  ScalarType SquaredZScore( const PointType& point ) const;

  virtual bool ValueAt( const PointType & point, ScalarType & 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 * name) const;

  virtual bool IsInside( const PointType & point) const;

  virtual bool ComputeLocalBoundingBox() const;

  typename EllipseSpatialObject< TDimension >::Pointer GetEllipsoid() const;

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

  ScalarType m_Maximum;
  ScalarType m_Radius;

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

};

} // end namespace itk

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

#endif // __itkGaussianSpatialObject_h