cmtkValueSequence.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2010 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2152 $
//
//  $LastChangedDate: 2010-08-04 10:19:33 -0700 (Wed, 04 Aug 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkValueSequence_h_included_
#define __cmtkValueSequence_h_included_

#include <cmtkconfig.h>

#include <math.h>

namespace
cmtk
{


template<class T=float> 
class ValueSequence 
{
public:
  typedef ValueSequence<T> Self;

  ValueSequence() 
  { 
    this->Reset(); 
  }

  void Reset() 
  {
    NValues = 0; Sum = 0; SumAbs = 0; SumOfSquares = 0; 
    Minimum = Maximum = MinimumAbs = MaximumAbs = 0; 
  }
  
  void Proceed( const T v ) 
  {
    if ( ! NValues ) 
      {
      Minimum = Maximum = v;
      MinimumAbs = MaximumAbs = fabs( v );
      } 
    else
      {
      if ( v < Minimum ) Minimum = v;
      if ( v > Maximum ) Maximum = v;
      if ( fabs( v ) < MinimumAbs ) MinimumAbs = fabs( v );
      if ( fabs( v ) > MaximumAbs ) MaximumAbs = fabs( v );
      }
    ++NValues; Sum += v; SumAbs += fabs( v ); SumOfSquares += v*v; 
  }

  double GetMinimum() const { return Minimum; }

  double GetMaximum() const { return Maximum; }

  double GetMinimumAbs() const { return MinimumAbs; }

  double GetMaximumAbs() const { return MaximumAbs; }

  int GetNValues() const { return NValues; }

  double GetVariance( const bool unbiased = true ) const
  { 
    const double mu = this->GetAverage();
    return ( NValues * mu * mu - 2 * mu * Sum + SumOfSquares ) / ( unbiased ? (NValues-1) : NValues );
  }

  double GetSum() const { return static_cast<double>( Sum ); }

  double GetSumOfSquares() const { return static_cast<double>( SumOfSquares ); }

  double GetAverage() const { return static_cast<double>( Sum / NValues ); }

  double GetAverageAbs() const { return static_cast<double>( SumAbs / NValues ); }

  ValueSequence<T>& operator=( const ValueSequence<T>& other );

private:
  T Sum;

  T SumAbs;

  T SumOfSquares;

  int NValues;

  T Minimum;

  T Maximum;

  T MinimumAbs;

  T MaximumAbs;

  template<class TT>
  friend ValueSequence<TT> operator+( const ValueSequence<TT>& a, const ValueSequence<TT>& b );
};


} // namespace cmtk

#include "cmtkValueSequence.txx"

#endif // #ifndef __cmtkValueSequence_h_included_