otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer > Class Template Reference

#include <otbListSampleToHistogramListGenerator.h>

Inheritance diagram for otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >:

Collaboration diagram for otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectPointer	DataObjectPointer
typedef itk::ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef HistogramListType::Pointer	HistogramListPointerType
typedef ObjectList< HistogramType >	HistogramListType
typedef itk::NumericTraits< THistogramMeasurement >::RealType	HistogramMeasurementRealType
typedef HistogramType::SizeType	HistogramSizeType
typedef itk::Statistics::Histogram< HistogramMeasurementRealType, TFrequencyContainer >	HistogramType
typedef TListSample::ConstPointer	ListSampleConstPointerType
typedef TListSample	ListSampleType
typedef TListSample::MeasurementVectorType	MeasurementVectorType
typedef itk::SmartPointer< Self >	Pointer
typedef ListSampleToHistogramListGenerator	Self
typedef itk::ProcessObject	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const bool &	GetAutoMinMax () const
const ListSampleType *	GetListSample () const
virtual const char *	GetNameOfClass () const
virtual bool	GetNoDataFlag ()
virtual const THistogramMeasurement &	GetNoDataValue () const
const HistogramListType *	GetOutput ()
virtual void	NoDataFlagOff ()
virtual void	NoDataFlagOn ()
virtual void	SetAutoMinMax (bool _arg)
void	SetHistogramMax (const MeasurementVectorType &histogramMax)
void	SetHistogramMin (const MeasurementVectorType &histogramMin)
void	SetListSample (const ListSampleType *inputlist)
void	SetMarginalScale (float scale)
virtual void	SetNoDataFlag (bool _arg)
virtual void	SetNoDataValue (THistogramMeasurement _arg)
void	SetNumberOfBins (unsigned int size)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	GenerateData () override
	ListSampleToHistogramListGenerator ()
DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	~ListSampleToHistogramListGenerator () override

Private Attributes
bool	m_AutoMinMax
MeasurementVectorType	m_HistogramMax
MeasurementVectorType	m_HistogramMin
float	m_MarginalScale
bool	m_NoDataFlag
THistogramMeasurement	m_NoDataValue
HistogramSizeType	m_Size {0,0}

Detailed Description

template<class TListSample, class THistogramMeasurement, class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
class otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >

Generates a list of 1D Histograms from a ListSample This class is similar to ListSampleToVariableDimensionHistogramGenerator, except from the fact that it computes one histogram per channel instead of a single joint-histogram. The output is a Histogram list (.

See also

ObjectList).

ListSampleToVariableDimensionHistogram

Definition at line 46 of file otbListSampleToHistogramListGenerator.h.

Member Typedef Documentation

ConstPointer

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef itk::SmartPointer<const Self> otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ConstPointer

Definition at line 53 of file otbListSampleToHistogramListGenerator.h.

DataObjectPointer

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef Superclass::DataObjectPointer otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::DataObjectPointer

DataObject typedef

Definition at line 75 of file otbListSampleToHistogramListGenerator.h.

DataObjectPointerArraySizeType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::DataObjectPointerArraySizeType

Definition at line 76 of file otbListSampleToHistogramListGenerator.h.

HistogramListPointerType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef HistogramListType::Pointer otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramListPointerType

Definition at line 70 of file otbListSampleToHistogramListGenerator.h.

HistogramListType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef ObjectList<HistogramType> otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramListType

Definition at line 69 of file otbListSampleToHistogramListGenerator.h.

HistogramMeasurementRealType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef itk::NumericTraits<THistogramMeasurement>::RealType otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramMeasurementRealType

Type needed for defining the limits of the histogram bins

Definition at line 65 of file otbListSampleToHistogramListGenerator.h.

HistogramSizeType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef HistogramType::SizeType otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramSizeType

Definition at line 67 of file otbListSampleToHistogramListGenerator.h.

HistogramType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef itk::Statistics::Histogram<HistogramMeasurementRealType, TFrequencyContainer> otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramType

Definition at line 66 of file otbListSampleToHistogramListGenerator.h.

ListSampleConstPointerType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef TListSample::ConstPointer otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleConstPointerType

Definition at line 72 of file otbListSampleToHistogramListGenerator.h.

ListSampleType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef TListSample otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleType

typedef the input ListSample type

Definition at line 59 of file otbListSampleToHistogramListGenerator.h.

MeasurementVectorType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef TListSample::MeasurementVectorType otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::MeasurementVectorType

Definition at line 68 of file otbListSampleToHistogramListGenerator.h.

Pointer

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef itk::SmartPointer<Self> otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Pointer

Definition at line 52 of file otbListSampleToHistogramListGenerator.h.

Self

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef ListSampleToHistogramListGenerator otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Self

Standard typedefs

Definition at line 50 of file otbListSampleToHistogramListGenerator.h.

Superclass

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

typedef itk::ProcessObject otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Superclass

