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
|
/*=========================================================================
Program: ORFEO Toolbox
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
See OTBCopyright.txt 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 otbSamplerBase_h
#define otbSamplerBase_h
#include "itkObject.h"
#include "itkObjectFactory.h"
namespace otb
{
/**
* \class SamplerBase
*
* \brief This is a base class for sampling methods
*
* \ingroup OTBStatistics
*/
class ITK_EXPORT SamplerBase : public itk::Object
{
public:
typedef SamplerBase Self;
typedef itk::Object Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** Runtime information support. */
itkTypeMacro(SamplerBase, itk::Object);
/**
* Reset internal counter (to be called before starting iteration)
*/
virtual void Reset(void);
/** method to set the number of needed and total elements
* the sampling rate is automatically updated */
void SetNumberOfElements(unsigned long needed, unsigned long total);
/** method to set the sampling rate, if the total number of elements
* is given, the number of needed elements is updated */
void SetRate(double rate, unsigned long total=0UL);
/** Get macro for sampling rate */
itkGetMacro(Rate,double);
/** Get macro for the total number of elements */
itkGetMacro(TotalElements,unsigned long);
/** Get macro for the number of needed elements */
itkGetMacro(NeededElements,unsigned long);
/** Get macro for the current number of chosen elements */
itkGetMacro(ChosenElements, unsigned long);
/** Get macro for the current number of processed elements */
itkGetMacro(ProcessedElements,unsigned long);
protected:
/** Constructor */
SamplerBase();
/** Destructor */
~SamplerBase() ITK_OVERRIDE {}
/** Current count of selected elements */
unsigned long m_ChosenElements;
/** Current count of encountered elements during iteration */
unsigned long m_ProcessedElements;
private:
// Not implemented
SamplerBase(const Self&);
void operator=(const Self&);
/** Total number of elements during the iteration */
unsigned long m_TotalElements;
/** Number of elements to select during the iteration */
unsigned long m_NeededElements;
/** Sampling rate */
double m_Rate;
};
} // namespace otb
#endif
|
