otb::ContingencyTableCalculator< TClassLabel > Class Template Reference

#include <otbContingencyTableCalculator.h>

Inheritance diagram for otb::ContingencyTableCalculator< TClassLabel >:

Collaboration diagram for otb::ContingencyTableCalculator< TClassLabel >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef ContingencyTableType::Pointer	ContingencyTablePointerType
typedef ContingencyTable< TClassLabel >	ContingencyTableType
typedef std::map< TClassLabel, unsigned long >	CountMapType
typedef std::map< TClassLabel, CountMapType >	MapOfClassesType
typedef itk::SmartPointer< Self >	Pointer
typedef ContingencyTableCalculator	Self
typedef itk::Object	Superclass

Public Member Functions
ContingencyTablePointerType	BuildContingencyTable ()
void	Clear ()
template<class TRefIterator , class TProdIterator >
void	Compute (TRefIterator itRef, TProdIterator itProd, bool refHasNoData=false, typename TRefIterator::InternalPixelType refNoData=0, bool prodHasNoData=false, typename TProdIterator::InternalPixelType prodNoData=0)
template<class TRefIterator , class TProdIterator >
void	Compute (TRefIterator refBegin, TRefIterator refEnd, TProdIterator prodBegin, TProdIterator prodEnd)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual unsigned long	GetNumberOfProdClasses () const
virtual unsigned long	GetNumberOfRefClasses () const
virtual unsigned long	GetNumberOfSamples () const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	ContingencyTableCalculator ()
	~ContingencyTableCalculator () override

Private Member Functions
	ContingencyTableCalculator (const Self &)=delete
void	operator= (const Self &)=delete

Private Attributes
MapOfClassesType	m_LabelCount
unsigned long	m_NumberOfProdClasses
unsigned long	m_NumberOfRefClasses
unsigned long	m_NumberOfSamples

Detailed Description

template<class TClassLabel>
class otb::ContingencyTableCalculator< TClassLabel >

ContingencyTableCalculator provide facilities to compute ContingencyTable.

The ContingencyTableCalculator can be used with different structure type, the size of the label list should be the same for both list.

Template Parameters

TClassLabel

the label data type

Definition at line 41 of file otbContingencyTableCalculator.h.

Member Typedef Documentation

ConstPointer

template<class TClassLabel >

typedef itk::SmartPointer<const Self> otb::ContingencyTableCalculator< TClassLabel >::ConstPointer

Definition at line 49 of file otbContingencyTableCalculator.h.

ContingencyTablePointerType

template<class TClassLabel >

typedef ContingencyTableType::Pointer otb::ContingencyTableCalculator< TClassLabel >::ContingencyTablePointerType

Definition at line 58 of file otbContingencyTableCalculator.h.

ContingencyTableType

template<class TClassLabel >

typedef ContingencyTable<TClassLabel> otb::ContingencyTableCalculator< TClassLabel >::ContingencyTableType

Definition at line 55 of file otbContingencyTableCalculator.h.

CountMapType

template<class TClassLabel >

typedef std::map<TClassLabel, unsigned long> otb::ContingencyTableCalculator< TClassLabel >::CountMapType

Definition at line 60 of file otbContingencyTableCalculator.h.

MapOfClassesType

template<class TClassLabel >

typedef std::map<TClassLabel, CountMapType> otb::ContingencyTableCalculator< TClassLabel >::MapOfClassesType

Definition at line 61 of file otbContingencyTableCalculator.h.

Pointer

template<class TClassLabel >

typedef itk::SmartPointer<Self> otb::ContingencyTableCalculator< TClassLabel >::Pointer

Definition at line 48 of file otbContingencyTableCalculator.h.

Self

template<class TClassLabel >

typedef ContingencyTableCalculator otb::ContingencyTableCalculator< TClassLabel >::Self

Standard class typedefs

Definition at line 46 of file otbContingencyTableCalculator.h.

Superclass

template<class TClassLabel >

typedef itk::Object otb::ContingencyTableCalculator< TClassLabel >::Superclass

Definition at line 47 of file otbContingencyTableCalculator.h.

Constructor & Destructor Documentation

ContingencyTableCalculator() [1/2]

template<class TClassLabel >

otb::ContingencyTableCalculator< TClassLabel >::ContingencyTableCalculator

protected

Definition at line 35 of file otbContingencyTableCalculator.hxx.

