itkSparseFrequencyContainer2.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSparseFrequencyContainer2.h,v $
  Language:  C++
  Date:      $Date: 2009-05-02 05:43:58 $
  Version:   $Revision: 1.1 $

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

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

namespace itk { 
namespace Statistics {

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

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

  typedef MeasurementVectorTraits::InstanceIdentifier InstanceIdentifier;

  typedef MeasurementVectorTraits::AbsoluteFrequencyType  AbsoluteFrequencyType;

  typedef MeasurementVectorTraits::TotalAbsoluteFrequencyType  TotalAbsoluteFrequencyType;

  typedef MeasurementVectorTraits::RelativeFrequencyType       RelativeFrequencyType;

  typedef MeasurementVectorTraits::TotalRelativeFrequencyType  TotalRelativeFrequencyType;

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

  void Initialize(unsigned long length);

  void SetToZero();

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

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

  AbsoluteFrequencyType GetFrequency(const InstanceIdentifier id) const;

  TotalAbsoluteFrequencyType GetTotalFrequency()
    { 
    return m_TotalFrequency;
    }

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

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

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

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

#endif