Definition at line 51 of file otbListSampleToHistogramListGenerator.h.

Constructor & Destructor Documentation

ListSampleToHistogramListGenerator()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >

otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleToHistogramListGenerator

protected

Definition at line 33 of file otbListSampleToHistogramListGenerator.hxx.

References otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_Size, and otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::MakeOutput().

~ListSampleToHistogramListGenerator()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::~ListSampleToHistogramListGenerator ( )

inlineoverrideprotected

Definition at line 148 of file otbListSampleToHistogramListGenerator.h.

Member Function Documentation

CreateAnother()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual::itk::LightObject::Pointer otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::CreateAnother

(

void

)

const

GenerateData()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >

void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GenerateData

overrideprotected

Definition at line 84 of file otbListSampleToHistogramListGenerator.hxx.

References otbMsgDebugMacro, and otbMsgDevMacro.

GetAutoMinMax()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual const bool& otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetAutoMinMax ( ) const

virtual

GetListSample()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >

const ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleType * otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetListSample

Definition at line 55 of file otbListSampleToHistogramListGenerator.hxx.

GetNameOfClass()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual const char* otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetNoDataFlag()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual bool otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetNoDataFlag ( )

virtual

Get the NoDataFlag. If set to true, samples with values equal to m_NoDataValue are ignored.

GetNoDataValue()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual const THistogramMeasurement& otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetNoDataValue ( ) const

virtual

Set the no data value. These value are ignored in histogram computation if NoDataFlag is On

GetOutput()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >

const ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramListType * otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetOutput

Definition at line 67 of file otbListSampleToHistogramListGenerator.hxx.

MakeOutput()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >

ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::DataObjectPointer otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::MakeOutput ( DataObjectPointerArraySizeType  idx )

overrideprotected

Definition at line 75 of file otbListSampleToHistogramListGenerator.hxx.

Referenced by otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleToHistogramListGenerator().

New()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

static Pointer otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::New ( )

static

Method for creation through the object factory.

NoDataFlagOff()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::NoDataFlagOff ( )

virtual

NoDataFlagOn()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::NoDataFlagOn ( )

virtual

Toggle the NoDataFlag. If set to true, samples with values equal to m_NoDataValue are ignored.

PrintSelf()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >

void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

Definition at line 216 of file otbListSampleToHistogramListGenerator.hxx.

SetAutoMinMax()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetAutoMinMax ( bool  _arg )

virtual

SetHistogramMax()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetHistogramMax ( const MeasurementVectorType &  histogramMax )

inline

Definition at line 140 of file otbListSampleToHistogramListGenerator.h.

SetHistogramMin()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetHistogramMin ( const MeasurementVectorType &  histogramMin )

inline

Definition at line 134 of file otbListSampleToHistogramListGenerator.h.

SetListSample()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >

void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetListSample

(

const ListSampleType *

inputlist

)

Definition at line 46 of file otbListSampleToHistogramListGenerator.hxx.

SetMarginalScale()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetMarginalScale ( float  scale )

inline

Definition at line 118 of file otbListSampleToHistogramListGenerator.h.

SetNoDataFlag()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetNoDataFlag ( bool  _arg )

virtual

Set the NoDataFlag. If set to true, samples with values equal to m_NoDataValue are ignored.

SetNoDataValue()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

virtual void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetNoDataValue ( THistogramMeasurement  _arg )

virtual

plug in the ListSample object Set the no data value. These value are ignored in histogram computation if NoDataFlag is On

SetNumberOfBins()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

void otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetNumberOfBins ( unsigned int  size )

inline

Definition at line 123 of file otbListSampleToHistogramListGenerator.h.

Member Data Documentation

m_AutoMinMax

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

bool otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_AutoMinMax

private

Definition at line 165 of file otbListSampleToHistogramListGenerator.h.

m_HistogramMax

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

MeasurementVectorType otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_HistogramMax

private

Definition at line 164 of file otbListSampleToHistogramListGenerator.h.

m_HistogramMin

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

MeasurementVectorType otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_HistogramMin

private

Definition at line 163 of file otbListSampleToHistogramListGenerator.h.

m_MarginalScale

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

float otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_MarginalScale

private

Definition at line 162 of file otbListSampleToHistogramListGenerator.h.

m_NoDataFlag

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

bool otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_NoDataFlag

private

Definition at line 167 of file otbListSampleToHistogramListGenerator.h.

m_NoDataValue

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

THistogramMeasurement otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_NoDataValue

private

Definition at line 168 of file otbListSampleToHistogramListGenerator.h.

m_Size

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>

HistogramSizeType otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_Size {0,0}

private

Definition at line 161 of file otbListSampleToHistogramListGenerator.h.

Referenced by otb::ListSampleToHistogramListGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleToHistogramListGenerator().

---

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

• otbListSampleToHistogramListGenerator.h
• otbListSampleToHistogramListGenerator.hxx