~ContingencyTableCalculator()

template<class TClassLabel >

otb::ContingencyTableCalculator< TClassLabel >::~ContingencyTableCalculator ( )

inlineoverrideprotected

Definition at line 87 of file otbContingencyTableCalculator.h.

ContingencyTableCalculator() [2/2]

template<class TClassLabel >

otb::ContingencyTableCalculator< TClassLabel >::ContingencyTableCalculator ( const Self &  )

privatedelete

Member Function Documentation

BuildContingencyTable()

template<class TClassLabel >

ContingencyTableCalculator< TClassLabel >::ContingencyTablePointerType otb::ContingencyTableCalculator< TClassLabel >::BuildContingencyTable

Definition at line 87 of file otbContingencyTableCalculator.hxx.

Clear()

template<class TClassLabel >

void otb::ContingencyTableCalculator< TClassLabel >::Clear

Definition at line 40 of file otbContingencyTableCalculator.hxx.

Compute() [1/2]

template<class TClassLabel >

template<class TRefIterator , class TProdIterator >

void otb::ContingencyTableCalculator< TClassLabel >::Compute	(	TRefIterator	itRef,
		TProdIterator	itProd,
		bool	refHasNoData = false,
		typename TRefIterator::InternalPixelType	refNoData = 0,
		bool	prodHasNoData = false,
		typename TProdIterator::InternalPixelType	prodNoData = 0
	)

Populate the confusion Matrix for a image iteration.

Template Parameters

TRefListLabel	data structure type which contain the reference labels.
TProdListLabel	data structure type which contain the produced labels.

Definition at line 66 of file otbContingencyTableCalculator.hxx.

Compute() [2/2]

template<class TClassLabel >

template<class TRefIterator , class TProdIterator >

void otb::ContingencyTableCalculator< TClassLabel >::Compute	(	TRefIterator	refBegin,
		TRefIterator	refEnd,
		TProdIterator	prodBegin,
		TProdIterator	prodEnd
	)

Populate the confusion Matrix with input which provide GetMeasurementVector()[0] access

Template Parameters

TRefListLabel	data structure type which contain the reference labels.
TProdListLabel	data structure type which contain the produced labels.

Definition at line 50 of file otbContingencyTableCalculator.hxx.

CreateAnother()

template<class TClassLabel >

virtual::itk::LightObject::Pointer otb::ContingencyTableCalculator< TClassLabel >::CreateAnother

(

void

)

const

GetNameOfClass()

template<class TClassLabel >

virtual const char* otb::ContingencyTableCalculator< TClassLabel >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetNumberOfProdClasses()

template<class TClassLabel >

virtual unsigned long otb::ContingencyTableCalculator< TClassLabel >::GetNumberOfProdClasses ( ) const

virtual

GetNumberOfRefClasses()

template<class TClassLabel >

virtual unsigned long otb::ContingencyTableCalculator< TClassLabel >::GetNumberOfRefClasses ( ) const

virtual

GetNumberOfSamples()

template<class TClassLabel >

virtual unsigned long otb::ContingencyTableCalculator< TClassLabel >::GetNumberOfSamples ( ) const

virtual

New()

template<class TClassLabel >

static Pointer otb::ContingencyTableCalculator< TClassLabel >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TClassLabel >

void otb::ContingencyTableCalculator< TClassLabel >::operator= ( const Self &  )

privatedelete

Member Data Documentation

m_LabelCount

template<class TClassLabel >

MapOfClassesType otb::ContingencyTableCalculator< TClassLabel >::m_LabelCount

private

Definition at line 96 of file otbContingencyTableCalculator.h.

m_NumberOfProdClasses

template<class TClassLabel >

unsigned long otb::ContingencyTableCalculator< TClassLabel >::m_NumberOfProdClasses

private

Definition at line 98 of file otbContingencyTableCalculator.h.

m_NumberOfRefClasses

template<class TClassLabel >

unsigned long otb::ContingencyTableCalculator< TClassLabel >::m_NumberOfRefClasses

private

Definition at line 97 of file otbContingencyTableCalculator.h.

m_NumberOfSamples

template<class TClassLabel >

unsigned long otb::ContingencyTableCalculator< TClassLabel >::m_NumberOfSamples

private

Definition at line 99 of file otbContingencyTableCalculator.h.

---

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

• otbContingencyTableCalculator.h
• otbContingencyTableCalculator.hxx