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

#include <otbShiftScaleVectorImageFilter.h>

+ Inheritance diagram for otb::Functor::VectorShiftScale< TInput, TOutput >:
+ Collaboration diagram for otb::Functor::VectorShiftScale< TInput, TOutput >:

Public Types

typedef itk::NumericTraits
< typename TInput::ValueType >
::RealType 
RealType
 

Public Member Functions

TInput GetScaleValues ()
 
TInput GetShiftValues ()
 
bool operator!= (const VectorShiftScale &other) const
 
TOutput operator() (const TInput &x) const
 
bool operator== (const VectorShiftScale &other) const
 
void SetScaleValues (TInput value)
 
void SetShiftValues (TInput value)
 
 VectorShiftScale ()
 
virtual ~VectorShiftScale ()
 

Private Attributes

TOutput m_Scale
 
TInput m_Shift
 

Detailed Description

template<class TInput, class TOutput>
class otb::Functor::VectorShiftScale< TInput, TOutput >

This functor performs a per band linear transform of its input.

For each band, the following formula is applied :

\[ output = \frac{input - shift}{scale} \]

Standard casting is applied between input and output type.

Shifts and scales can be set via the SetShiftValues() and SetScaleValues() methods.

TInput and TOutput type are supposed to be of type itk::VariableLengthVector.

Definition at line 48 of file otbShiftScaleVectorImageFilter.h.

Member Typedef Documentation

template<class TInput, class TOutput>
typedef itk::NumericTraits<typename TInput::ValueType>::RealType otb::Functor::VectorShiftScale< TInput, TOutput >::RealType

Real type typedef.

Definition at line 53 of file otbShiftScaleVectorImageFilter.h.

Constructor & Destructor Documentation

template<class TInput, class TOutput>
otb::Functor::VectorShiftScale< TInput, TOutput >::VectorShiftScale ( )
inline

Constructor.

Definition at line 56 of file otbShiftScaleVectorImageFilter.h.

template<class TInput, class TOutput>
virtual otb::Functor::VectorShiftScale< TInput, TOutput >::~VectorShiftScale ( )
inlinevirtual

Constructor.

Definition at line 59 of file otbShiftScaleVectorImageFilter.h.

Member Function Documentation

template<class TInput, class TOutput>
TInput otb::Functor::VectorShiftScale< TInput, TOutput >::GetScaleValues ( )
inline
template<class TInput, class TOutput>
TInput otb::Functor::VectorShiftScale< TInput, TOutput >::GetShiftValues ( )
inline
template<class TInput, class TOutput>
bool otb::Functor::VectorShiftScale< TInput, TOutput >::operator!= ( const VectorShiftScale< TInput, TOutput > &  other) const
inline

Definition at line 79 of file otbShiftScaleVectorImageFilter.h.

template<class TInput, class TOutput>
TOutput otb::Functor::VectorShiftScale< TInput, TOutput >::operator() ( const TInput &  x) const
inline

Definition at line 110 of file otbShiftScaleVectorImageFilter.h.

template<class TInput, class TOutput>
bool otb::Functor::VectorShiftScale< TInput, TOutput >::operator== ( const VectorShiftScale< TInput, TOutput > &  other) const
inline

Definition at line 104 of file otbShiftScaleVectorImageFilter.h.

template<class TInput, class TOutput>
void otb::Functor::VectorShiftScale< TInput, TOutput >::SetScaleValues ( TInput  value)
inline

Definition at line 66 of file otbShiftScaleVectorImageFilter.h.

template<class TInput, class TOutput>
void otb::Functor::VectorShiftScale< TInput, TOutput >::SetShiftValues ( TInput  value)
inline

Accessors.

Definition at line 62 of file otbShiftScaleVectorImageFilter.h.

Member Data Documentation

template<class TInput, class TOutput>
TOutput otb::Functor::VectorShiftScale< TInput, TOutput >::m_Scale
private
template<class TInput, class TOutput>
TInput otb::Functor::VectorShiftScale< TInput, TOutput >::m_Shift
private

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