itkMahalanobisDistanceThresholdImageFunction.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 itkMahalanobisDistanceThresholdImageFunction_h
#define itkMahalanobisDistanceThresholdImageFunction_h

#include "itkImageFunction.h"
#include "itkMahalanobisDistanceMembershipFunction.h"

namespace itk
{
template< typename TInputImage, typename TCoordRep = float >
class ITK_TEMPLATE_EXPORT MahalanobisDistanceThresholdImageFunction:
  public ImageFunction< TInputImage, bool, TCoordRep >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(MahalanobisDistanceThresholdImageFunction);

  using Self = MahalanobisDistanceThresholdImageFunction;
  using Superclass = ImageFunction< TInputImage, bool, TCoordRep >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(MahalanobisDistanceThresholdImageFunction, ImageFunction);

  itkNewMacro(Self);

  using InputImageType = typename Superclass::InputImageType;

  using PixelType = typename TInputImage::PixelType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using PointType = typename Superclass::PointType;

  using IndexType = typename Superclass::IndexType;

  using ContinuousIndexType = typename Superclass::ContinuousIndexType;

  using CovarianceMatrixType = vnl_matrix< double >;

  using MeanVectorType = vnl_vector< double >;

  bool Evaluate(const PointType & point) const override;

  bool EvaluateAtContinuousIndex(
    const ContinuousIndexType & index) const override;

  bool EvaluateAtIndex(const IndexType & index) const override;

  virtual double EvaluateDistance(const PointType & point) const;

  virtual double EvaluateDistanceAtIndex(const IndexType & index) const;

  itkGetConstReferenceMacro(Threshold, double);
  itkSetMacro(Threshold, double);

  void SetMean(const MeanVectorType & mean);

  itkGetConstReferenceMacro(Mean, MeanVectorType);

  void SetCovariance(const CovarianceMatrixType & cov);

  itkGetConstReferenceMacro(Covariance, CovarianceMatrixType);

protected:
  MahalanobisDistanceThresholdImageFunction();
  ~MahalanobisDistanceThresholdImageFunction() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

private:
  double m_Threshold;

  // This is intended only for Image of Vector pixel type.
  using MahalanobisDistanceFunctionType = Statistics::MahalanobisDistanceMembershipFunction<PixelType>;

  using MahalanobisDistanceFunctionPointer = typename MahalanobisDistanceFunctionType::Pointer;
  MahalanobisDistanceFunctionPointer m_MahalanobisDistanceMembershipFunction;

  // Cached versions of the mean and covariance to manage the
  // difference in vector/matrix types between this class and the
  // membership function used internally.
  MeanVectorType       m_Mean;
  CovarianceMatrixType m_Covariance;
};
} // end namespace itk

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

#endif