OTB  7.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage > Class Template Reference

#include <otbStreamingStatisticsMapFromLabelImageFilter.h>

+ Inheritance diagram for otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >:
+ Collaboration diagram for otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TLabelImage LabelImageType
 
typedef Superclass::FilterType::LabelPopulationMapType LabelPopulationMapType
 
typedef Superclass::FilterType::PixelValueMapObjectType PixelValueMapObjectType
 
typedef Superclass::FilterType::PixelValueMapType PixelValueMapType
 
typedef itk::SmartPointer< SelfPointer
 
typedef StreamingStatisticsMapFromLabelImageFilter Self
 
typedef PersistentFilterStreamingDecorator< PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage > > Superclass
 
typedef TInputVectorImage VectorImageType
 
typedef VectorImageType::PixelType VectorPixelType
 
typedef VectorImageType::PixelType::ValueType VectorPixelValueType
 
- Public Types inherited from otb::PersistentFilterStreamingDecorator< PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage > >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef FilterType::Pointer FilterPointerType
 
typedef PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage > FilterType
 
typedef FilterType::InputImageType ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PersistentFilterStreamingDecorator Self
 
typedef StreamerType::Pointer StreamerPointerType
 
typedef StreamingImageVirtualWriter< ImageTypeStreamerType
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const VectorImageTypeGetInput ()
 
const LabelImageTypeGetInputLabelImage ()
 
LabelPopulationMapType GetLabelPopulationMap () const
 
PixelValueMapType GetMaxValueMap () const
 
PixelValueMapType GetMeanValueMap () const
 
PixelValueMapType GetMinValueMap () const
 
virtual const char * GetNameOfClass () const
 
VectorPixelValueType GetNoDataValue () const
 
PixelValueMapType GetStandardDeviationValueMap () const
 
bool GetUseNoDataValue () const
 
void SetInputLabelImage (const LabelImageType *input)
 
void SetNoDataValue (VectorPixelValueType value)
 
void SetUseNoDataValue (bool useNoDataValue)
 
void SetInput (const VectorImageType *input)
 
- Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage > >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const FilterTypeGetFilter () const
 
 itkGetObjectMacro (Filter, FilterType)
 
 itkGetObjectMacro (Streamer, StreamerType)
 
virtual void SetFilter (FilterType *_arg)
 
void Update (void) override
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage > >
static Pointer New ()
 

Protected Member Functions

 StreamingStatisticsMapFromLabelImageFilter ()
 
 ~StreamingStatisticsMapFromLabelImageFilter () override
 
- Protected Member Functions inherited from otb::PersistentFilterStreamingDecorator< PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage > >
void GenerateData (void) override
 
 PersistentFilterStreamingDecorator ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentFilterStreamingDecorator () override
 

Private Member Functions

void operator= (const Self &)=delete
 
 StreamingStatisticsMapFromLabelImageFilter (const Self &)=delete
 

Additional Inherited Members

- Protected Attributes inherited from otb::PersistentFilterStreamingDecorator< PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage > >
FilterPointerType m_Filter
 
StreamerPointerType m_Streamer
 

Detailed Description

template<class TInputVectorImage, class TLabelImage>
class otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >

Computes mean radiometric value for each label of a label image, based on a support VectorImage.

Currently the class only computes the mean value.

This class streams the whole input image through the PersistentStreamingStatisticsMapFromLabelImageFilter.

This way, it allows computing the first order global statistics of this image. It calls the Reset() method of the PersistentStatisticsImageFilter before streaming the image and the Synthetize() method of the PersistentStatisticsImageFilter after having streamed the image to compute the statistics. The accessor on the results are wrapping the accessors of the internal PersistentStatisticsImageFilter.

This filter can be used as:

StatisticsType::Pointer statistics = StatisticsType::New();
statistics->SetInput(reader->GetOutput());
statistics->Update();
StatisticsType::PixelValueMapType meanValueMap = statistics->GetMeanValueMap();
StatisticsType::PixelValueMapType::const_iterator end = meanValueMap();
for (StatisticsType::PixelValueMapType::const_iterator it = meanValueMap.begin(); it != end; ++it)
{
std::cout << "label : " << it->first << " , ";
<< "mean value : " << it->second << std::endl;
}
See also
PersistentStatisticsImageFilter
PersistentImageFilter
PersistentFilterStreamingDecorator
StreamingImageVirtualWriter

Definition at line 344 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputVectorImage , class TLabelImage >
typedef itk::SmartPointer<const Self> otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::ConstPointer

◆ LabelImageType

template<class TInputVectorImage , class TLabelImage >
typedef TLabelImage otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::LabelImageType

◆ LabelPopulationMapType

template<class TInputVectorImage , class TLabelImage >
typedef Superclass::FilterType::LabelPopulationMapType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::LabelPopulationMapType

◆ PixelValueMapObjectType

template<class TInputVectorImage , class TLabelImage >
typedef Superclass::FilterType::PixelValueMapObjectType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::PixelValueMapObjectType

◆ PixelValueMapType

template<class TInputVectorImage , class TLabelImage >
typedef Superclass::FilterType::PixelValueMapType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::PixelValueMapType

