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
|
/*
* Copyright (C) 2005-2020 Centre National d'Etudes Spatiales (CNES)
*
* This file is part of Orfeo Toolbox
*
* https://www.orfeo-toolbox.org/
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 otbPeriodicSampler_h
#define otbPeriodicSampler_h
#include "otbSamplerBase.h"
namespace otb
{
/**
* \class PeriodicSampler
*
* \brief Periodic sampler for iteration loops
*
* This class allows doing periodic sampling during an iteration loop.
*
* \ingroup OTBStatistics
*/
class ITK_EXPORT PeriodicSampler : public SamplerBase
{
public:
typedef PeriodicSampler Self;
typedef SamplerBase Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** Internal parameters, only contains an offset to shift the periodic
* sampling
*/
typedef struct Parameter
{
/** Offset that shifts the whole periodic sampling
* (disabled if jitter is used) */
unsigned long Offset;
/** Maximum jitter to introduce (0 means no jitter) */
unsigned long MaxJitter;
/** Maximum buffer size for internal jitter values */
unsigned long MaxBufferSize;
bool operator!=(const struct Parameter& param) const;
} ParameterType;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Runtime information support. */
itkTypeMacro(PeriodicSampler, SamplerBase);
/** Setter for internal parameters */
void SetParameters(const ParameterType& param)
{
if (m_Parameters != param)
{
this->Modified();
m_Parameters = param;
}
}
/** Getter for internal parameters */
ParameterType GetParameters()
{
return m_Parameters;
}
/**
* Method that resets the internal state of the sampler
*/
void Reset(void) override;
/**
* Method to call during iteration, returns true if the sample is selected,
* and false otherwise.
*/
bool TakeSample(void);
protected:
/** Constructor */
PeriodicSampler();
/** Destructor */
~PeriodicSampler() override
{
}
private:
// Not implemented
PeriodicSampler(const Self&);
void operator=(const Self&);
/** Internal parameters for the sampler */
ParameterType m_Parameters;
/** Internal width for jitter */
double m_JitterSize;
/** Internal current offset value
* (either fixed, or reset each time a sample is taken)*/
double m_OffsetValue;
/** jitter offsets computed up to MaxBufferSize */
std::vector<double> m_JitterValues;
};
} // namespace otb
#endif
|
