OTB  9.0.0
Orfeo Toolbox
Public Types | List of all members
otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction > Class Template Reference
Group Miscellaneous » Module OTBSimulation

#include <otbReduceSpectralResponseClassifierRAndNIR.h>

+ Inheritance diagram for otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >:
+ Collaboration diagram for otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef TFunction FunctorType
 
typedef TReduceSpectralResponse::Pointer InputReduceSpectralResponsePointerType
 
typedef TReduceSpectralResponse InputReduceSpectralResponseType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef ReduceSpectralResponseClassifierRAndNIR Self
 
typedef itk::DataObject Superclass
 
typedef InputReduceSpectralResponseType::ValuePrecisionType ValuePrecisionType
 
InputReduceSpectralResponsePointerType m_InputReduceSpectralResponse
 
unsigned int m_RBandNumber
 
unsigned int m_NIRBandNumber
 
FunctorType m_Functor
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual const InputReduceSpectralResponseType * GetInputReduceSpectralResponse () const
 
virtual void SetInputReduceSpectralResponse (InputReduceSpectralResponseType *_arg)
 
virtual unsigned int GetRBandNumber () const
 
virtual void SetRBandNumber (unsigned int _arg)
 
virtual unsigned int GetNIRBandNumber () const
 
virtual void SetNIRBandNumber (unsigned int _arg)
 
FunctorType & GetFunctor ()
 
void SetFunctor (const FunctorType &functor)
 