◆ Pointer

template<class TInputVectorImage , class TLabelImage >
typedef itk::SmartPointer<Self> otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::Pointer

◆ Self

template<class TInputVectorImage , class TLabelImage >
typedef StreamingStatisticsMapFromLabelImageFilter otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::Self

Standard Self typedef

Definition at line 349 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ Superclass

template<class TInputVectorImage , class TLabelImage >
typedef PersistentFilterStreamingDecorator<PersistentStreamingStatisticsMapFromLabelImageFilter<TInputVectorImage, TLabelImage> > otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::Superclass

◆ VectorImageType

template<class TInputVectorImage , class TLabelImage >
typedef TInputVectorImage otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::VectorImageType

◆ VectorPixelType

template<class TInputVectorImage , class TLabelImage >
typedef VectorImageType::PixelType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::VectorPixelType

◆ VectorPixelValueType

template<class TInputVectorImage , class TLabelImage >
typedef VectorImageType::PixelType::ValueType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::VectorPixelValueType

Constructor & Destructor Documentation

◆ StreamingStatisticsMapFromLabelImageFilter() [1/2]

template<class TInputVectorImage , class TLabelImage >
otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::StreamingStatisticsMapFromLabelImageFilter ( )
inlineprotected

Constructor

Definition at line 453 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ ~StreamingStatisticsMapFromLabelImageFilter()

template<class TInputVectorImage , class TLabelImage >
otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::~StreamingStatisticsMapFromLabelImageFilter ( )
inlineoverrideprotected

Destructor

Definition at line 458 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ StreamingStatisticsMapFromLabelImageFilter() [2/2]

template<class TInputVectorImage , class TLabelImage >
otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::StreamingStatisticsMapFromLabelImageFilter ( const Self )
privatedelete

Member Function Documentation

◆ CreateAnother()

template<class TInputVectorImage , class TLabelImage >
virtual::itk::LightObject::Pointer otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::CreateAnother ( void  ) const

◆ GetInput()

template<class TInputVectorImage , class TLabelImage >
const VectorImageType* otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetInput ( void  )
inline

Get input multispectral image

Definition at line 380 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ GetInputLabelImage()

template<class TInputVectorImage , class TLabelImage >
const LabelImageType* otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetInputLabelImage ( )
inline

Get input label image (monoband)

Definition at line 392 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ GetLabelPopulationMap()

template<class TInputVectorImage , class TLabelImage >
LabelPopulationMapType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetLabelPopulationMap ( ) const
inline

Return the computed number of labeled pixels for each label

Definition at line 422 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ GetMaxValueMap()

template<class TInputVectorImage , class TLabelImage >
PixelValueMapType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetMaxValueMap ( ) const
inline

Return the computed Max for each label

Definition at line 416 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ GetMeanValueMap()

template<class TInputVectorImage , class TLabelImage >
PixelValueMapType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetMeanValueMap ( ) const
inline

Return the computed Mean for each label

Definition at line 398 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ GetMinValueMap()

template<class TInputVectorImage , class TLabelImage >
PixelValueMapType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetMinValueMap ( ) const
inline

Return the computed Min for each label

Definition at line 410 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ GetNameOfClass()

template<class TInputVectorImage , class TLabelImage >
virtual const char* otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetNameOfClass ( ) const
virtual

◆ GetNoDataValue()

template<class TInputVectorImage , class TLabelImage >
VectorPixelValueType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetNoDataValue ( ) const
inline

Return the no data value

Definition at line 434 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ GetStandardDeviationValueMap()

template<class TInputVectorImage , class TLabelImage >
PixelValueMapType otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetStandardDeviationValueMap ( ) const
inline

Return the computed Standard Deviation for each label

Definition at line 404 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ GetUseNoDataValue()

template<class TInputVectorImage , class TLabelImage >
bool otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::GetUseNoDataValue ( ) const
inline

Return whether no data pixels are ignored

Definition at line 446 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ New()

template<class TInputVectorImage , class TLabelImage >
static Pointer otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::New ( )
static

Type macro

◆ operator=()

template<class TInputVectorImage , class TLabelImage >
void otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::operator= ( const Self )
privatedelete

◆ SetInput()

template<class TInputVectorImage , class TLabelImage >
void otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::SetInput ( const VectorImageType input)
inline

◆ SetInputLabelImage()

template<class TInputVectorImage , class TLabelImage >
void otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::SetInputLabelImage ( const LabelImageType input)
inline

Set input label image (monoband)

Definition at line 386 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ SetNoDataValue()

template<class TInputVectorImage , class TLabelImage >
void otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::SetNoDataValue ( VectorPixelValueType  value)
inline

Set the no data value

Definition at line 428 of file otbStreamingStatisticsMapFromLabelImageFilter.h.

◆ SetUseNoDataValue()

template<class TInputVectorImage , class TLabelImage >
void otb::StreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::SetUseNoDataValue ( bool  useNoDataValue)
inline

Configure whether no data pixels ignored, treating each band independently

Definition at line 440 of file otbStreamingStatisticsMapFromLabelImageFilter.h.


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