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

#include <otbWaterSqrtSpectralAngleImageFilter.h>

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

Public Member Functions

 WaterSqrtSpectralAngleFunctor ()
 
virtual ~WaterSqrtSpectralAngleFunctor ()=default
 
void SetReferenceWaterPixel (PixelType ref)
 
TOutput operator() (PixelType const &inPix) const override
 
void SetBlueChannel (unsigned int channel)
 
unsigned int GetBlueChannel () const
 
void SetGreenChannel (unsigned int channel)
 
unsigned int GetGreenChannel () const
 
void SetRedChannel (unsigned int channel)
 
unsigned int GetRedChannel () const
 
void SetNIRChannel (unsigned int channel)
 
unsigned int GetNIRChannel () const
 
- Public Member Functions inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
 RadiometricIndex (const std::set< BandNameType > &requiredBands)
 
virtual ~RadiometricIndex ()=default
 
std::set< BandNameTypeGetRequiredBands () const
 
void SetBandIndex (BandNameType band, vcl_size_t index)
 
void SetBandsIndices (const std::map< BandNameType, vcl_size_t > &indicesMap)
 
vcl_size_t GetBandIndex (BandNameType band) const
 
virtual TOutput operator() (const itk::VariableLengthVector< TInput > &input) const =0
 

Private Attributes

PixelType m_ReferencePixel
 
double m_RefNorm
 

Additional Inherited Members

- Public Types inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
using BandNameType = CommonBandNames
 
using InputType = TInput
 
using OutputType = TOutput
 
using PixelType = itk::VariableLengthVector< InputType >
 
- Static Public Attributes inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
static constexpr double Epsilon = 0.0000001
 
static constexpr vcl_size_t NumberOfBands = static_cast<vcl_size_t>(BandNameType::MAX)
 
- Protected Member Functions inherited from otb::Functor::RadiometricIndex< TInput, TOutput >
vcl_size_t UncheckedBandIndex (BandNameType band) const
 
double Value (BandNameType band, const itk::VariableLengthVector< TInput > &input) const
 

Detailed Description

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

This functor uses a spectral angle with a particular reference pixel.

Definition at line 43 of file otbWaterSqrtSpectralAngleImageFilter.h.

Constructor & Destructor Documentation

◆ WaterSqrtSpectralAngleFunctor()

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

Definition at line 48 of file otbWaterSqrtSpectralAngleImageFilter.h.

◆ ~WaterSqrtSpectralAngleFunctor()

template<class TInput , class TOutput >
virtual otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::~WaterSqrtSpectralAngleFunctor ( )
virtualdefault

Member Function Documentation

◆ GetBlueChannel()

template<class TInput , class TOutput >
unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::GetBlueChannel ( ) const
inline

Set Reference Pixel

Parameters
ref: The new reference pixel, the band indices will be used.

Definition at line 99 of file otbWaterSqrtSpectralAngleImageFilter.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::GetBandIndex().

◆ GetGreenChannel()

template<class TInput , class TOutput >
unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::GetGreenChannel ( ) const
inline

Set Reference Pixel

Parameters
ref: The new reference pixel, the band indices will be used.

Definition at line 107 of file otbWaterSqrtSpectralAngleImageFilter.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::GetBandIndex().

◆ GetNIRChannel()

template<class TInput , class TOutput >
unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::GetNIRChannel ( ) const
inline

Set Reference Pixel

Parameters
ref: The new reference pixel, the band indices will be used.

Definition at line 123 of file otbWaterSqrtSpectralAngleImageFilter.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::GetBandIndex().

◆ GetRedChannel()

template<class TInput , class TOutput >
unsigned int otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::GetRedChannel ( ) const
inline

Set Reference Pixel

Parameters
ref: The new reference pixel, the band indices will be used.

Definition at line 115 of file otbWaterSqrtSpectralAngleImageFilter.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::GetBandIndex().

◆ operator()()

template<class TInput , class TOutput >
TOutput otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::operator() ( PixelType const &  inPix) const
inlineoverride

◆ SetBlueChannel()

template<class TInput , class TOutput >
void otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::SetBlueChannel ( unsigned int  channel)
inline

Legacy getters and setters (use SetBandIndex/GetBandIndex instead)

Deprecated:

Definition at line 95 of file otbWaterSqrtSpectralAngleImageFilter.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::SetBandIndex().

◆ SetGreenChannel()

template<class TInput , class TOutput >
void otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::SetGreenChannel ( unsigned int  channel)
inline

Set Reference Pixel

Parameters
ref: The new reference pixel, the band indices will be used.

Definition at line 103 of file otbWaterSqrtSpectralAngleImageFilter.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::SetBandIndex().

◆ SetNIRChannel()

template<class TInput , class TOutput >
void otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::SetNIRChannel ( unsigned int  channel)
inline

Set Reference Pixel

Parameters
ref: The new reference pixel, the band indices will be used.

Definition at line 119 of file otbWaterSqrtSpectralAngleImageFilter.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::SetBandIndex().

◆ SetRedChannel()

template<class TInput , class TOutput >
void otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::SetRedChannel ( unsigned int  channel)
inline

Set Reference Pixel

Parameters
ref: The new reference pixel, the band indices will be used.

Definition at line 111 of file otbWaterSqrtSpectralAngleImageFilter.h.

References otb::Functor::RadiometricIndex< TInput, TOutput >::SetBandIndex().

◆ SetReferenceWaterPixel()

template<class TInput , class TOutput >
void otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::SetReferenceWaterPixel ( PixelType  ref)
inline

Member Data Documentation

◆ m_ReferencePixel

template<class TInput , class TOutput >
PixelType otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::m_ReferencePixel
private

◆ m_RefNorm

template<class TInput , class TOutput >
double otb::Functor::WaterSqrtSpectralAngleFunctor< TInput, TOutput >::m_RefNorm
private

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