otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference

#include <otbUnaryImageFunctorWithVectorImageFilter.h>

Inheritance diagram for otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >:

Collaboration diagram for otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef UnaryImageFunctorWithVectorImageFilter	Self
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage >	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

Static Public Member Functions
static Pointer	New ()
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef TFunction	FunctorType
typedef InputImageType::PixelType	InputPixelType
typedef InputImageType::InternalPixelType	InputInternalPixelType
typedef InputImageType::RegionType	InputImageRegionType
typedef OutputImageType::PixelType	OutputPixelType
typedef OutputImageType::InternalPixelType	OutputInternalPixelType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef InputImageType::SizeType	SizeType
typedef std::vector< FunctorType >	FunctorVectorType
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
FunctorVectorType	m_FunctorVector
virtual const char *	GetNameOfClass () const
FunctorVectorType &	GetFunctorVector (void)
	UnaryImageFunctorWithVectorImageFilter ()
	~UnaryImageFunctorWithVectorImageFilter () override
void	GenerateOutputInformation () override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction>
class otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >

Applies a functor to a VectorImage.

The aim of the class is to work with vector images but with a functor that uses as input a component of the pixel.

For N components pixel, an array of functor is defined and each is applied to the corresponding component of the output pixel.

Definition at line 46 of file otbUnaryImageFunctorWithVectorImageFilter.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage , class TFunction >

typedef itk::SmartPointer<const Self> otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::ConstPointer

Definition at line 54 of file otbUnaryImageFunctorWithVectorImageFilter.h.

FunctorType

template<class TInputImage , class TOutputImage , class TFunction >

typedef TFunction otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType

"typedef" to simplify the variables definition and the declaration.

Definition at line 67 of file otbUnaryImageFunctorWithVectorImageFilter.h.

FunctorVectorType

template<class TInputImage , class TOutputImage , class TFunction >

typedef std::vector<FunctorType> otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::FunctorVectorType

"typedef" to simplify the variables definition and the declaration.

Definition at line 80 of file otbUnaryImageFunctorWithVectorImageFilter.h.

InputImageRegionType

template<class TInputImage , class TOutputImage , class TFunction >

typedef InputImageType::RegionType otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageRegionType

"typedef" to simplify the variables definition and the declaration.

Definition at line 72 of file otbUnaryImageFunctorWithVectorImageFilter.h.

InputImageType

template<class TInputImage , class TOutputImage , class TFunction >

typedef TInputImage otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageType

"typedef" to simplify the variables definition and the declaration.

Definition at line 65 of file otbUnaryImageFunctorWithVectorImageFilter.h.

InputInternalPixelType

template<class TInputImage , class TOutputImage , class TFunction >

typedef InputImageType::InternalPixelType otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::InputInternalPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 71 of file otbUnaryImageFunctorWithVectorImageFilter.h.

InputPixelType

template<class TInputImage , class TOutputImage , class TFunction >

typedef InputImageType::PixelType otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::InputPixelType

Supported images definition.

Definition at line 70 of file otbUnaryImageFunctorWithVectorImageFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage , class TFunction >

typedef OutputImageType::RegionType otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageRegionType

"typedef" to simplify the variables definition and the declaration.

Definition at line 75 of file otbUnaryImageFunctorWithVectorImageFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage , class TFunction >

typedef TOutputImage otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageType

"typedef" to simplify the variables definition and the declaration.

Definition at line 66 of file otbUnaryImageFunctorWithVectorImageFilter.h.

OutputInternalPixelType

template<class TInputImage , class TOutputImage , class TFunction >

typedef OutputImageType::InternalPixelType otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::OutputInternalPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 74 of file otbUnaryImageFunctorWithVectorImageFilter.h.

OutputPixelType

template<class TInputImage , class TOutputImage , class TFunction >

typedef OutputImageType::PixelType otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::OutputPixelType

"typedef" to simplify the variables definition and the declaration.

Definition at line 73 of file otbUnaryImageFunctorWithVectorImageFilter.h.

Pointer

template<class TInputImage , class TOutputImage , class TFunction >

typedef itk::SmartPointer<Self> otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::Pointer

Definition at line 53 of file otbUnaryImageFunctorWithVectorImageFilter.h.

