OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList > Class Template Reference
Group Core » Module OTBStatistics

#include <otbShiftScaleSampleListFilter.h>

+ Inheritance diagram for otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >:
+ Collaboration diagram for otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef InputSampleListType::MeasurementVectorType InputMeasurementVectorType
 
typedef InputSampleListType::ConstPointer InputSampleListConstPointer
 
typedef InputSampleListType::Pointer InputSampleListPointer
 
typedef TInputSampleList InputSampleListType
 
typedef InputMeasurementVectorType::ValueType InputValueType
 
typedef OutputSampleListType::MeasurementVectorType OutputMeasurementVectorType
 
typedef OutputSampleListType::ConstPointer OutputSampleListConstPointer
 
typedef OutputSampleListType::Pointer OutputSampleListPointer
 
typedef TOutputSampleList OutputSampleListType
 
typedef OutputMeasurementVectorType::ValueType OutputValueType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef ShiftScaleSampleListFilter Self
 
typedef otb::Statistics::ListSampleToListSampleFilter< TInputSampleList, TOutputSampleList > Superclass
 
- Public Types inherited from otb::Statistics::ListSampleToListSampleFilter< TInputSampleList, TInputSampleList >
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef InputSampleListType::MeasurementVectorType InputMeasurementVectorType
 
typedef InputSampleListType::ConstPointer InputSampleListConstPointer
 
typedef InputSampleListType::Pointer InputSampleListPointer
 
typedef TInputSampleList InputSampleListType
 
typedef InputMeasurementVectorType::ValueType InputValueType
 
typedef Superclass::OutputMeasurementVectorType OutputMeasurementVectorType
 
typedef Superclass::OutputSampleListConstPointer OutputSampleListConstPointer
 
typedef Superclass::OutputSampleListPointer OutputSampleListPointer
 
typedef Superclass::OutputSampleListType OutputSampleListType
 
typedef Superclass::OutputValueType OutputValueType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef ListSampleToListSampleFilter Self
 
typedef ListSampleSource< TInputSampleList > Superclass
 
- Public Types inherited from otb::Statistics::ListSampleSource< TInputSampleList >
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
typedef OutputSampleListType::MeasurementVectorType OutputMeasurementVectorType
 
typedef OutputSampleListType::ConstPointer OutputSampleListConstPointer
 
typedef OutputSampleListType::Pointer OutputSampleListPointer
 
typedef TInputSampleList OutputSampleListType
 
typedef OutputMeasurementVectorType::ValueType OutputValueType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef ListSampleSource Self
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::Statistics::ListSampleToListSampleFilter< TInputSampleList, TInputSampleList >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
void SetInput (const InputSampleListType *inputPtr)
 
const InputSampleListType * GetInput () const
 
- Public Member Functions inherited from otb::Statistics::ListSampleSource< TInputSampleList >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputSampleListType * GetOutput ()
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::Statistics::ListSampleToListSampleFilter< TInputSampleList, TInputSampleList >
static Pointer New ()
 
- Static Public Member Functions inherited from otb::Statistics::ListSampleSource< TInputSampleList >
static Pointer New ()
 
InputMeasurementVectorType m_Shifts
 
InputMeasurementVectorType m_Scales
 
virtual void SetShifts (InputMeasurementVectorType _arg)
 
virtual InputMeasurementVectorType GetShifts ()
 
virtual void SetScales (InputMeasurementVectorType _arg)
 
virtual InputMeasurementVectorType GetScales ()
 
void GenerateData () override
 
 ShiftScaleSampleListFilter ()
 
 ~ShiftScaleSampleListFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ShiftScaleSampleListFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from otb::Statistics::ListSampleToListSampleFilter< TInputSampleList, TInputSampleList >
 ListSampleToListSampleFilter ()
 
 ~ListSampleToListSampleFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from otb::Statistics::ListSampleSource< TInputSampleList >
 ListSampleSource ()
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~ListSampleSource () override
 

Detailed Description

template<class TInputSampleList, class TOutputSampleList = TInputSampleList>
class otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >

This class generate a shifted and scaled version of the input sample list.

For each component of the sample, 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).

Standard casting is applied between input and output type.

Shifts and scales can be set via the SetShift() and SetScales() methods.

See also
ListSampleToListSampleFilter

Definition at line 51 of file otbShiftScaleSampleListFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef itk::SmartPointer<const Self> otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::ConstPointer

Definition at line 58 of file otbShiftScaleSampleListFilter.h.

◆ InputMeasurementVectorType

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef InputSampleListType::MeasurementVectorType otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::InputMeasurementVectorType

Definition at line 70 of file otbShiftScaleSampleListFilter.h.

