itkGaussianSpatialObject.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 itkGaussianSpatialObject_h
#define itkGaussianSpatialObject_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(Sigma, ScalarType);
  itkGetConstReferenceMacro(Sigma, 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 = ITK_NULLPTR) const ITK_OVERRIDE;

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

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

  virtual bool IsInside(const PointType & point) const;

  virtual bool ComputeLocalBoundingBox() const ITK_OVERRIDE;

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

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

  GaussianSpatialObject();
  ~GaussianSpatialObject();

  ScalarType m_Maximum;
  ScalarType m_Radius;
  ScalarType m_Sigma;

  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
};
} // end namespace itk

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

#endif // itkGaussianSpatialObject_h