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 ITK_TEMPLATE_EXPORT GaussianSpatialObject:
  public SpatialObject< TDimension >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(GaussianSpatialObject);

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

  static constexpr unsigned int ObjectDimensions = TDimension;

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

  itkSetMacro(RadiusInObjectSpace, ScalarType);
  itkGetConstReferenceMacro(RadiusInObjectSpace, ScalarType);

  itkSetMacro(SigmaInObjectSpace, ScalarType);
  itkGetConstReferenceMacro(SigmaInObjectSpace, ScalarType);

  itkSetMacro(CenterInObjectSpace, PointType);
  itkGetConstReferenceMacro(CenterInObjectSpace, PointType);

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

  ScalarType SquaredZScoreInObjectSpace(const PointType & point) const;

  ScalarType SquaredZScoreInWorldSpace(const PointType & point) const;

  bool IsInsideInObjectSpace(const PointType & point, unsigned int depth = 0,
    const std::string & name = "") const override;

  bool ComputeMyBoundingBox() const override;

  bool ValueAtInObjectSpace(const PointType & point, double & value,
    unsigned int depth = 0, const std::string & name = "") const override;

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

protected:
  GaussianSpatialObject();
  ~GaussianSpatialObject() override = default;

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

  typename LightObject::Pointer InternalClone() const override;

private:
  ScalarType m_Maximum;
  ScalarType m_RadiusInObjectSpace;
  ScalarType m_SigmaInObjectSpace;
  PointType  m_CenterInObjectSpace;
};
} // end namespace itk

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

#endif // itkGaussianSpatialObject_h