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

#include <otbVectorImageToIntensityImageFilter.h>

+ Inheritance diagram for otb::VectorImageToIntensityImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for otb::VectorImageToIntensityImageFilter< 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 VectorImageToIntensityImageFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

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

Private Member Functions

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

Detailed Description

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

This filter implements the computation of the mean of the spectral values of each pixel.

The spectral mean is defined as:

\[ SM = \frac{1}{n_{b}} \times \sum_{b=1}^{n_{b}}p(b) \]

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

Since the spectral mean 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 52 of file otbVectorImageToIntensityImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 59 of file otbVectorImageToIntensityImageFilter.h.

◆ InputImageConstPointerType

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

Definition at line 69 of file otbVectorImageToIntensityImageFilter.h.

◆ InputImageRegionType

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

Definition at line 70 of file otbVectorImageToIntensityImageFilter.h.

◆ InputImageType

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

Template parameters typedefs

Definition at line 65 of file otbVectorImageToIntensityImageFilter.h.

◆ InputPixelType

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

Definition at line 71 of file otbVectorImageToIntensityImageFilter.h.

◆ OutputImagePointerType

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

Definition at line 73 of file otbVectorImageToIntensityImageFilter.h.

◆ OutputImageRegionType

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

Definition at line 74 of file otbVectorImageToIntensityImageFilter.h.

◆ OutputImageType

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

Definition at line 72 of file otbVectorImageToIntensityImageFilter.h.

◆ OutputPixelType

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

Definition at line 75 of file otbVectorImageToIntensityImageFilter.h.

◆ Pointer

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

Definition at line 58 of file otbVectorImageToIntensityImageFilter.h.

◆ Self

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

Standard typedefs

Definition at line 56 of file otbVectorImageToIntensityImageFilter.h.

◆ Superclass

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

Definition at line 57 of file otbVectorImageToIntensityImageFilter.h.

Constructor & Destructor Documentation

◆ VectorImageToIntensityImageFilter() [1/2]

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

Constructor

◆ ~VectorImageToIntensityImageFilter()

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

Destructor

Definition at line 82 of file otbVectorImageToIntensityImageFilter.h.

◆ VectorImageToIntensityImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetNameOfClass()

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

Creation through object factory macro

◆ New()

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

Type macro

◆ operator=()

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

◆ PrintSelf()

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

PrintSelf method

◆ ThreadedGenerateData()

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

VectorImageToIntensityImageFilter 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()

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