OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction > Class Template Reference

#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< SelfPointer
 
typedef
ReduceSpectralResponseClassifierRAndNIR 
Self
 
typedef itk::DataObject Superclass
 
typedef
InputReduceSpectralResponseType::ValuePrecisionType 
ValuePrecisionType
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual bool Clear ()
 
virtual const
InputReduceSpectralResponseType
GetInputReduceSpectralResponse () const
 
virtual unsigned int GetNIRBandNumber () const
 
virtual unsigned int GetRBandNumber () const
 
ValuePrecisionType operator() ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void SetFunctor (const FunctorType &functor)
 
virtual void SetInputReduceSpectralResponse (InputReduceSpectralResponseType *_arg)
 
virtual void SetNIRBandNumber (unsigned int _arg)
 
virtual void SetRBandNumber (unsigned int _arg)
 
FunctorTypeGetFunctor ()
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 ReduceSpectralResponseClassifierRAndNIR ()
 
 ~ReduceSpectralResponseClassifierRAndNIR () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Private Attributes

FunctorType m_Functor
 
InputReduceSpectralResponsePointerType m_InputReduceSpectralResponse
 
unsigned int m_NIRBandNumber
 
unsigned int m_RBandNumber
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

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

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.

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.

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.

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.

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.

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.

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.

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

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

Constructor

Definition at line 33 of file otbReduceSpectralResponseClassifierRAndNIR.hxx.

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.

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

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

Clear the vector data

Definition at line 41 of file otbReduceSpectralResponseClassifierRAndNIR.hxx.

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

Standard macros

Reimplemented from itk::Object.

template<class TReduceSpectralResponse, class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
FunctorType& otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::GetFunctor ( void  )
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.

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

Standard macros

Reimplemented from itk::DataObject.

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

Standard macros

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

Definition at line 51 of file otbReduceSpectralResponseClassifierRAndNIR.hxx.

template<class TReduceSpectralResponse, class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
void otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::operator= ( const Self )
privatedelete
template<class TReduceSpectralResponse , class TFunction >
void otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overridevirtual

PrintSelf method

Reimplemented from itk::DataObject.

Definition at line 66 of file otbReduceSpectralResponseClassifierRAndNIR.hxx.

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.

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

Member Data Documentation

template<class TReduceSpectralResponse, class TFunction = Functor::NDVI<typename TReduceSpectralResponse::ValuePrecisionType, typename TReduceSpectralResponse::ValuePrecisionType>>
FunctorType otb::ReduceSpectralResponseClassifierRAndNIR< TReduceSpectralResponse, TFunction >::m_Functor
private
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.

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.

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: