itkMammogramFatEstimationFitMetric.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

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

#ifndef __itkMammogramFatEstimationFitMetric_h
#define __itkMammogramFatEstimationFitMetric_h

#include <itkSingleValuedCostFunction.h>
#include <itkImageRegionIterator.h>
#include <itkImageRegionIteratorWithIndex.h>
#include <itkImageRegionConstIterator.h>
#include <itkImageRegionConstIteratorWithIndex.h>

namespace itk {
  
class  ITK_EXPORT MammogramFatEstimationFitMetric :
  public SingleValuedCostFunction
{
//  Software Guide : EndCodeSnippet
public:
  typedef MammogramFatEstimationFitMetric  Self;
  typedef SingleValuedCostFunction   Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
  
  itkTypeMacro( MammogramFatEstimationFitMetric, SingleValuedCostFunction );

  itkNewMacro(Self);


  typedef Superclass::ParametersType ParametersType;
  typedef Superclass::DerivativeType DerivativeType;
  typedef Superclass::MeasureType    MeasureType;

  itkStaticConstMacro( ParametricSpaceDimension, unsigned int, 0 );

  virtual unsigned int GetNumberOfParameters(void) const override  
  {
    return ParametricSpaceDimension;
  }

  void GetDerivative( const ParametersType &parameters, 
                      DerivativeType &Derivative ) const override
  {
    return;
  }

  virtual MeasureType GetValue( const ParametersType &parameters ) const override;

  void GetValueAndDerivative( const ParametersType &parameters,
                              MeasureType &Value, 
                              DerivativeType &Derivative ) const override
  {
    Value = this->GetValue( parameters );
    this->GetDerivative( parameters, Derivative );
  }

  virtual void WriteIntensityVsEdgeDistToFile( std::string fileOutputIntensityVsEdgeDist );
  virtual void WriteFitToFile( std::string fileOutputFit,
                               const ParametersType &parameters );


protected:

  MammogramFatEstimationFitMetric();
  virtual ~MammogramFatEstimationFitMetric();
  MammogramFatEstimationFitMetric(const Self &) {}
  void operator=(const Self &) {}
  void PrintSelf(std::ostream & os, Indent indent) const override;

};

} // end namespace itk

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

#endif