cmtkLogHistogram.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: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkLogHistogram_h_included_
#define __cmtkLogHistogram_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkHistogram.h>
#include <System/cmtkSmartPtr.h>
#include <math.h>

namespace
cmtk
{


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

  typedef SmartPointer<Self> SmartPtr;

  typedef Histogram<T> Superclass;

  LogHistogram ( const size_t numBins = 0 ) : Superclass( numBins ), m_LogNumBins( log( static_cast<double>( numBins ) ) ) {}

  virtual ~LogHistogram() {}

  virtual void Resize( const size_t numberOfBins, const bool reset = true )
  {
    this->Superclass::Resize( numberOfBins, reset );
    this->m_LogNumBins = log( static_cast<double>( numberOfBins ) );
  }

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

  virtual size_t ValueToBin ( const Types::DataItem value ) const 
  {
    return static_cast<size_t>( this->ValueToBinFractional( value ) );
  }

  virtual Types::DataItem ValueToBinFractional ( const Types::DataItem value ) const 
  {
    const Types::DataItem binIndex = this->Superclass::ValueToBinFractional( value );
    return (this->GetNumBins()-1) * std::max<Types::DataItem>( 0.0, std::min<Types::DataItem>( 1.0, log( 1+binIndex ) / this->m_LogNumBins ) );
  }
  
  virtual const Types::DataItemRange GetRangeBin( const size_t bin ) const 
  {
    return Types::DataItemRange( this->BinToValue( bin ), this->BinToValue( bin+1 ) );
  }
  
  virtual Types::DataItem BinToValue ( const size_t bin ) const 
  {
    return this->Superclass::BinToValue( static_cast<size_t>( exp( static_cast<Types::DataItem>( bin ) / (this->GetNumBins()-1) * this->m_LogNumBins ) - 1 ) );
  }

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

private:
  double m_LogNumBins;
};


} // namespace cmtk

#endif // #ifndef __cmtkLogHistogram_h_included_