cmtkHistogram.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 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: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkHistogram_h_included_
#define __cmtkHistogram_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkHistogramBase.h>

#include <System/cmtkSmartPtr.h>
#include <System/cmtkMemory.h>

#include <vector>
#include <algorithm>
#include <cassert>

namespace
cmtk
{


template<class T>
class Histogram : 
  public HistogramBase 
{
public:
  typedef Histogram<T> Self;

  typedef HistogramBase Superclass;

  typedef SmartPointer<Self> SmartPtr;

  typedef T BinType;

  Histogram ( const size_t numBins = 0 ) : m_Bins( numBins ) {}

  virtual ~Histogram () {}

  virtual void Resize( const size_t numberOfBins, const bool reset = true )
  {
    this->m_Bins.resize( numberOfBins );

    if ( reset ) 
      this->Reset();
  }

  typename Self::SmartPtr Clone () const
  {
    return typename Self::SmartPtr( this->CloneVirtual() );
  }

  virtual size_t GetNumBins() const
  {
    return this->m_Bins.size();
  }

  void Reset ()
  {
    std::fill( this->m_Bins.begin(), this->m_Bins.end(), 0 );
  }

  const T operator[] ( const size_t index ) const 
  {
    assert( index < this->GetNumBins() );
    return this->m_Bins[index];
  }

  T& operator[] ( const size_t index ) 
  {
    assert( index < this->GetNumBins() );
    return this->m_Bins[index];
  }
  
  T SampleCount () const 
  {
    T sampleCount = 0;
    
    for ( size_t i=0; i<this->m_Bins.size(); ++i )
      sampleCount += this->m_Bins[i];
    
    return sampleCount;
  }

  size_t GetMaximumBinIndex () const;

  T GetMaximumBinValue () const 
  {
    return this->m_Bins[ this->GetMaximumBinIndex() ];
  }

  double GetEntropy() const;

  double GetKullbackLeiblerDivergence( const Self& other ) const;
  
  void Increment ( const size_t sample ) 
  {
    ++this->m_Bins[sample];
  }

  void AddWeightedSymmetricKernel( const size_t bin , const size_t kernelRadius , const T* kernel /* Pointer to kernel values */, const T factor = 1  );
  
  void AddWeightedSymmetricKernelFractional( const double bin , const size_t kernelRadius , const T* kernel /* Pointer to kernel values */, const T factor = 1  );

  void IncrementFractional ( const double bin ) 
  {
    const T relative = static_cast<T>( bin - floor(bin) );
    this->m_Bins[static_cast<size_t>(bin)] += (1 - relative);
    if ( bin<(this->GetNumBins()-1) )
      this->m_Bins[static_cast<size_t>(bin+1)] += relative;
  }
  
  void Increment ( const size_t sample, const double weight ) 
  {
    this->m_Bins[sample] += static_cast<T>( weight );
  }

  void Decrement ( const size_t sample ) 
  {
    assert( this->m_Bins[sample] >= 1 );
    --this->m_Bins[sample];
  }

  void DecrementFractional ( const double bin ) 
  {
    T relative = static_cast<T>( bin - floor(bin) );
    this->m_Bins[static_cast<size_t>(bin)] -= (1 - relative);
    if ( bin<(this->GetNumBins()-1) )
      this->m_Bins[static_cast<size_t>(bin+1)] -= relative;
  }

  void Decrement ( const size_t sample, const double weight ) 
  {
    assert( this->m_Bins[sample] >= weight );
    this->m_Bins[sample] -= static_cast<T>( weight );
  }

  void AddHistogram ( const Self& other );

  void RemoveHistogram ( const Self& other );


  void ConvertToCumulative()
  {
    for ( size_t idx = 1; idx < this->GetNumBins(); ++idx )
      {
      this->m_Bins[idx] += this->m_Bins[idx-1];
      }
  }
  void Normalize( const T normalizeTo = 1 );

  void NormalizeMaximum( const T normalizeTo = 1 );

  Types::DataItem GetPercentile( const Types::DataItem percentile  ) const;

protected:
  virtual Self* CloneVirtual() const
  {
    return new Self( *this );
  }

private:
  std::vector<T> m_Bins;
};


} // namespace cmtk

#include "cmtkHistogram.txx"

#endif // #ifndef __cmtkHistogram_h_included_