OTB  7.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <otbSpectralAngleDistanceImageFilter.h>

+ Inheritance diagram for otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputImageType::ConstPointer InputImageConstPointerType
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef SpectralAngleDistanceImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual const InputPixelTypeGetReferencePixel () const
 
virtual void SetReferencePixel (InputPixelType _arg)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 SpectralAngleDistanceImageFilter ()
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 ~SpectralAngleDistanceImageFilter () override
 

Private Member Functions

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

Private Attributes

InputPixelType m_ReferencePixel
 

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >

This filter implements the computation of the spectral angle distance with respect to a reference pixel.

Deprecated:

Spectral angle distance is an efficient way to convert spectral information to scalar data with respect to a reference pixel. The spectral angle distance is defined as:

\[SA = cos^{-1}\Big(\frac{{\sum_{b=1}^{n_{b}}}r(b)\cdot p(b)}{\sqrt{{\sum_{b=1}^{n_{b}}}r(b)^{2}{\sum_{b=1}^{n_{b}}p(b)^{2}}}}\Big) \]

with $b$ being the spectral band, $r$ the reference pixel and $p$ the current pixel.

Since the spectral angle deals with multi-bands image, the InputImage pixels are supposed to support the [] operator, and the input image to support the GetNumberOfComponentsPerPixel() method.

See also
VectorImage

This filter is implemented as a multithreaded filter.

Definition at line 55 of file otbSpectralAngleDistanceImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<const Self> otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::ConstPointer

Definition at line 62 of file otbSpectralAngleDistanceImageFilter.h.

◆ InputImageConstPointerType

template<class TInputImage , class TOutputImage >
typedef InputImageType::ConstPointer otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::InputImageConstPointerType

Definition at line 72 of file otbSpectralAngleDistanceImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Definition at line 73 of file otbSpectralAngleDistanceImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage >
typedef TInputImage otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::InputImageType

Template parameters typedefs

Definition at line 68 of file otbSpectralAngleDistanceImageFilter.h.

◆ InputPixelType

template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 74 of file otbSpectralAngleDistanceImageFilter.h.

◆ OutputImagePointerType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::OutputImagePointerType

Definition at line 76 of file otbSpectralAngleDistanceImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 77 of file otbSpectralAngleDistanceImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage >
typedef TOutputImage otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 75 of file otbSpectralAngleDistanceImageFilter.h.

◆ OutputPixelType

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 78 of file otbSpectralAngleDistanceImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >
typedef itk::SmartPointer<Self> otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 61 of file otbSpectralAngleDistanceImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >
typedef SpectralAngleDistanceImageFilter otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::Self

Standard typedefs

Definition at line 59 of file otbSpectralAngleDistanceImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 60 of file otbSpectralAngleDistanceImageFilter.h.

Constructor & Destructor Documentation

◆ SpectralAngleDistanceImageFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::SpectralAngleDistanceImageFilter ( )
protected

Constructor

◆ ~SpectralAngleDistanceImageFilter()

template<class TInputImage , class TOutputImage >
otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::~SpectralAngleDistanceImageFilter ( )
inlineoverrideprotected

Destructor

Definition at line 90 of file otbSpectralAngleDistanceImageFilter.h.

◆ SpectralAngleDistanceImageFilter() [2/2]

template<class TInputImage , class TOutputImage >
otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::SpectralAngleDistanceImageFilter ( const Self )
privatedelete

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
overrideprotected

◆ CreateAnother()

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::CreateAnother ( void  ) const

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >
virtual const char* otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Creation through object factory macro

◆ GetReferencePixel()

template<class TInputImage , class TOutputImage >
virtual const InputPixelType& otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::GetReferencePixel ( ) const
virtual

Get/Set the reference pixel

◆ New()

template<class TInputImage , class TOutputImage >
static Pointer otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::New ( )
static

Type macro

◆ operator=()

template<class TInputImage , class TOutputImage >
void otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::operator= ( const Self )
privatedelete

◆ PrintSelf()

template<class TInputImage , class TOutputImage >
void otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

PrintSelf method

◆ SetReferencePixel()

template<class TInputImage , class TOutputImage >
virtual void otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::SetReferencePixel ( InputPixelType  _arg)
virtual

Get/Set the reference pixel

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage >
void otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

SpectralAngleDistanceImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Member Data Documentation

◆ m_ReferencePixel

template<class TInputImage , class TOutputImage >
InputPixelType otb::SpectralAngleDistanceImageFilter< TInputImage, TOutputImage >::m_ReferencePixel
private

The reference pixel

Definition at line 116 of file otbSpectralAngleDistanceImageFilter.h.


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