otb::PeriodicSampler Class Reference

#include <otbPeriodicSampler.h>

Inheritance diagram for otb::PeriodicSampler:

Collaboration diagram for otb::PeriodicSampler:

Classes
struct	Parameter

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef struct otb::PeriodicSampler::Parameter	ParameterType
typedef itk::SmartPointer< Self >	Pointer
typedef PeriodicSampler	Self
typedef SamplerBase	Superclass
Public Types inherited from otb::SamplerBase
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef SamplerBase	Self
typedef itk::Object	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from otb::SamplerBase
virtual unsigned long	GetChosenElements ()
virtual unsigned long	GetNeededElements ()
virtual unsigned long	GetProcessedElements ()
virtual double	GetRate ()
virtual unsigned long	GetTotalElements ()
void	SetNumberOfElements (unsigned long needed, unsigned long total)
void	SetRate (double rate, unsigned long total=0UL)

Static Public Member Functions
static Pointer	New ()
ParameterType	m_Parameters
double	m_JitterSize
double	m_OffsetValue
std::vector< double >	m_JitterValues
void	SetParameters (const ParameterType &param)
ParameterType	GetParameters ()
void	Reset (void) override
bool	TakeSample (void)
	PeriodicSampler ()
	~PeriodicSampler () override
	PeriodicSampler (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Protected Member Functions inherited from otb::SamplerBase
	SamplerBase ()
	~SamplerBase () override
Protected Attributes inherited from otb::SamplerBase
unsigned long	m_ChosenElements
unsigned long	m_ProcessedElements

Detailed Description

Periodic sampler for iteration loops.

This class allows doing periodic sampling during an iteration loop.

Definition at line 38 of file otbPeriodicSampler.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> otb::PeriodicSampler::ConstPointer

Definition at line 44 of file otbPeriodicSampler.h.

ParameterType

typedef struct otb::PeriodicSampler::Parameter otb::PeriodicSampler::ParameterType

Internal parameters, only contains an offset to shift the periodic sampling

Pointer

typedef itk::SmartPointer<Self> otb::PeriodicSampler::Pointer

Definition at line 43 of file otbPeriodicSampler.h.

Self

typedef PeriodicSampler otb::PeriodicSampler::Self

Definition at line 41 of file otbPeriodicSampler.h.

Superclass

typedef SamplerBase otb::PeriodicSampler::Superclass

Definition at line 42 of file otbPeriodicSampler.h.

Constructor & Destructor Documentation

PeriodicSampler() [1/2]

otb::PeriodicSampler::PeriodicSampler ( )

protected

Constructor

~PeriodicSampler()

otb::PeriodicSampler::~PeriodicSampler ( )

inlineoverrideprotected

Destructor

Definition at line 104 of file otbPeriodicSampler.h.

PeriodicSampler() [2/2]

otb::PeriodicSampler::PeriodicSampler ( const Self &  )

private

Internal parameters for the sampler

Member Function Documentation

CreateAnother()

virtual::itk::LightObject::Pointer otb::PeriodicSampler::CreateAnother

(

void

)

const

GetNameOfClass()

virtual const char* otb::PeriodicSampler::GetNameOfClass ( ) const

virtual

Runtime information support.

Reimplemented from otb::SamplerBase.

GetParameters()

ParameterType otb::PeriodicSampler::GetParameters ( )

inline

Getter for internal parameters

Definition at line 83 of file otbPeriodicSampler.h.

New()

static Pointer otb::PeriodicSampler::New ( )

static

Method for creation through the object factory.

operator=()

void otb::PeriodicSampler::operator= ( const Self &  )

private

Internal parameters for the sampler

Reset()

void otb::PeriodicSampler::Reset ( void  )

overridevirtual

Method that resets the internal state of the sampler

Reimplemented from otb::SamplerBase.

SetParameters()

void otb::PeriodicSampler::SetParameters ( const ParameterType &  param )

inline

Setter for internal parameters

Definition at line 72 of file otbPeriodicSampler.h.

TakeSample()

bool otb::PeriodicSampler::TakeSample

(

void

)

Method to call during iteration, returns true if the sample is selected, and false otherwise.

Member Data Documentation

m_JitterSize

double otb::PeriodicSampler::m_JitterSize

private

Internal width for jitter

Definition at line 117 of file otbPeriodicSampler.h.

m_JitterValues

std::vector<double> otb::PeriodicSampler::m_JitterValues

private

jitter offsets computed up to MaxBufferSize

Definition at line 124 of file otbPeriodicSampler.h.

m_OffsetValue

double otb::PeriodicSampler::m_OffsetValue

private

Internal current offset value (either fixed, or reset each time a sample is taken)

Definition at line 121 of file otbPeriodicSampler.h.

m_Parameters

ParameterType otb::PeriodicSampler::m_Parameters

private

Internal parameters for the sampler

Definition at line 114 of file otbPeriodicSampler.h.

---

The documentation for this class was generated from the following file:

• otbPeriodicSampler.h