OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer > Class Template Reference

#include <otbListSampleToVariableDimensionHistogramGenerator.h>

+ Inheritance diagram for otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >:
+ Collaboration diagram for otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::DataObjectPointer DataObjectPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef itk::NumericTraits< THistogramMeasurement >::RealType HistogramMeasurementRealType
 
typedef HistogramType::SizeType HistogramSizeType
 
typedef itk::Statistics::Histogram< HistogramMeasurementRealType, TFrequencyContainer > HistogramType
 
typedef TListSample ListSampleType
 
typedef HistogramType::MeasurementVectorType MeasurementVectorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ListSampleToVariableDimensionHistogramGenerator Self
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const bool & GetAutoMinMax () const
 
const ListSampleTypeGetListSample () const
 
virtual const char * GetNameOfClass () const
 
const HistogramTypeGetOutput ()
 
virtual void SetAutoMinMax (bool _arg)
 
void SetHistogramMax (const MeasurementVectorType &histogramMax)
 
void SetHistogramMin (const MeasurementVectorType &histogramMin)
 
void SetListSample (const ListSampleType *inputlist)
 
void SetMarginalScale (float scale)
 
void SetNumberOfBins (HistogramSizeType sizes)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

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

Private Attributes

bool m_AutoMinMax
 
MeasurementVectorType m_HistogramMax
 
MeasurementVectorType m_HistogramMin
 
float m_MarginalScale
 
HistogramSizeType m_Sizes {0,0}
 

Detailed Description

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

Generates a VariableDimensionHistogram from a ListSample.

This class is a fork from itk::ListSampleToHistogramGenerator adapted to produce VariableDimensionHistogram, whose dimension can be chosen at runtime.

Since the MeasurementVectorSize template parameter is no longer needed, it has been removed.

For more information, please refer to the ListSampleToHistogramGenerator class documentation.

See also
VariableDimensionHistogram, ListSample, ListSampleToHistogramGenerator

Definition at line 50 of file otbListSampleToVariableDimensionHistogramGenerator.h.

Member Typedef Documentation

◆ ConstPointer

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef itk::SmartPointer<const Self> otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ConstPointer

◆ DataObjectPointer

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef Superclass::DataObjectPointer otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::DataObjectPointer

DataObject typedef

Definition at line 77 of file otbListSampleToVariableDimensionHistogramGenerator.h.

◆ DataObjectPointerArraySizeType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::DataObjectPointerArraySizeType

◆ HistogramMeasurementRealType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef itk::NumericTraits<THistogramMeasurement>::RealType otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramMeasurementRealType

Type needed for defining the limits of the histogram bins

Definition at line 69 of file otbListSampleToVariableDimensionHistogramGenerator.h.

◆ HistogramSizeType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef HistogramType::SizeType otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramSizeType

◆ HistogramType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef itk::Statistics::Histogram<HistogramMeasurementRealType, TFrequencyContainer> otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramType

◆ ListSampleType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef TListSample otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleType

typedef the ListSampleType

Definition at line 63 of file otbListSampleToVariableDimensionHistogramGenerator.h.

◆ MeasurementVectorType

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef HistogramType::MeasurementVectorType otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::MeasurementVectorType

◆ Pointer

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef itk::SmartPointer<Self> otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Pointer

◆ Self

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef ListSampleToVariableDimensionHistogramGenerator otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Self

Standard typedefs

Definition at line 54 of file otbListSampleToVariableDimensionHistogramGenerator.h.

◆ Superclass

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
typedef itk::ProcessObject otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::Superclass

Constructor & Destructor Documentation

◆ ListSampleToVariableDimensionHistogramGenerator()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >
otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleToVariableDimensionHistogramGenerator
protected

◆ ~ListSampleToVariableDimensionHistogramGenerator()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::~ListSampleToVariableDimensionHistogramGenerator ( )
inlineoverrideprotected

Member Function Documentation

◆ CreateAnother()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
virtual::itk::LightObject::Pointer otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::CreateAnother ( void  ) const

◆ GenerateData()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >
void otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GenerateData
overrideprotected

◆ GetAutoMinMax()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
virtual const bool& otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetAutoMinMax ( ) const
virtual

◆ GetListSample()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >
const ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::ListSampleType * otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetListSample

◆ GetNameOfClass()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
virtual const char* otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetOutput()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >
const ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::HistogramType * otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::GetOutput

◆ MakeOutput()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >
ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::DataObjectPointer otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotected

◆ New()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
static Pointer otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SetAutoMinMax()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
virtual void otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetAutoMinMax ( bool  _arg)
virtual

◆ SetHistogramMax()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
void otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetHistogramMax ( const MeasurementVectorType histogramMax)
inline

◆ SetHistogramMin()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
void otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetHistogramMin ( const MeasurementVectorType histogramMin)
inline

◆ SetListSample()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer >
void otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetListSample ( const ListSampleType inputlist)

◆ SetMarginalScale()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
void otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetMarginalScale ( float  scale)
inline

◆ SetNumberOfBins()

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
void otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::SetNumberOfBins ( HistogramSizeType  sizes)
inline

Member Data Documentation

◆ m_AutoMinMax

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
bool otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_AutoMinMax
private

◆ m_HistogramMax

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
MeasurementVectorType otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_HistogramMax
private

◆ m_HistogramMin

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
MeasurementVectorType otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_HistogramMin
private

◆ m_MarginalScale

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
float otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_MarginalScale
private

◆ m_Sizes

template<class TListSample , class THistogramMeasurement , class TFrequencyContainer = itk::Statistics::DenseFrequencyContainer2>
HistogramSizeType otb::ListSampleToVariableDimensionHistogramGenerator< TListSample, THistogramMeasurement, TFrequencyContainer >::m_Sizes {0,0}
private

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