itkSparseFrequencyContainer.h

Go to the documentation of this file.

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

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

  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 __itkSparseFrequencyContainer_h
#define __itkSparseFrequencyContainer_h

#include <map>
#include "itkObjectFactory.h"
#include "itkObject.h"
#include "itkNumericTraits.h"

namespace itk { 
namespace Statistics {

class ITK_EXPORT SparseFrequencyContainer : public Object
{
public:
  typedef SparseFrequencyContainer  Self;
  typedef Object                    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkTypeMacro(SparseFrequencyContainer, Object);
  itkNewMacro(Self);

  typedef unsigned long InstanceIdentifier;

  typedef float FrequencyType;

  typedef NumericTraits<FrequencyType>::AccumulateType TotalFrequencyType;

  typedef std::map< InstanceIdentifier, FrequencyType > FrequencyContainerType;  
  typedef FrequencyContainerType::const_iterator 
          FrequencyContainerConstIterator;   

  void Initialize(unsigned long length);

  void SetToZero();

  bool SetFrequency(const InstanceIdentifier id, const FrequencyType value);

  bool IncreaseFrequency(const InstanceIdentifier id, 
                         const FrequencyType value);

  FrequencyType GetFrequency(const InstanceIdentifier id) const;

  TotalFrequencyType GetTotalFrequency()
    { return m_TotalFrequency; }

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

private:
  SparseFrequencyContainer(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  // Container of histogram
  FrequencyContainerType m_FrequencyContainer;
  TotalFrequencyType     m_TotalFrequency;
}; // end of class

} // end of namespace Statistics
} // end of namespace itk

#endif