freSetupOptimizationMultiThreadMetric.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: freSetupOptimizationMultiThreadMetric.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 __freSetupOptimizationMultiThreadMetric_h
#define __freSetupOptimizationMultiThreadMetric_h

#include "freSetupOptimizationMetric.h"
#include "freIDPath.h"

#include "freImageTypes.h"

namespace FREE
{

template <typename TMonitor, typename TThread>
class ITK_EXPORT SetupOptimizationMultiThreadMetric : 
  public SetupOptimizationMetric
{
public:
  typedef SetupOptimizationMultiThreadMetric<TMonitor, TThread>   Self;
  typedef SetupOptimizationMetric           Superclass;
        typedef itk::SmartPointer<Self>           Pointer;
  typedef itk::SmartPointer<const Self>     ConstPointer;

  typedef TMonitor MonitorType;
  typedef typename MonitorType::Pointer MonitorPointer;
  typedef TThread  ThreadType;
  typedef typename ThreadType::Pointer ThreadPointer;
  typedef typename MonitorType::ResultType EvaluationResultType;

  itkTypeMacro( SetupOptimizationMultiThreadMetric, SetupOptimizationMetric );

  itkSetMacro( NumberOfThreads, long);
  itkGetMacro( NumberOfThreads, long);

protected:
  SetupOptimizationMultiThreadMetric();

  virtual ~SetupOptimizationMultiThreadMetric();

        virtual DecomposedMeasureType ComputeDecomposedValue( const ParametersType & parameters ) const;

        virtual void InitializeValueComputation() const = 0;
        virtual void InitializeMonitor(MonitorType& monitor) const = 0;
  virtual void InitializeThread(ThreadType& thread) const = 0;
  virtual DecomposedMeasureType ComputeMeasure(MonitorType& monitor) const = 0;

  long m_NumberOfThreads;

  typedef std::vector<ThreadPointer> ThreadListType;

  /* these events are used to pass the events from the monitor to the outside world*/
  typename ProgressEvent<Self>::Pointer fnOnMonitorEvaluationProgress;
  /* these events are used to pass the events from the monitor to the outside world*/
  typename ProgressEvent<Self>::Pointer fnOnMonitorEvaluationDone;
  /* these events are used to pass the events from the monitor to the outside world*/
  typename ProgressEvent<Self>::Pointer fnOnMonitorNextAdaptation;
  /* these events are used to pass the events from the monitor to the outside world*/
  typename ProgressEvent<Self>::Pointer fnOnMonitorEvaluationFailed;

  void OnMonitorEvaluationProgress(const long status, const std::string& sComment, void* pSender, long threadID);
  void OnMonitorEvaluationDone(const long status, const std::string& sComment, void* pSender, long threadID);
  void OnOnMonitorNextAdaptation(const long status, const std::string& sComment, void* pSender, long threadID);
  void OnOnMonitorEvaluationFailed(const long status, const std::string& sComment, void* pSender, long threadID);

  static ITK_THREAD_RETURN_TYPE ThreadExecution( void *arg );

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

} // end namespace FREE

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

#endif

---