OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage > Class Template Reference
Data Processing Objects » Filters » Image Filters » Intensity Image FiltersGroup Core » | Module OTBImageManipulation

#include <otbShiftScaleVectorImageFilter.h>

+ Inheritance diagram for otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef Functor::VectorShiftScale< typename TInputImage::PixelType, typename TOutputImage::PixelType > FunctorType
 
typedef TInputImage::PixelType InputPixelType
 
typedef itk::NumericTraits< InputValueType >::RealType InputRealType
 
typedef InputPixelType::ValueType InputValueType
 
typedef TOutputImage::PixelType OutputPixelType
 
typedef itk::NumericTraits< OutputValueType >::RealType OutputRealType
 
typedef OutputPixelType::ValueType OutputValueType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef ShiftScaleVectorImageFilter Self
 
typedef itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, FunctorType > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual InputPixelType GetScale ()
 
virtual InputPixelType GetShift ()
 
virtual void SetScale (InputPixelType _arg)
 
virtual void SetShift (InputPixelType _arg)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void GenerateInputRequestedRegion (void) override
 
void GenerateOutputInformation (void) override
 
 ShiftScaleVectorImageFilter ()
 
 ~ShiftScaleVectorImageFilter () override
 
void BeforeThreadedGenerateData (void) override
 

Private Member Functions

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

Private Attributes

InputPixelType m_Scale
 
InputPixelType m_Shift
 

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >

This filter performs a shift and scaling of a vector image on a per band basis.

For each band, the following formula is applied :

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

Beware that the behaviour differs from itk::ShiftScaleImageFilter (which add shift instead of subtracting it).

See also
VectorShiftScale

Definition at line 165 of file otbShiftScaleVectorImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::SmartPointer<const Self> otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 175 of file otbShiftScaleVectorImageFilter.h.

◆ FunctorType

template<class TInputImage , class TOutputImage = TInputImage>
typedef Functor::VectorShiftScale<typename TInputImage::PixelType, typename TOutputImage::PixelType> otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::FunctorType

Definition at line 172 of file otbShiftScaleVectorImageFilter.h.

◆ InputPixelType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::PixelType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 178 of file otbShiftScaleVectorImageFilter.h.

◆ InputRealType

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::NumericTraits<InputValueType>::RealType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::InputRealType

Definition at line 181 of file otbShiftScaleVectorImageFilter.h.

◆ InputValueType

template<class TInputImage , class TOutputImage = TInputImage>
typedef InputPixelType::ValueType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::InputValueType

Definition at line 179 of file otbShiftScaleVectorImageFilter.h.

◆ OutputPixelType

template<class TInputImage , class TOutputImage = TInputImage>
typedef TOutputImage::PixelType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 177 of file otbShiftScaleVectorImageFilter.h.

◆ OutputRealType

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::NumericTraits<OutputValueType>::RealType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::OutputRealType

Definition at line 182 of file otbShiftScaleVectorImageFilter.h.

◆ OutputValueType

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputPixelType::ValueType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::OutputValueType

Definition at line 180 of file otbShiftScaleVectorImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::SmartPointer<Self> otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 174 of file otbShiftScaleVectorImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage = TInputImage>
typedef ShiftScaleVectorImageFilter otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 171 of file otbShiftScaleVectorImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage = TInputImage>
typedef itk::UnaryFunctorImageFilter<TInputImage, TOutputImage, FunctorType> otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 173 of file otbShiftScaleVectorImageFilter.h.

Constructor & Destructor Documentation

◆ ShiftScaleVectorImageFilter() [1/2]

template<class TInputImage , class TOutputImage = TInputImage>
otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::ShiftScaleVectorImageFilter ( )
inlineprotected

Definition at line 197 of file otbShiftScaleVectorImageFilter.h.

◆ ~ShiftScaleVectorImageFilter()

template<class TInputImage , class TOutputImage = TInputImage>
otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::~ShiftScaleVectorImageFilter ( )
inlineoverrideprotected

Definition at line 200 of file otbShiftScaleVectorImageFilter.h.

◆ ShiftScaleVectorImageFilter() [2/2]

template<class TInputImage , class TOutputImage = TInputImage>
otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::ShiftScaleVectorImageFilter ( const Self &  )
privatedelete

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  )
overrideprotected

Process to execute before entering the multithreaded section

Process to execute before entering the multithreaded section.

Definition at line 58 of file otbShiftScaleVectorImageFilter.hxx.

◆ CreateAnother()

template<class TInputImage , class TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage >
void otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( void  )
overrideprotected

Generate input requested region

Generate input requested region.

Definition at line 43 of file otbShiftScaleVectorImageFilter.hxx.

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage >
void otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( void  )
overrideprotected

Generate output information

Generate output information.

Definition at line 33 of file otbShiftScaleVectorImageFilter.hxx.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage = TInputImage>
virtual const char* otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

◆ GetScale()

template<class TInputImage , class TOutputImage = TInputImage>
virtual InputPixelType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::GetScale ( )
virtual

◆ GetShift()

template<class TInputImage , class TOutputImage = TInputImage>
virtual InputPixelType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::GetShift ( )
virtual

◆ New()

template<class TInputImage , class TOutputImage = TInputImage>
static Pointer otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage = TInputImage>
void otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::operator= ( const Self &  )
privatedelete

◆ SetScale()

template<class TInputImage , class TOutputImage = TInputImage>
virtual void otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::SetScale ( InputPixelType  _arg)
virtual

◆ SetShift()

template<class TInputImage , class TOutputImage = TInputImage>
virtual void otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::SetShift ( InputPixelType  _arg)
virtual

Member Data Documentation

◆ m_Scale

template<class TInputImage , class TOutputImage = TInputImage>
InputPixelType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::m_Scale
private

Definition at line 217 of file otbShiftScaleVectorImageFilter.h.

◆ m_Shift

template<class TInputImage , class TOutputImage = TInputImage>
InputPixelType otb::ShiftScaleVectorImageFilter< TInputImage, TOutputImage >::m_Shift
private

Definition at line 218 of file otbShiftScaleVectorImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:27 for OTB with   doxygen 1.8.17