OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Private Attributes | List of all members
otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput > Class Template Reference

#include <otbAmplitudePhaseToRGBFunctor.h>

+ Collaboration diagram for otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >:

Public Types

typedef HSVToRGBFunctor
< RGBPixelType
HSVToRGBFunctorType
 
typedef RGBPixelType::ValueType RGBComponentType
 
typedef TOutput RGBPixelType
 
typedef TInput1 ScalarType
 

Public Member Functions

 AmplitudePhaseToRGBFunctor ()
 
TOutput operator() (const TInput1 &amplitude, const TInput2 &coherence, const TInput3 &phase) const
 
void SetMaximum (ScalarType max)
 
void SetMinimum (ScalarType min)
 
 ~AmplitudePhaseToRGBFunctor ()
 

Private Attributes

HSVToRGBFunctorType m_HSVToRGBFunctor
 
ScalarType m_Maximum
 
ScalarType m_Minimum
 

Detailed Description

template<class TInput1, class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
class otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >

Function object to compute a color representation of a radar image.

This class is useful for visualizing radar images with a combination of the phase and the amplitude at the same time.

The amplitude is used to represent the intensity of the pixel and the phase to represent it's hue.

Amplitude and phase can be obtained using the itk::ComplexToModulusImageFilter and itk::ComplexToPhaseImageFilter for example.

Definition at line 50 of file otbAmplitudePhaseToRGBFunctor.h.

Member Typedef Documentation

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
typedef HSVToRGBFunctor<RGBPixelType> otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::HSVToRGBFunctorType

Definition at line 55 of file otbAmplitudePhaseToRGBFunctor.h.

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
typedef RGBPixelType::ValueType otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::RGBComponentType

Definition at line 54 of file otbAmplitudePhaseToRGBFunctor.h.

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
typedef TOutput otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::RGBPixelType

Definition at line 53 of file otbAmplitudePhaseToRGBFunctor.h.

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
typedef TInput1 otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::ScalarType

Definition at line 56 of file otbAmplitudePhaseToRGBFunctor.h.

Constructor & Destructor Documentation

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::AmplitudePhaseToRGBFunctor ( )
inline

Definition at line 58 of file otbAmplitudePhaseToRGBFunctor.h.

References itk::NumericTraits< T >::max().

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::~AmplitudePhaseToRGBFunctor ( )
inline

Definition at line 63 of file otbAmplitudePhaseToRGBFunctor.h.

Member Function Documentation

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
TOutput otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::operator() ( const TInput1 &  amplitude,
const TInput2 &  coherence,
const TInput3 &  phase 
) const
inline
template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
void otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::SetMaximum ( ScalarType  max)
inline

Definition at line 65 of file otbAmplitudePhaseToRGBFunctor.h.

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
void otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::SetMinimum ( ScalarType  min)
inline

Definition at line 70 of file otbAmplitudePhaseToRGBFunctor.h.

Member Data Documentation

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
HSVToRGBFunctorType otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::m_HSVToRGBFunctor
private

Definition at line 103 of file otbAmplitudePhaseToRGBFunctor.h.

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
ScalarType otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::m_Maximum
private

Definition at line 101 of file otbAmplitudePhaseToRGBFunctor.h.

template<class TInput1 , class TInput2 = TInput1, class TInput3 = TInput1, class TOutput = TInput1>
ScalarType otb::Functor::AmplitudePhaseToRGBFunctor< TInput1, TInput2, TInput3, TOutput >::m_Minimum
private

Definition at line 102 of file otbAmplitudePhaseToRGBFunctor.h.


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