OTB  9.0.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 SelfConstPointer
 
typedef SamplingRateCalculator::MapRateType MapRateType
 
enum  PartitionType {
  PROPORTIONAL,
  EQUAL,
  CUSTOM
}
 
typedef itk::SmartPointer< SelfPointer
 
typedef SamplingRateCalculatorList Self
 
typedef ObjectList< SamplingRateCalculatorSuperclass
 
- Public Types inherited from otb::ObjectList< SamplingRateCalculator >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef InternalContainerType::size_type InternalContainerSizeType
 
typedef std::vector< ObjectPointerTypeInternalContainerType
 
typedef itk::SmartPointer< ObjectTypeObjectPointerType
 
typedef SamplingRateCalculator ObjectType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ObjectList Self
 
typedef itk::DataObject Superclass
 

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 >
InternalContainerSizeType Capacity (void) const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void Reserve (InternalContainerSizeType size)
 
void Resize (InternalContainerSizeType size)
 
InternalContainerSizeType Size (void) const override
 
void PushBack (ObjectType *element)
 
void PopBack (void)
 
void SetNthElement (unsigned int index, ObjectPointerType element)
 
void SetNthElement (unsigned int index, const ObjectType *element)
 
ObjectPointerType GetNthElement (unsigned int index) const
 
SuperclassGetNthDataObject (unsigned int index) const override
 
ObjectPointerType Front (void)
 
ObjectPointerType Back (void)
 
void Erase (unsigned int index)
 
void Erase (Iterator begin, Iterator end)
 
void Erase (Iterator loc)
 
void Clear (void)
 
Iterator Insert (Iterator position, ObjectPointerType element)
 
ReverseIterator Insert (ReverseIterator position, ObjectPointerType element)
 
Iterator Begin (void)
 
ConstIterator Begin (void) const
 
ReverseIterator ReverseBegin (void)
 
ReverseConstIterator ReverseBegin (void) const
 
Iterator End (void)
 
ConstIterator End (void) const
 
ReverseIterator ReverseEnd (void)
 
ReverseConstIterator ReverseEnd (void) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ObjectList< SamplingRateCalculator >
static Pointer New ()
 

Protected Member Functions

 SamplingRateCalculatorList ()
 
 ~SamplingRateCalculatorList () override
 
- Protected Member Functions inherited from otb::ObjectList< SamplingRateCalculator >
 ObjectList ()
 
 ~ObjectList () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- 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
 

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

◆ ClassCountMapType

Definition at line 50 of file otbSamplingRateCalculatorList.h.

◆ ConstPointer

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

Definition at line 48 of file otbSamplingRateCalculatorList.h.

◆ MapRateType

Definition at line 51 of file otbSamplingRateCalculatorList.h.

◆ Pointer

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

Definition at line 47 of file otbSamplingRateCalculatorList.h.

◆ Self

Standard typedefs

Definition at line 45 of file otbSamplingRateCalculatorList.h.

◆ Superclass

Definition at line 46 of file otbSamplingRateCalculatorList.h.

Member Enumeration Documentation

◆ PartitionType

Enumerator
PROPORTIONAL 
EQUAL 
CUSTOM 

Definition at line 53 of file otbSamplingRateCalculatorList.h.

Constructor & Destructor Documentation

◆ SamplingRateCalculatorList() [1/2]

otb::SamplingRateCalculatorList::SamplingRateCalculatorList ( )
inlineprotected

Constructor

Definition at line 98 of file otbSamplingRateCalculatorList.h.

◆ ~SamplingRateCalculatorList()

otb::SamplingRateCalculatorList::~SamplingRateCalculatorList ( )
inlineoverrideprotected

Destructor

Definition at line 103 of file otbSamplingRateCalculatorList.h.

◆ SamplingRateCalculatorList() [2/2]

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

Member Function Documentation

◆ ClearRates()

void otb::SamplingRateCalculatorList::ClearRates ( void  )

Clear internal data

◆ CreateAnother()

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

◆ GetNameOfClass()

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

Creation through object factory macro

◆ GetRatesByClass()

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

Get the sampling rates computed for input 'index'

◆ New()

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

Type macro

◆ operator=()

void otb::SamplingRateCalculatorList::operator= ( const Self )
privatedelete

◆ SetAllSamples()

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

Method to select all available samples

◆ SetMinimumNbOfSamplesByClass()

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

◆ SetNbOfSamplesAllClasses()

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

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

◆ SetNbOfSamplesByClass()

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

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

◆ SetNthClassCount()

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

Set the class counts for input 'index'

◆ SetPercentageOfSamples()

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

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

◆ SetTotalNumberOfSamples()

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

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

◆ UpdateGlobalCounts()

void otb::SamplingRateCalculatorList::UpdateGlobalCounts ( )
private

Member Data Documentation

◆ m_GlobalCountMap

ClassCountMapType otb::SamplingRateCalculatorList::m_GlobalCountMap
private

Definition at line 113 of file otbSamplingRateCalculatorList.h.


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