otb::SamplerBase Class Reference

#include <otbSamplerBase.h>

Inheritance diagram for otb::SamplerBase:

Collaboration diagram for otb::SamplerBase:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef SamplerBase	Self
typedef itk::Object	Superclass

Public Member Functions
virtual unsigned long	GetChosenElements ()
virtual const char *	GetNameOfClass () const
virtual unsigned long	GetNeededElements ()
virtual unsigned long	GetProcessedElements ()
virtual double	GetRate ()
virtual unsigned long	GetTotalElements ()
virtual void	Reset (void)
void	SetNumberOfElements (unsigned long needed, unsigned long total)
void	SetRate (double rate, unsigned long total=0UL)

Protected Member Functions
	SamplerBase ()
	~SamplerBase () override

Protected Attributes
unsigned long	m_ChosenElements
unsigned long	m_ProcessedElements

Private Member Functions
void	operator= (const Self &)
	SamplerBase (const Self &)

Private Attributes
unsigned long	m_NeededElements
double	m_Rate
unsigned long	m_TotalElements

Detailed Description

This is a base class for sampling methods.

Definition at line 37 of file otbSamplerBase.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 43 of file otbSamplerBase.h.

Pointer

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

Definition at line 42 of file otbSamplerBase.h.

Self

typedef SamplerBase otb::SamplerBase::Self

Definition at line 40 of file otbSamplerBase.h.

Superclass

typedef itk::Object otb::SamplerBase::Superclass

Definition at line 41 of file otbSamplerBase.h.

Constructor & Destructor Documentation

SamplerBase() [1/2]

otb::SamplerBase::SamplerBase ( )

protected

Constructor

~SamplerBase()

otb::SamplerBase::~SamplerBase ( )

inlineoverrideprotected

Destructor

Definition at line 81 of file otbSamplerBase.h.

SamplerBase() [2/2]

otb::SamplerBase::SamplerBase ( const Self &  )

private

Member Function Documentation

GetChosenElements()

virtual unsigned long otb::SamplerBase::GetChosenElements ( )

virtual

Get macro for the current number of chosen elements

GetNameOfClass()

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

virtual

Runtime information support.

Reimplemented in otb::PatternSampler, otb::PeriodicSampler, and otb::RandomSampler.

GetNeededElements()

virtual unsigned long otb::SamplerBase::GetNeededElements ( )

virtual

Get macro for the number of needed elements

GetProcessedElements()

virtual unsigned long otb::SamplerBase::GetProcessedElements ( )

virtual

Get macro for the current number of processed elements

GetRate()

virtual double otb::SamplerBase::GetRate ( )

virtual

Get macro for sampling rate

GetTotalElements()

virtual unsigned long otb::SamplerBase::GetTotalElements ( )

virtual

Get macro for the total number of elements

operator=()

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

private

Reset()

virtual void otb::SamplerBase::Reset ( void  )

virtual

Reset internal counter (to be called before starting iteration)

Reimplemented in otb::PatternSampler, otb::PeriodicSampler, and otb::RandomSampler.

SetNumberOfElements()

void otb::SamplerBase::SetNumberOfElements	(	unsigned long	needed,
		unsigned long	total
	)

method to set the number of needed and total elements the sampling rate is automatically updated

SetRate()

void otb::SamplerBase::SetRate	(	double	rate,
		unsigned long	total = 0UL
	)

method to set the sampling rate, if the total number of elements is given, the number of needed elements is updated

Member Data Documentation

m_ChosenElements

unsigned long otb::SamplerBase::m_ChosenElements

protected

Current count of selected elements

Definition at line 86 of file otbSamplerBase.h.

m_NeededElements

unsigned long otb::SamplerBase::m_NeededElements

private

Number of elements to select during the iteration

Definition at line 100 of file otbSamplerBase.h.

m_ProcessedElements

unsigned long otb::SamplerBase::m_ProcessedElements

protected

Current count of encountered elements during iteration

Definition at line 89 of file otbSamplerBase.h.

m_Rate

double otb::SamplerBase::m_Rate

private

Sampling rate

Definition at line 103 of file otbSamplerBase.h.

m_TotalElements

unsigned long otb::SamplerBase::m_TotalElements

private

Total number of elements during the iteration

Definition at line 97 of file otbSamplerBase.h.

---

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

• otbSamplerBase.h