freImageDifferenceSOMetricMonitor.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freImageDifferenceSOMetricMonitor.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/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 __freImageDifferenceSOMetricMonitor_h
#define __freImageDifferenceSOMetricMonitor_h

#include "freSetupOptimizationMetricMonitorBase.h"

namespace FREE
{
class ImageDifferenceSOMetricResult: public SetupOptimizationMetricResult
{
public:
  typedef std::vector<double> PointErrorListType;

  void SetError(const double& error) {m_Error = error;};
  void SetVariance(const double& var) {m_Var = var;};
  void SetMinError(const double& error) {m_MinError = error;};
  void SetMaxError(const double& error) {m_MaxError = error;};
  void SetImageError(const double& error) {m_ImageError = error;};
  void SetSamplesize(const unsigned long& size) {m_Samplesize = size;};
  void SetDuration(const unsigned long& dur) {m_Duration = dur;};

  const double& GetError() const { return m_Error;};
  const double& GetVariance() const { return m_Var;};
  const double& GetMinError() const { return m_MinError;};
  const double& GetMaxError() const { return m_MaxError;};
  const double& GetImageError() const { return m_ImageError;};
  const unsigned long& GetSamplesize() const { return m_Samplesize;};
  const unsigned long& GetDuration() const { return m_Duration;};

  double& GetError() { return m_Error;};
  double& GetVariance() { return m_Var;};
  double& GetMinError() { return m_MinError;};
  double& GetMaxError() { return m_MaxError;};
  double& GetImageError() { return m_ImageError;};
  unsigned long& GetSamplesize() { return m_Samplesize;};
  unsigned long& GetDuration() { return m_Duration;};
  
  virtual void Reset();

  ImageDifferenceSOMetricResult();
protected:
        double m_Error;
        double m_Var;
        double m_MinError;
        double m_MaxError;
        double m_ImageError;

  unsigned long m_Samplesize;
  unsigned long m_Duration;  
};

class ITK_EXPORT ImageDifferenceSOMetricMonitor : 
  public SetupOptimizationMetricMonitorBase<ImageDifferenceSOMetricResult>
{
public:
  typedef ImageDifferenceSOMetricMonitor  Self;
  typedef SetupOptimizationMetricMonitorBase<ImageDifferenceSOMetricResult>   Superclass;
  typedef itk::SmartPointer<Self>           Pointer;
  typedef itk::SmartPointer<const Self>     ConstPointer;

  //Class containing the results of one adaptation evaluation
  //depends on the monitored metric and therefore a template.
  typedef ImageDifferenceSOMetricResult   ResultType;

  itkTypeMacro( ImageDifferenceSOMetricMonitor, SetupOptimizationMetricMonitorBase<ImageDifferenceSOMetricResult> );

  itkNewMacro( Self );

protected:

  ImageDifferenceSOMetricMonitor();

  virtual ~ImageDifferenceSOMetricMonitor();

  virtual void InsertEvaluationResults(const ResultType& results);

  virtual void CopyAdaptationResults(const ResultIndexType& index, ResultType& results) const;

  virtual void EnlistResultsToStatistic(const ResultType& results, StatisticEntry& entry);

  virtual void EnlistDictionaryEntries(StatisticDictionary& dictionary);

  //The folloing members are secured via m_ResultMutex and should therefore only acessed via
  //InsertEvaluationResults() and CopyAdaptationResults()
        std::vector<double> m_Errors;
        std::vector<double> m_Vars;
        std::vector<double> m_MinErrors;
        std::vector<double> m_MaxErrors;
        std::vector<double> m_ImageErrors;

  std::vector<unsigned long> m_Samplesize;
  std::vector<unsigned long> m_Durations;

private:
  ImageDifferenceSOMetricMonitor(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
};

} // end namespace FREE

#endif

---