◆ InputSampleListConstPointer

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef InputSampleListType::ConstPointer otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::InputSampleListConstPointer

Definition at line 69 of file otbShiftScaleSampleListFilter.h.

◆ InputSampleListPointer

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef InputSampleListType::Pointer otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::InputSampleListPointer

Definition at line 68 of file otbShiftScaleSampleListFilter.h.

◆ InputSampleListType

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef TInputSampleList otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::InputSampleListType

InputSampleList typedefs

Definition at line 64 of file otbShiftScaleSampleListFilter.h.

◆ InputValueType

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef InputMeasurementVectorType::ValueType otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::InputValueType

Definition at line 71 of file otbShiftScaleSampleListFilter.h.

◆ OutputMeasurementVectorType

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef OutputSampleListType::MeasurementVectorType otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::OutputMeasurementVectorType

Definition at line 77 of file otbShiftScaleSampleListFilter.h.

◆ OutputSampleListConstPointer

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef OutputSampleListType::ConstPointer otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::OutputSampleListConstPointer

Definition at line 76 of file otbShiftScaleSampleListFilter.h.

◆ OutputSampleListPointer

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef OutputSampleListType::Pointer otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::OutputSampleListPointer

Definition at line 75 of file otbShiftScaleSampleListFilter.h.

◆ OutputSampleListType

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef TOutputSampleList otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::OutputSampleListType

OutputSampleList typedefs

Definition at line 74 of file otbShiftScaleSampleListFilter.h.

◆ OutputValueType

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef OutputMeasurementVectorType::ValueType otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::OutputValueType

Definition at line 78 of file otbShiftScaleSampleListFilter.h.

◆ Pointer

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef itk::SmartPointer<Self> otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::Pointer

Definition at line 57 of file otbShiftScaleSampleListFilter.h.

◆ Self

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef ShiftScaleSampleListFilter otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::Self

Standard class typedefs

Definition at line 55 of file otbShiftScaleSampleListFilter.h.

◆ Superclass

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
typedef otb::Statistics::ListSampleToListSampleFilter<TInputSampleList, TOutputSampleList> otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::Superclass

Definition at line 56 of file otbShiftScaleSampleListFilter.h.

Constructor & Destructor Documentation

◆ ShiftScaleSampleListFilter() [1/2]

template<class TInputSampleList , class TOutputSampleList >
otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::ShiftScaleSampleListFilter
protected

The vector of Shifts

Definition at line 33 of file otbShiftScaleSampleListFilter.hxx.

◆ ~ShiftScaleSampleListFilter()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::~ShiftScaleSampleListFilter ( )
inlineoverrideprotected

The vector of Shifts

Definition at line 95 of file otbShiftScaleSampleListFilter.h.

◆ ShiftScaleSampleListFilter() [2/2]

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::ShiftScaleSampleListFilter ( const Self &  )
privatedelete

The vector of Shifts

Member Function Documentation

◆ CreateAnother()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
virtual::itk::LightObject::Pointer otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::CreateAnother ( void  ) const

◆ GenerateData()

template<class TInputSampleList , class TOutputSampleList >
void otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::GenerateData
overrideprotected

This method causes the filter to generate its output.

Definition at line 38 of file otbShiftScaleSampleListFilter.hxx.

◆ GetNameOfClass()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
virtual const char* otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetScales()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
virtual InputMeasurementVectorType otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::GetScales ( )
virtual

The vector of Shifts

◆ GetShifts()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
virtual InputMeasurementVectorType otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::GetShifts ( )
virtual

The vector of Shifts

◆ New()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
static Pointer otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
void otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::operator= ( const Self &  )
privatedelete

The vector of Shifts

◆ PrintSelf()

template<class TInputSampleList , class TOutputSampleList >
void otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

The vector of Shifts

Definition at line 101 of file otbShiftScaleSampleListFilter.hxx.

◆ SetScales()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
virtual void otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::SetScales ( InputMeasurementVectorType  _arg)
virtual

Set/Get the Scales for this sample list

◆ SetShifts()

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
virtual void otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::SetShifts ( InputMeasurementVectorType  _arg)
virtual

Set/Get the Shifts for this sample list

Member Data Documentation

◆ m_Scales

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
InputMeasurementVectorType otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::m_Scales
private

The vector of Scales

Definition at line 108 of file otbShiftScaleSampleListFilter.h.

◆ m_Shifts

template<class TInputSampleList , class TOutputSampleList = TInputSampleList>
InputMeasurementVectorType otb::Statistics::ShiftScaleSampleListFilter< TInputSampleList, TOutputSampleList >::m_Shifts
private

The vector of Shifts

Definition at line 105 of file otbShiftScaleSampleListFilter.h.

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