OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
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< SelfPointer
 
typedef SamplerBase Self
 
typedef itk::Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 SamplerBase ()
 
 ~SamplerBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

unsigned long m_ChosenElements
 
unsigned long m_ProcessedElements
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

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

Private Attributes

unsigned long m_NeededElements
 
double m_Rate
 
unsigned long m_TotalElements
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Detailed Description

This is a base class for sampling methods.

Definition at line 37 of file otbSamplerBase.h.

Member Typedef Documentation

Definition at line 43 of file otbSamplerBase.h.

Definition at line 42 of file otbSamplerBase.h.

Definition at line 40 of file otbSamplerBase.h.

Definition at line 41 of file otbSamplerBase.h.

Constructor & Destructor Documentation

otb::SamplerBase::SamplerBase ( )
protected

Constructor

otb::SamplerBase::~SamplerBase ( )
inlineoverrideprotected

Destructor

Definition at line 81 of file otbSamplerBase.h.

otb::SamplerBase::SamplerBase ( const Self )
private

Member Function Documentation

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

Get macro for the current number of chosen elements

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

Runtime information support.

Reimplemented from itk::Object.

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

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

Get macro for the number of needed elements

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

Get macro for the current number of processed elements

virtual double otb::SamplerBase::GetRate ( )
virtual

Get macro for sampling rate

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

Get macro for the total number of elements

void otb::SamplerBase::operator= ( const Self )
private
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.

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

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

unsigned long otb::SamplerBase::m_ChosenElements
protected

Current count of selected elements

Definition at line 84 of file otbSamplerBase.h.

unsigned long otb::SamplerBase::m_NeededElements
private

Number of elements to select during the iteration

Definition at line 98 of file otbSamplerBase.h.

unsigned long otb::SamplerBase::m_ProcessedElements
protected

Current count of encountered elements during iteration

Definition at line 87 of file otbSamplerBase.h.

double otb::SamplerBase::m_Rate
private

Sampling rate

Definition at line 101 of file otbSamplerBase.h.

unsigned long otb::SamplerBase::m_TotalElements
private

Total number of elements during the iteration

Definition at line 95 of file otbSamplerBase.h.


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