OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::SamplingRateCalculatorList Class Reference

#include <otbSamplingRateCalculatorList.h>

+ Inheritance diagram for otb::SamplingRateCalculatorList:
+ Collaboration diagram for otb::SamplingRateCalculatorList:

Public Types

typedef
SamplingRateCalculator::ClassCountMapType 
ClassCountMapType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
SamplingRateCalculator::MapRateType 
MapRateType
 
enum  PartitionType {
  PROPORTIONAL,
  EQUAL,
  CUSTOM
}
 
typedef itk::SmartPointer< SelfPointer
 
typedef SamplingRateCalculatorList Self
 
typedef ObjectList
< SamplingRateCalculator
Superclass
 
- Public Types inherited from otb::ObjectList< SamplingRateCalculator >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
InternalContainerType::size_type 
InternalContainerSizeType
 
typedef std::vector
< ObjectPointerType
InternalContainerType
 
typedef itk::SmartPointer
< ObjectType
ObjectPointerType
 
typedef SamplingRateCalculator ObjectType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ObjectList Self
 
typedef itk::DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef 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

void ClearRates (void)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
const MapRateTypeGetRatesByClass (unsigned int index)
 
void SetAllSamples (PartitionType t)
 
void SetMinimumNbOfSamplesByClass (PartitionType t)
 
void SetNbOfSamplesAllClasses (std::vector< unsigned long > &nb, PartitionType t)
 
void SetNbOfSamplesByClass (const std::vector< ClassCountMapType > &required, PartitionType t)
 
void SetNthClassCount (unsigned int index, const ClassCountMapType &map)
 
void SetPercentageOfSamples (std::vector< double > &p, PartitionType t)
 
void SetTotalNumberOfSamples (std::vector< unsigned long > &tot, PartitionType t)
 
- Public Member Functions inherited from otb::ObjectList< SamplingRateCalculator >
ObjectPointerType Back (void)
 
Iterator Begin (void)
 
ConstIterator Begin (void) const
 
InternalContainerSizeType Capacity (void) const
 
void Clear (void)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
Iterator End (void)
 
ConstIterator End (void) const
 
void Erase (unsigned int index)
 
void Erase (Iterator begin, Iterator end)
 
void Erase (Iterator loc)
 
ObjectPointerType Front (void)
 
SuperclassGetNthDataObject (unsigned int index) const override
 
ObjectPointerType GetNthElement (unsigned int index) const
 
Iterator Insert (Iterator position, ObjectPointerType element)
 
ReverseIterator Insert (ReverseIterator position, ObjectPointerType element)
 
void PopBack (void)
 
void PushBack (ObjectType *element)
 
void Reserve (InternalContainerSizeType size)
 
void Resize (InternalContainerSizeType size)
 
ReverseIterator ReverseBegin (void)
 
ReverseConstIterator ReverseBegin (void) const
 
ReverseIterator ReverseEnd (void)
 
ReverseConstIterator ReverseEnd (void) const
 
void SetNthElement (unsigned int index, ObjectPointerType element)
 
void SetNthElement (unsigned int index, const ObjectType *element)
 
InternalContainerSizeType Size (void) const override
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ObjectList< SamplingRateCalculator >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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 ()
 

Protected Member Functions

 SamplingRateCalculatorList ()
 
 ~SamplingRateCalculatorList () override
 
- Protected Member Functions inherited from otb::ObjectList< SamplingRateCalculator >
 ObjectList ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~ObjectList () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 Member Functions inherited from otb::DataObjectListInterface
 DataObjectListInterface ()=default
 
virtual ~DataObjectListInterface ()=default
 

Private Member Functions

void operator= (const Self &)=delete
 
 SamplingRateCalculatorList (const Self &)=delete
 
void UpdateGlobalCounts ()
 

Private Attributes

ClassCountMapType m_GlobalCountMap
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

This class is a list of sampling rate calculators.

It computes sampling rates for each image and each class, given input statistics on available samples, and a sampling strategy. The sampling strategies are made from the combination of :

Definition at line 41 of file otbSamplingRateCalculatorList.h.

Member Typedef Documentation

Definition at line 51 of file otbSamplingRateCalculatorList.h.

Definition at line 49 of file otbSamplingRateCalculatorList.h.

Definition at line 52 of file otbSamplingRateCalculatorList.h.

Definition at line 48 of file otbSamplingRateCalculatorList.h.

Standard typedefs

Definition at line 46 of file otbSamplingRateCalculatorList.h.

Definition at line 47 of file otbSamplingRateCalculatorList.h.

Member Enumeration Documentation

Enumerator
PROPORTIONAL 
EQUAL 
CUSTOM 

Definition at line 54 of file otbSamplingRateCalculatorList.h.

Constructor & Destructor Documentation

otb::SamplingRateCalculatorList::SamplingRateCalculatorList ( )
inlineprotected

Constructor

Definition at line 99 of file otbSamplingRateCalculatorList.h.

otb::SamplingRateCalculatorList::~SamplingRateCalculatorList ( )
inlineoverrideprotected

Destructor

Definition at line 102 of file otbSamplingRateCalculatorList.h.

otb::SamplingRateCalculatorList::SamplingRateCalculatorList ( const Self )
privatedelete

Member Function Documentation

void otb::SamplingRateCalculatorList::ClearRates ( void  )

Clear internal data

virtual::itk::LightObject::Pointer otb::SamplingRateCalculatorList::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

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

Creation through object factory macro

Reimplemented from otb::ObjectList< SamplingRateCalculator >.

const MapRateType& otb::SamplingRateCalculatorList::GetRatesByClass ( unsigned int  index)

Get the sampling rates computed for input 'index'

static Pointer otb::SamplingRateCalculatorList::New ( )
static

Type macro

void otb::SamplingRateCalculatorList::operator= ( const Self )
privatedelete
void otb::SamplingRateCalculatorList::SetAllSamples ( PartitionType  t)

Method to select all available samples

void otb::SamplingRateCalculatorList::SetMinimumNbOfSamplesByClass ( PartitionType  t)

Method to choose a sampling strategy based on the smallest class. The number of samples in each class is set to this minimum size

void otb::SamplingRateCalculatorList::SetNbOfSamplesAllClasses ( std::vector< unsigned long > &  nb,
PartitionType  t 
)

Method to set the same number of required samples in each class

void otb::SamplingRateCalculatorList::SetNbOfSamplesByClass ( const std::vector< ClassCountMapType > &  required,
PartitionType  t 
)

Method to manually set the number of samples required in each class

void otb::SamplingRateCalculatorList::SetNthClassCount ( unsigned int  index,
const ClassCountMapType map 
)

Set the class counts for input 'index'

void otb::SamplingRateCalculatorList::SetPercentageOfSamples ( std::vector< double > &  p,
PartitionType  t 
)

Method to use a percentage of the samples available in each class

void otb::SamplingRateCalculatorList::SetTotalNumberOfSamples ( std::vector< unsigned long > &  tot,
PartitionType  t 
)

Method to set the total number of samples and use classes proportions

void otb::SamplingRateCalculatorList::UpdateGlobalCounts ( )
private

Member Data Documentation

ClassCountMapType otb::SamplingRateCalculatorList::m_GlobalCountMap
private

Definition at line 110 of file otbSamplingRateCalculatorList.h.


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