itkWeightedMeanCalculator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkWeightedMeanCalculator.h,v $
  Language:  C++
  Date:      $Date: 2009-03-04 19:29:55 $
  Version:   $Revision: 1.8 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/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 __itkWeightedMeanCalculator_h
#define __itkWeightedMeanCalculator_h

#include <vnl/vnl_vector.h>
#include <vnl/vnl_matrix.h>

#include "itkArray.h"
#include "itkFunctionBase.h"
#include "itkSampleAlgorithmBase.h"

namespace itk { 
namespace Statistics {
  
template< class TSample >
class WeightedMeanCalculator :
    public SampleAlgorithmBase< TSample >
{
public:
  typedef WeightedMeanCalculator         Self;
  typedef SampleAlgorithmBase< TSample > Superclass;
  typedef SmartPointer<Self>             Pointer;
  typedef SmartPointer<const Self>       ConstPointer;

  itkTypeMacro(WeightedMeanCalculator, SampleAlgorithmBase);
  itkNewMacro(Self);

  typedef typename Superclass::MeasurementVectorSizeType MeasurementVectorSizeType;

  typedef typename TSample::MeasurementVectorType MeasurementVectorType;

  typedef Array< double >           OutputType;

  typedef Array< double > WeightArrayType;

  void SetWeights(WeightArrayType* array);

  WeightArrayType* GetWeights();

  typedef FunctionBase< MeasurementVectorType, double > WeightFunctionType;

  void SetWeightFunction(WeightFunctionType* func);

  WeightFunctionType* GetWeightFunction();

  OutputType* GetOutput();

protected:
  WeightedMeanCalculator();
  virtual ~WeightedMeanCalculator() {}
  void PrintSelf(std::ostream& os, Indent indent) const;

  void GenerateData();

private:
  WeightArrayType*    m_Weights;
  WeightFunctionType* m_WeightFunction;
  OutputType          m_Output;
}; // end of class
    
} // end of namespace Statistics 
} // end of namespace itk 

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

#endif