Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction > Class Template Reference

Compute a radiometric water indice. More...

#include <otbWaterSqrtSpectralAngleImageFilter.h>

+ Inheritance diagram for otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >:
+ Collaboration diagram for otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TInputVectorImage InputVectorImageType
 
typedef
InputVectorImageType::PixelType 
InputVectorPixelType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
WaterSqrtSpectralAngleImageFilter 
Self
 
typedef
itk::UnaryFunctorImageFilter
< TInputVectorImage,
TOutputImage, TFunction > 
Superclass
 
- Public Types inherited from itk::UnaryFunctorImageFilter< TInputVectorImage, TOutputImage, TFunction >
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef TFunction FunctorType
 
typedef TFunction FunctorType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef
InputImageType::ConstPointer 
InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputVectorImage InputImageType
 
typedef TInputVectorImage InputImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< SelfPointer
 
typedef UnaryFunctorImageFilter Self
 
typedef UnaryFunctorImageFilter Self
 
typedef InPlaceImageFilter
< TInputVectorImage,
TOutputImage > 
Superclass
 
typedef InPlaceImageFilter
< TInputVectorImage,
TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::UnaryFunctorImageFilter< TInputVectorImage, TOutputImage, TFunction >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
void SetFunctor (const FunctorType &functor)
 
void SetFunctor (const FunctorType &functor)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::UnaryFunctorImageFilter< TInputVectorImage, TOutputImage, TFunction >
static Pointer New ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Protected Member Functions

 WaterSqrtSpectralAngleImageFilter ()
 
virtual ~WaterSqrtSpectralAngleImageFilter ()
 
- Protected Member Functions inherited from itk::UnaryFunctorImageFilter< TInputVectorImage, TOutputImage, TFunction >
 UnaryFunctorImageFilter ()
 
 UnaryFunctorImageFilter ()
 
virtual ~UnaryFunctorImageFilter ()
 
virtual ~UnaryFunctorImageFilter ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputInformation ()
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 

Private Member Functions

 WaterSqrtSpectralAngleImageFilter (Self &)
 
void operator= (const Self &)
 

Detailed Description

template<class TInputVectorImage, class TOutputImage, class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
class otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >

Compute a radiometric water indice.

This filter calculates a pixel wise water indice by calculating the spectral angle distance with a reference radiometry. This class is templated over the input multispectral image type, and the output image type. By default, the filter use the channel 0 as blue, the channel 1 as green, the channel 2 as red, and the channel 3 as near infrared. It can be changed with the SetBlue, SetGreen, SetRed and SetIR methods.

In the output image, value clse to zero denotes a highest probability of water.

See Also
SpectralAngleDistanceImageFilter

Definition at line 50 of file otbWaterSqrtSpectralAngleImageFilter.h.

Member Typedef Documentation

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
typedef itk::SmartPointer<const Self> otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::ConstPointer

Definition at line 58 of file otbWaterSqrtSpectralAngleImageFilter.h.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
typedef TInputVectorImage otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::InputVectorImageType

Some convenient typedef.

Definition at line 63 of file otbWaterSqrtSpectralAngleImageFilter.h.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
typedef InputVectorImageType::PixelType otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::InputVectorPixelType

Definition at line 67 of file otbWaterSqrtSpectralAngleImageFilter.h.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
typedef TOutputImage otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::OutputImageType

Definition at line 68 of file otbWaterSqrtSpectralAngleImageFilter.h.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
typedef itk::SmartPointer<Self> otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::Pointer

Definition at line 57 of file otbWaterSqrtSpectralAngleImageFilter.h.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
typedef WaterSqrtSpectralAngleImageFilter otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 55 of file otbWaterSqrtSpectralAngleImageFilter.h.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
typedef itk::UnaryFunctorImageFilter<TInputVectorImage, TOutputImage, TFunction> otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::Superclass

Definition at line 56 of file otbWaterSqrtSpectralAngleImageFilter.h.

Constructor & Destructor Documentation

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::WaterSqrtSpectralAngleImageFilter ( )
inlineprotected

Definition at line 71 of file otbWaterSqrtSpectralAngleImageFilter.h.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
virtual otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::~WaterSqrtSpectralAngleImageFilter ( )
inlineprotectedvirtual

Definition at line 72 of file otbWaterSqrtSpectralAngleImageFilter.h.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::WaterSqrtSpectralAngleImageFilter ( Self )
private

Member Function Documentation

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
virtual::itk::LightObject::Pointer otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::CreateAnother ( void  ) const
template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
virtual const char* otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::UnaryFunctorImageFilter< TInputVectorImage, TOutputImage, TFunction >.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
static Pointer otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::New ( )
static

Method for creation through the object factory.

template<class TInputVectorImage , class TOutputImage , class TFunction = Functor::WaterSqrtSpectralAngleFunctor < typename TInputVectorImage::PixelType, typename TOutputImage::PixelType>>
void otb::WaterSqrtSpectralAngleImageFilter< TInputVectorImage, TOutputImage, TFunction >::operator= ( const Self )
private

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