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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile: itkSample.h,v $
Language: C++
Date: $Date: 2009-03-04 19:29:53 $
Version: $Revision: 1.27 $
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 __itkSample_h
#define __itkSample_h
#include <vector>
#include "itkMacro.h"
#include "itkPoint.h"
#include "itkSize.h"
#include "itkObject.h"
#include "itkFixedArray.h"
#include "itkMeasurementVectorTraits.h"
#include "itkNumericTraits.h"
namespace itk {
namespace Statistics {
/** \class Sample
* \brief A collection of measurements for statistical analysis
*
* Sample represents a set of measurements for statistical
* analysis. Sample is templated over a measurement vector. The
* measurement vector encapsulates the set of values associated with a
* single measurement. For instance, a measurement vector may contain
* an image intensity of a pixel and the gradient magnitude at that pixel.
*
* Data within a sample can be accessed via an
* InstanceIdentfier. InstanceIdentifiers have different forms and
* meanings depending on the type of sample. For ListSamples, the
* InstanceIdentifier is an index into the corresponding list. In this
* case, the InstanceIndentifier corresponds to a particular
* measurement stored in the Sample. For Histograms, an
* InstanceIdentifier corresponds to a particular bin in the
* N-dimensional histogram. In other words, the InstanceIdentifier in
* a histogram does not correspond to a specific measurement used to
* build the histogram but to the "bin" in which a number of original
* measurements were "accumulated".
*
* <b>Recent API changes:</b>
* The static const macro to get the length of a measurement vector,
* 'MeasurementVectorSize' has been removed to allow the length of a measurement
* vector to be specified at run time. Please use the function
* GetMeasurementVectorSize() instead.
*
*/
template < class TMeasurementVector >
class ITK_EXPORT Sample : public Object
{
public:
/** Standard class typedefs */
typedef Sample Self;
typedef Object Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Run-time type information (and related methods) */
itkTypeMacro(Sample, Object);
/** MeasurementVector typedef support */
typedef TMeasurementVector MeasurementVectorType;
/** ValueType of a measurement (ValueType of a component of the
* MeasurementVector */
typedef typename MeasurementVectorType::ValueType MeasurementType;
/** Frequency value type */
typedef float FrequencyType;
/** Total frequency type */
typedef NumericTraits<FrequencyType>::AccumulateType TotalFrequencyType;
/** InstanceIdentifier typedef. This identifier is a unique
* sequential id for each measurement vector in a Sample subclass. */
typedef unsigned long InstanceIdentifier;
/** Typedef for the length of each measurement vector */
typedef unsigned int MeasurementVectorSizeType;
/** Get the size of the sample (number of measurements) */
virtual unsigned int Size() const = 0;
/** Get the measurement associated with a particular
* InstanceIdentifier. */
virtual const MeasurementVectorType &
GetMeasurementVector(const InstanceIdentifier &id) const = 0;
/** Get the frequency of a measurement specified by instance
* identifier. */
virtual FrequencyType GetFrequency(const InstanceIdentifier &id) const = 0;
/** Get the total frequency of the sample. */
virtual TotalFrequencyType GetTotalFrequency() const
= 0;
/** Set/Get macros for the length of the measurement vector */
virtual void SetMeasurementVectorSize( const MeasurementVectorSizeType s )
{
MeasurementVectorType m;
MeasurementVectorSizeType defaultLength = MeasurementVectorTraits::GetLength( m );
if( (defaultLength != 0) && (s!=defaultLength) )
{
return; // Do not do anything.
//itkExceptionMacro( << "Cannot instantiate a sample with a fixed length "
// << "container and resize it later. Create it with itk::Array if you like.");
}
this->m_MeasurementVectorSize = s;
}
itkGetConstMacro( MeasurementVectorSize, MeasurementVectorSizeType );
protected:
Sample()
{
m_MeasurementVectorSize = MeasurementVectorTraits::GetLength(
MeasurementVectorType() );
}
virtual ~Sample() {}
void PrintSelf(std::ostream& os, Indent indent) const
{
Superclass::PrintSelf(os,indent);
os << indent << "Length of measurement vectors in the sample: " <<
m_MeasurementVectorSize << std::endl;
}
private:
Sample(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
MeasurementVectorSizeType m_MeasurementVectorSize;
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
#endif
|
