cmtkHistogramBase.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 __cmtkHistogramBase_h_included_
#define __cmtkHistogramBase_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkTypes.h>
#include <Base/cmtkMathUtil.h>

#include <System/cmtkSmartPtr.h>

#include <algorithm>

#ifndef CMTK_HISTOGRAM_AUTOBINS

#define CMTK_HISTOGRAM_AUTOBINS 0
#endif

#define CMTK_HISTOGRAM_FRACTIONAL true

#define CMTK_HISTOGRAM_DISCRETE false

#define CMTK_HISTOGRAM_RESET true

#define CMTK_HISTOGRAM_NORESET false

#define CMTK_HISTOGRAM_COPY true

#define CMTK_HISTOGRAM_NOCOPY false

namespace
cmtk
{


class HistogramBase
{
protected:
  Types::DataItem m_BinWidth;

  Types::DataItem m_BinsLowerBound;

  Types::DataItem m_BinsUpperBound;

public:
  typedef HistogramBase Self;
  
  HistogramBase()
  {
    this->m_BinWidth = 1.0;
    this->m_BinsLowerBound = this->m_BinsUpperBound = 0.0;
  }

  virtual ~HistogramBase() {}

  virtual size_t GetNumBins() const = 0;

  void SetRange ( const Types::DataItemRange& range ) 
  {
    this->m_BinsLowerBound = range.m_LowerBound;
    this->m_BinsUpperBound = range.m_UpperBound;
    this->m_BinWidth = range.Width() / (this->GetNumBins() - 1);
  }
  
  void SetRangeCentered( const Types::DataItemRange& range ) 
  {
    this->m_BinWidth = range.Width() / (this->GetNumBins() - 1);
    this->m_BinsLowerBound = static_cast<Types::DataItem>( range.m_LowerBound - 0.5 * this->m_BinWidth );
    this->m_BinsUpperBound = static_cast<Types::DataItem>( range.m_UpperBound + 0.5 * this->m_BinWidth );
  }

  const Types::DataItemRange GetRange() const 
  {
    return Types::DataItemRange( this->m_BinsLowerBound, this->m_BinsUpperBound );
  }

  virtual const Types::DataItemRange GetRangeBin( const size_t bin ) const 
  {
    const Types::DataItem from = this->m_BinsLowerBound + this->m_BinWidth * bin;
    return Types::DataItemRange( from, from + this->m_BinWidth );
  }

  Types::DataItem GetBinWidth() const
  {
    return this->m_BinWidth;
  }
  
  virtual size_t ValueToBin ( const Types::DataItem value ) const 
  {
    const size_t binIndex = static_cast<size_t>( (value - this->m_BinsLowerBound) / this->m_BinWidth );
    return std::max<size_t>( 0, std::min( this->GetNumBins()-1, binIndex ) );
  }
  
  virtual Types::DataItem ValueToBinFractional ( const Types::DataItem value ) const 
  {
    const Types::DataItem binIndex = (value - this->m_BinsLowerBound) / this->m_BinWidth;
    return std::max<Types::DataItem>( 0, std::min<Types::DataItem>( static_cast<Types::DataItem>( this->GetNumBins()-1 ), binIndex));
  }
  
  virtual Types::DataItem BinToValue ( const size_t bin ) const 
  {
    return static_cast<Types::DataItem>( this->m_BinsLowerBound + (bin+0.5) * this->m_BinWidth );
  }
};


} // namespace cmtk

#endif // #ifndef __cmtkHistogramBase_h_included_