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 | Private Attributes | List of all members
otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference

Implements multi channel R and G and NIR pixel-wise generic index operation on one vector image. More...

#include <otbMultiChannelRAndGAndNIRIndexImageFilter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TFunction FunctorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
MultiChannelRAndGAndNIRIndexImageFilter 
Self
 
typedef
itk::UnaryFunctorImageFilter
< TInputImage, TOutputImage,
TFunction > 
Superclass
 
- Public Types inherited from itk::UnaryFunctorImageFilter< TInputImage, 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 TInputImage InputImageType
 
typedef TInputImage 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
< TInputImage, TOutputImage > 
Superclass
 
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual unsigned int GetGreenIndex ()
 
unsigned int GetIndex (BandName::BandName band) const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNIRIndex ()
 
virtual unsigned int GetRedIndex ()
 
virtual void SetGreenIndex (unsigned int _arg)
 
void SetIndex (BandName::BandName band, unsigned int channel)
 
virtual void SetNIRIndex (unsigned int _arg)
 
virtual void SetRedIndex (unsigned int _arg)
 
- Public Member Functions inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const FunctorTypeGetFunctor () const
 
FunctorTypeGetFunctor ()
 
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< TInputImage, 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

 MultiChannelRAndGAndNIRIndexImageFilter ()
 Constructor. More...
 
virtual ~MultiChannelRAndGAndNIRIndexImageFilter ()
 Destructor. More...
 
virtual void BeforeThreadedGenerateData ()
 Before generating data, set functor parameters. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 PrintSelf. More...
 
- Protected Member Functions inherited from itk::UnaryFunctorImageFilter< TInputImage, 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

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

Private Attributes

unsigned int m_GreenIndex
 
unsigned int m_NIRIndex
 
unsigned int m_RedIndex
 

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
class otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >

Implements multi channel R and G and NIR pixel-wise generic index operation on one vector image.

This class is parameterized over the type of the input image and the type of the output image. It is also parameterized by the operation to be applied, using a Functor style.

See Also
UnaryFunctorImageFilter

Definition at line 43 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
typedef itk::SmartPointer<const Self> otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::ConstPointer

Definition at line 51 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
typedef TFunction otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType

Some typedefs.

Definition at line 57 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
typedef itk::SmartPointer<Self> otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::Pointer

Definition at line 50 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
typedef MultiChannelRAndGAndNIRIndexImageFilter otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 48 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
typedef itk::UnaryFunctorImageFilter<TInputImage, TOutputImage, TFunction> otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Definition at line 49 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::MultiChannelRAndGAndNIRIndexImageFilter ( )
inlineprotected

Constructor.

Definition at line 107 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::~MultiChannelRAndGAndNIRIndexImageFilter ( )
inlineprotectedvirtual

Destructor.

Definition at line 109 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::MultiChannelRAndGAndNIRIndexImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual void otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::BeforeThreadedGenerateData ( void  )
inlineprotectedvirtual

Before generating data, set functor parameters.

Definition at line 111 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual::itk::LightObject::Pointer otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::CreateAnother ( void  ) const
template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual unsigned int otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::GetGreenIndex ( )
virtual
template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
unsigned int otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::GetIndex ( BandName::BandName  band) const
inline

Get index, generic method

Definition at line 89 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

References otb::BandName::GREEN, otb::BandName::NIR, and otb::BandName::RED.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual const char* otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual unsigned int otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::GetNIRIndex ( )
virtual
template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual unsigned int otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::GetRedIndex ( )
virtual
template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
static Pointer otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
void otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::operator= ( const Self )
private
template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
void otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
inlineprotected

PrintSelf.

Definition at line 125 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual void otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::SetGreenIndex ( unsigned int  _arg)
virtual

Set/Get the green channel index. Value must be in [1...[

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
void otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::SetIndex ( BandName::BandName  band,
unsigned int  channel 
)
inline

Set index, generic method

Definition at line 73 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

References otb::BandName::GREEN, otb::BandName::NIR, and otb::BandName::RED.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual void otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::SetNIRIndex ( unsigned int  _arg)
virtual

Set/Get the nir channel index. Value must be in [1...[

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
virtual void otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::SetRedIndex ( unsigned int  _arg)
virtual

Set/Get the red channel index. Value must be in [1...[

Member Data Documentation

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
unsigned int otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::m_GreenIndex
private

Green channel index

Definition at line 140 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
unsigned int otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::m_NIRIndex
private

NIR channel index

Definition at line 142 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.

template<class TInputImage , class TOutputImage , class TFunction = Functor::AVI<typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TInputImage::InternalPixelType, typename TOutputImage::PixelType>>
unsigned int otb::MultiChannelRAndGAndNIRIndexImageFilter< TInputImage, TOutputImage, TFunction >::m_RedIndex
private

Red channel index

Definition at line 138 of file otbMultiChannelRAndGAndNIRIndexImageFilter.h.


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