1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*=========================================================================
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 SparseFrequencyContainer
* \brief his class is a container for an histogram.
*
* This class uses an map to store histogram. If your histogram is dense
* use DenseHistogram. You should access each bin by
* (InstanceIdentifier)index or measurement vector.
*/
class ITK_EXPORT SparseFrequencyContainer : public Object
{
public:
/** Standard class typedefs. */
typedef SparseFrequencyContainer Self;
typedef Object Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Standard macros */
itkTypeMacro(SparseFrequencyContainer, Object);
itkNewMacro(Self);
/** instance idenfitifer alias */
typedef unsigned long InstanceIdentifier;
/** frequency type alias */
typedef float FrequencyType;
/** Total frequency type */
typedef NumericTraits<FrequencyType>::AccumulateType TotalFrequencyType;
/** Histogram typedef support */
typedef std::map< InstanceIdentifier, FrequencyType > FrequencyContainerType;
typedef FrequencyContainerType::const_iterator
FrequencyContainerConstIterator;
/** prepares the frequency container */
void Initialize(unsigned long length);
/** Calls the SetToZero method of superclass to initialize all the bins to Zero.
* This should be done before starting to call the IncreaseFrequency method. */
void SetToZero();
/** Method to set the frequency of histogram using instance identifier. It
* returns false when the Id is out of bounds */
bool SetFrequency(const InstanceIdentifier id, const FrequencyType value);
/** Method to increase the frequency by one. This function is convinent
* to create a histogram. It returns false when the id is out of bounds. */
bool IncreaseFrequency(const InstanceIdentifier id,
const FrequencyType value);
/** Method to get the frequency of a bin from the histogram. It will return
* zero when the Id is out of bounds. */
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
|