virtual bool Clear ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
ValuePrecisionType operator() ()
 
 ReduceSpectralResponseClassifierRAndNIR ()
 
 ~ReduceSpectralResponseClassifierRAndNIR () override
 
 ReduceSpectralResponseClassifierRAndNIR (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TReduceSpectralResponse, class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
class otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >

this class represents a hierarchy of vector data.

This class contains the spectral response from an object and the relative spectral response of a satellite (one response per band)

This class compute the reduce spectral response of each band of a sensor

The two templates indicate

The elements in the ReduceSpectralResponseClassifierRAndNIR have their coordinates in the projection specified by the Wkt string. This class also offer the possibility to store the coordinates directly into an image coordinate system, using the origin and spacing in a similar way as the corresponding image.

See also
itk::DataObject
SpectralResponse
SatelliteRSR

Definition at line 57 of file otbReduceSpectralResponseClassifierRAndNIR.h.

Member Typedef Documentation

◆ ConstPointer

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
typedef itk::SmartPointer<const Self> otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::ConstPointer

Definition at line 65 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ FunctorType

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
typedef TFunction otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::FunctorType

Definition at line 69 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ InputReduceSpectralResponsePointerType

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
typedef TReduceSpectralResponse::Pointer otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::InputReduceSpectralResponsePointerType

Definition at line 70 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ InputReduceSpectralResponseType

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
typedef TReduceSpectralResponse otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::InputReduceSpectralResponseType

Template parameters typedef

Definition at line 68 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ Pointer

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
typedef itk::SmartPointer<Self> otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::Pointer

Definition at line 64 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ Self

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
typedef ReduceSpectralResponseClassifierRAndNIR otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::Self

Standard class typedefs

Definition at line 62 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ Superclass

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
typedef itk::DataObject otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::Superclass

Definition at line 63 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ ValuePrecisionType

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
typedef InputReduceSpectralResponseType::ValuePrecisionType otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::ValuePrecisionType

Definition at line 71 of file otbReduceSpectralResponseClassifierRAndNIR.h.

Constructor & Destructor Documentation

◆ ReduceSpectralResponseClassifierRAndNIR() [1/2]

template<class TReduceSpectralResponse , class TFunction >
otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::ReduceSpectralResponseClassifierRAndNIR
protected

Constructor

Definition at line 32 of file otbReduceSpectralResponseClassifierRAndNIR.hxx.

◆ ~ReduceSpectralResponseClassifierRAndNIR()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::~ReduceSpectralResponseClassifierRAndNIR ( )
inlineoverrideprotected

Constructor from a ASCII file Destructor

Definition at line 132 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ ReduceSpectralResponseClassifierRAndNIR() [2/2]

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::ReduceSpectralResponseClassifierRAndNIR ( const Self &  )
privatedelete

PrintSelf method

Member Function Documentation

◆ Clear()

template<class TReduceSpectralResponse , class TFunction >
bool otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::Clear
virtual

Clear the vector data

Definition at line 38 of file otbReduceSpectralResponseClassifierRAndNIR.hxx.

◆ CreateAnother()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
virtual::itk::LightObject::Pointer otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::CreateAnother ( void  ) const

Input reduce spectral sensor model of response

◆ GetFunctor()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
FunctorType& otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::GetFunctor ( )
inline

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 92 of file otbReduceSpectralResponseClassifierRAndNIR.h.

References otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::m_Functor.

◆ GetInputReduceSpectralResponse()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
virtual const InputReduceSpectralResponseType* otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::GetInputReduceSpectralResponse ( ) const
virtual

Input reduce spectral sensor model of response

◆ GetNameOfClass()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
virtual const char* otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::GetNameOfClass ( ) const
virtual

Input reduce spectral sensor model of response

◆ GetNIRBandNumber()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
virtual unsigned int otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::GetNIRBandNumber ( ) const
virtual

Input reduce spectral sensor model of response

◆ GetRBandNumber()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
virtual unsigned int otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::GetRBandNumber ( ) const
virtual

Input reduce spectral sensor model of response

◆ New()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
static Pointer otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::New ( )
static

Standard macros

◆ operator()()

template<class TReduceSpectralResponse , class TFunction >
ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::ValuePrecisionType otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::operator()
inline
Parameters
ValuePrecisionType
Returns
the indice value.

Definition at line 46 of file otbReduceSpectralResponseClassifierRAndNIR.hxx.

◆ operator=()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
void otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::operator= ( const Self &  )
privatedelete

Input reduce spectral sensor model of response

◆ PrintSelf()

template<class TReduceSpectralResponse , class TFunction >
void otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
override

PrintSelf method

Definition at line 59 of file otbReduceSpectralResponseClassifierRAndNIR.hxx.

◆ SetFunctor()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
void otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::SetFunctor ( const FunctorType &  functor)
inline

Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator!=() be defined on the functor (or the compiler's default implementation of operator!=() being appropriate).

Definition at line 104 of file otbReduceSpectralResponseClassifierRAndNIR.h.

References otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::m_Functor.

◆ SetInputReduceSpectralResponse()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
virtual void otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::SetInputReduceSpectralResponse ( InputReduceSpectralResponseType *  _arg)
virtual

Input reduce spectral sensor model of response

◆ SetNIRBandNumber()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
virtual void otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::SetNIRBandNumber ( unsigned int  _arg)
virtual

Input reduce spectral sensor model of response

◆ SetRBandNumber()

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
virtual void otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::SetRBandNumber ( unsigned int  _arg)
virtual

Input reduce spectral sensor model of response

Member Data Documentation

◆ m_Functor

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
FunctorType otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::m_Functor
private

Indice classifier

Definition at line 151 of file otbReduceSpectralResponseClassifierRAndNIR.h.

Referenced by otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::GetFunctor(), and otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::SetFunctor().

◆ m_InputReduceSpectralResponse

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
InputReduceSpectralResponsePointerType otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::m_InputReduceSpectralResponse
private

Input reduce spectral sensor model of response

Definition at line 142 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ m_NIRBandNumber

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
unsigned int otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::m_NIRBandNumber
private

Number of the NIR band in the ReduceSpectralResponse vector

Definition at line 148 of file otbReduceSpectralResponseClassifierRAndNIR.h.

◆ m_RBandNumber

template<class TReduceSpectralResponse , class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
unsigned int otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::m_RBandNumber
private

Number of the red band in the ReduceSpectralResponse vector

Definition at line 145 of file otbReduceSpectralResponseClassifierRAndNIR.h.

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