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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkSparseFrequencyContainer2_h
#define itkSparseFrequencyContainer2_h
#include <map>
#include "itkObjectFactory.h"
#include "itkObject.h"
#include "itkNumericTraits.h"
#include "itkMeasurementVectorTraits.h"
#include "ITKStatisticsExport.h"
namespace itk
{
namespace Statistics
{
/**
* \class SparseFrequencyContainer2
* \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.
* \ingroup ITKStatistics
*/
class ITKStatistics_EXPORT SparseFrequencyContainer2 : public Object
{
public:
ITK_DISALLOW_COPY_AND_MOVE(SparseFrequencyContainer2);
/** Standard class type aliases. */
using Self = SparseFrequencyContainer2;
using Superclass = Object;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(SparseFrequencyContainer2);
itkNewMacro(Self);
/** instance identifier alias */
using InstanceIdentifier = MeasurementVectorTraits::InstanceIdentifier;
/** Absolute frequency type alias */
using AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType;
/** Absolute Total frequency type */
using TotalAbsoluteFrequencyType = MeasurementVectorTraits::TotalAbsoluteFrequencyType;
/** Relative frequency type alias */
using RelativeFrequencyType = MeasurementVectorTraits::RelativeFrequencyType;
/** Relative Relative frequency type */
using TotalRelativeFrequencyType = MeasurementVectorTraits::TotalRelativeFrequencyType;
/** Histogram type alias support */
using FrequencyContainerType = std::map<InstanceIdentifier, AbsoluteFrequencyType>;
using FrequencyContainerConstIterator = FrequencyContainerType::const_iterator;
/** prepares the frequency container */
void
Initialize(SizeValueType 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 AbsoluteFrequencyType value);
/** Method to increase the frequency by one. This function is convenient
* to create a histogram. It returns false when the id is out of bounds. */
bool
IncreaseFrequency(const InstanceIdentifier id, const AbsoluteFrequencyType value);
/** Method to get the frequency of a bin from the histogram. It will return
* zero when the Id is out of bounds. */
AbsoluteFrequencyType
GetFrequency(const InstanceIdentifier id) const;
TotalAbsoluteFrequencyType
GetTotalFrequency() const
{
return m_TotalFrequency;
}
protected:
SparseFrequencyContainer2();
~SparseFrequencyContainer2() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
// Container of histogram
FrequencyContainerType m_FrequencyContainer{};
TotalAbsoluteFrequencyType m_TotalFrequency{};
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
#endif
|