Self

template<class TInputImage , class TOutputImage , class TFunction >

typedef UnaryImageFunctorWithVectorImageFilter otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 51 of file otbUnaryImageFunctorWithVectorImageFilter.h.

SizeType

template<class TInputImage , class TOutputImage , class TFunction >

typedef InputImageType::SizeType otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::SizeType

Image size "typedef" definition.

Definition at line 78 of file otbUnaryImageFunctorWithVectorImageFilter.h.

Superclass

template<class TInputImage , class TOutputImage , class TFunction >

typedef itk::InPlaceImageFilter<TInputImage, TOutputImage> otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Definition at line 52 of file otbUnaryImageFunctorWithVectorImageFilter.h.

Constructor & Destructor Documentation

UnaryImageFunctorWithVectorImageFilter()

template<class TInputImage , class TOutputImage , class TFunction >

otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::UnaryImageFunctorWithVectorImageFilter

protected

Constructor

Definition at line 35 of file otbUnaryImageFunctorWithVectorImageFilter.hxx.

~UnaryImageFunctorWithVectorImageFilter()

template<class TInputImage , class TOutputImage , class TFunction >

otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::~UnaryImageFunctorWithVectorImageFilter ( )

inlineoverrideprotected

"typedef" to simplify the variables definition and the declaration.

Definition at line 93 of file otbUnaryImageFunctorWithVectorImageFilter.h.

Member Function Documentation

CreateAnother()

template<class TInputImage , class TOutputImage , class TFunction >

virtual::itk::LightObject::Pointer otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::CreateAnother

(

void

)

const

GenerateOutputInformation()

template<class TInputImage , class TOutputImage , class TFunction >

void otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::GenerateOutputInformation

overrideprotected

UnaryImageFunctorWithVectorImageFilter can produce an image which is a different resolution than its input image. As such, UnaryImageFunctorWithVectorImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also

ProcessObject::GenerateOutputInformation()

UnaryImageFunctorWithVectorImageFilter can produce an image which is a different resolution than its input image. As such, UnaryImageFunctorWithVectorImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also

ProcessObject::GenerateOutputInformation()

Definition at line 52 of file otbUnaryImageFunctorWithVectorImageFilter.hxx.

GetFunctorVector()

template<class TInputImage , class TOutputImage , class TFunction >

FunctorVectorType& otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctorVector ( void  )

inline

Get the functor list

Definition at line 86 of file otbUnaryImageFunctorWithVectorImageFilter.h.

GetNameOfClass()

template<class TInputImage , class TOutputImage , class TFunction >

virtual const char* otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::GetNameOfClass ( ) const

virtual

return class name.

New()

template<class TInputImage , class TOutputImage , class TFunction >

static Pointer otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<class TInputImage , class TOutputImage , class TFunction >

void otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

"typedef" to simplify the variables definition and the declaration.

Definition at line 123 of file otbUnaryImageFunctorWithVectorImageFilter.hxx.

ThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TFunction >

void otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, itk::ThreadIdType  threadId  )

overrideprotected

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

ThreadedGenerateData Performs the pixel-wise addition

Definition at line 80 of file otbUnaryImageFunctorWithVectorImageFilter.hxx.

Member Data Documentation

InputImageDimension

template<class TInputImage , class TOutputImage , class TFunction >

const unsigned int otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageDimension = TInputImage::ImageDimension

static

Extract input and output images dimensions.

Definition at line 60 of file otbUnaryImageFunctorWithVectorImageFilter.h.

m_FunctorVector

template<class TInputImage , class TOutputImage , class TFunction >

FunctorVectorType otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::m_FunctorVector

private

Ponderation declaration

Definition at line 123 of file otbUnaryImageFunctorWithVectorImageFilter.h.

OutputImageDimension

template<class TInputImage , class TOutputImage , class TFunction >

const unsigned int otb::UnaryImageFunctorWithVectorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageDimension = TOutputImage::ImageDimension

static

"typedef" to simplify the variables definition and the declaration.

Definition at line 61 of file otbUnaryImageFunctorWithVectorImageFilter.h.

---

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

• otbUnaryImageFunctorWithVectorImageFilter.h
• otbUnaryImageFunctorWithVectorImageFilter.hxx