#include <otbApplyGainFilter.h>

Inheritance diagram for otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >:

Collaboration diagram for otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

typedef TInputImage	InputImageType

typedef InputImageType::InternalPixelType	InputPixelType

typedef TLut	LutType

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef OutputImageType::InternalPixelType	OutputPixelType

typedef itk::SmartPointer< Self >	Pointer

typedef ApplyGainFilter	Self

typedef itk::ImageToImageFilter< InputImageType, OutputImageType >	Superclass

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

virtual const char *	GetNameOfClass () const

Static Public Member Functions
static Pointer	New ()

InputPixelType	m_NoData

InputPixelType	m_Min

InputPixelType	m_Max

bool	m_NoDataFlag

bool	m_ThumbSizeFromSpacing

double	m_Step

LutType::SizeType	m_LutSize {0,0}

InputImageType::SizeType	m_ThumbSize {0,0}

virtual void	SetNoData (InputPixelType _arg)

virtual InputPixelType	GetNoData ()

virtual void	NoDataFlagOn ()

virtual void	NoDataFlagOff ()

virtual bool	GetNoDataFlag ()

virtual void	SetNoDataFlag (bool _arg)

virtual void	ThumbSizeFromSpacingOn ()

virtual void	ThumbSizeFromSpacingOff ()

virtual bool	GetThumbSizeFromSpacing ()

virtual void	SetThumbSizeFromSpacing (bool _arg)

virtual void	SetThumbSize (typename InputImageType::SizeType _arg)

virtual InputImageType::SizeType	GetThumbSize ()

virtual void	SetMin (InputPixelType _arg)

virtual InputPixelType	GetMin ()

virtual void	SetMax (InputPixelType _arg)

virtual InputPixelType	GetMax ()

void	SetInputLut (const LutType *lut)

void	SetInputImage (const InputImageType *input)

	ApplyGainFilter ()

	~ApplyGainFilter () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

const InputImageType *	GetInputImage () const

const LutType *	GetInputLut () const

void	GenerateInputRequestedRegion () override

void	BeforeThreadedGenerateData () override

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override

void	VerifyInputInformation () override

	ApplyGainFilter (const Self &)=delete

void	operator= (const Self &)=delete

double	InterpolateGain (typename LutType::ConstPointer gridLut, unsigned int pixelValue, typename InputImageType::IndexType index)

Detailed Description

template<class TInputImage, class TLut, class TOutputImage>
class otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >

Apply gain on the input image with a bilineare interpolation.

This class implements the third part of the CLAHE algorithm. It's aim is to apply the computed gain with a bilineare interpolation. The gain is in a look up table, and the minimum and maximum asked by the filter should be the same as the one used to compute those look up table.

Definition at line 42 of file otbApplyGainFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TLut , class TOutputImage >

typedef itk::SmartPointer<const Self> otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::ConstPointer

Definition at line 53 of file otbApplyGainFilter.h.

◆ InputImageType

template<class TInputImage , class TLut , class TOutputImage >

typedef TInputImage otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::InputImageType

typedef for standard classes.

Definition at line 47 of file otbApplyGainFilter.h.

◆ InputPixelType

template<class TInputImage , class TLut , class TOutputImage >

typedef InputImageType::InternalPixelType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::InputPixelType

Definition at line 56 of file otbApplyGainFilter.h.

◆ LutType

template<class TInputImage , class TLut , class TOutputImage >

typedef TLut otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::LutType

Definition at line 55 of file otbApplyGainFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TLut , class TOutputImage >

typedef OutputImageType::RegionType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::OutputImageRegionType

Definition at line 58 of file otbApplyGainFilter.h.

◆ OutputImageType

template<class TInputImage , class TLut , class TOutputImage >

typedef TOutputImage otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::OutputImageType

Definition at line 48 of file otbApplyGainFilter.h.

◆ OutputPixelType

template<class TInputImage , class TLut , class TOutputImage >

typedef OutputImageType::InternalPixelType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::OutputPixelType

Definition at line 57 of file otbApplyGainFilter.h.

◆ Pointer

template<class TInputImage , class TLut , class TOutputImage >

typedef itk::SmartPointer<Self> otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::Pointer

Definition at line 52 of file otbApplyGainFilter.h.

◆ Self

template<class TInputImage , class TLut , class TOutputImage >

typedef ApplyGainFilter otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::Self

Definition at line 50 of file otbApplyGainFilter.h.

◆ Superclass

template<class TInputImage , class TLut , class TOutputImage >

typedef itk::ImageToImageFilter<InputImageType, OutputImageType> otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::Superclass

Definition at line 51 of file otbApplyGainFilter.h.

Constructor & Destructor Documentation

◆ ApplyGainFilter() [1/2]

template<class TInputImage , class TLut , class TOutputImage >

otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::ApplyGainFilter

protected

Get/Set macro to get/set the nodata value

Definition at line 34 of file otbApplyGainFilter.hxx.

◆ ~ApplyGainFilter()

template<class TInputImage , class TLut , class TOutputImage >

otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::~ApplyGainFilter ( )

inlineoverrideprotected

Get/Set macro to get/set the nodata value

Definition at line 106 of file otbApplyGainFilter.h.

◆ ApplyGainFilter() [2/2]

template<class TInputImage , class TLut , class TOutputImage >

otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::ApplyGainFilter ( const Self & )

privatedelete

Get/Set macro to get/set the nodata value

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TLut , class TOutputImage >

void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::BeforeThreadedGenerateData

overrideprotected

Get/Set macro to get/set the nodata value

Definition at line 87 of file otbApplyGainFilter.hxx.

◆ CreateAnother()

template<class TInputImage , class TLut , class TOutputImage >

virtual::itk::LightObject::Pointer otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::CreateAnother ( void ) const

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TLut , class TOutputImage >

void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GenerateInputRequestedRegion

overrideprotected

Get/Set macro to get/set the nodata value

Definition at line 72 of file otbApplyGainFilter.hxx.

◆ GetInputImage()

template<class TInputImage , class TLut , class TOutputImage >

const TInputImage * otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetInputImage

protected

Get the input image

Definition at line 53 of file otbApplyGainFilter.hxx.

◆ GetInputLut()

template<class TInputImage , class TLut , class TOutputImage >

const TLut * otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetInputLut

protected

Get the input look up table

Definition at line 66 of file otbApplyGainFilter.hxx.

◆ GetMax()

template<class TInputImage , class TLut , class TOutputImage >

virtual InputPixelType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetMax ( )

virtual

Get/Set macro to get/set the nodata value

◆ GetMin()

template<class TInputImage , class TLut , class TOutputImage >

virtual InputPixelType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetMin ( )

virtual

Get/Set macro to get/set the nodata value

◆ GetNameOfClass()

template<class TInputImage , class TLut , class TOutputImage >

virtual const char* otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

◆ GetNoData()

template<class TInputImage , class TLut , class TOutputImage >

virtual InputPixelType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetNoData ( )

virtual

Get/Set macro to get/set the nodata value

◆ GetNoDataFlag()

template<class TInputImage , class TLut , class TOutputImage >

virtual bool otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetNoDataFlag ( )

virtual

Get/Set macro to get/set the nodata value

◆ GetThumbSize()

template<class TInputImage , class TLut , class TOutputImage >

virtual InputImageType::SizeType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetThumbSize ( )

virtual

Get/Set macro to get/set the nodata value

◆ GetThumbSizeFromSpacing()

template<class TInputImage , class TLut , class TOutputImage >

virtual bool otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::GetThumbSizeFromSpacing ( )

virtual

Get/Set macro to get/set the nodata value

◆ InterpolateGain()

template<class TInputImage , class TLut , class TOutputImage >

double otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::InterpolateGain	(	typename LutType::ConstPointer	gridLut,
		unsigned int	pixelValue,
		typename InputImageType::IndexType	index
	)

private

Bilinear interpolation of the gain between the different window.

Definition at line 138 of file otbApplyGainFilter.hxx.

◆ New()

template<class TInputImage , class TLut , class TOutputImage >

static Pointer otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ NoDataFlagOff()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::NoDataFlagOff ( )

virtual

Get/Set macro to get/set the nodata value

◆ NoDataFlagOn()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::NoDataFlagOn ( )

virtual

Get/Set macro to get/set the nodata flag value

◆ operator=()

template<class TInputImage , class TLut , class TOutputImage >

void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::operator= ( const Self & )

privatedelete

Get/Set macro to get/set the nodata value

◆ PrintSelf()

template<class TInputImage , class TLut , class TOutputImage >

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

overrideprotected

Standard "PrintSelf" method

Definition at line 183 of file otbApplyGainFilter.hxx.

◆ SetInputImage()

template<class TInputImage , class TLut , class TOutputImage >

void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::SetInputImage ( const InputImageType * input )

Set the input image

Definition at line 46 of file otbApplyGainFilter.hxx.

◆ SetInputLut()

template<class TInputImage , class TLut , class TOutputImage >

void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::SetInputLut ( const LutType * lut )

Set the input look up table

Definition at line 59 of file otbApplyGainFilter.hxx.

◆ SetMax()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::SetMax ( InputPixelType _arg )

virtual

Get/Set macro to get/set the maximum value

◆ SetMin()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::SetMin ( InputPixelType _arg )

virtual

Get/Set macro to get/set the minimum value

◆ SetNoData()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::SetNoData ( InputPixelType _arg )

virtual

Get/Set macro to get/set the nodata value

◆ SetNoDataFlag()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::SetNoDataFlag ( bool _arg )

virtual

Get/Set macro to get/set the nodata value

◆ SetThumbSize()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::SetThumbSize ( typename InputImageType::SizeType _arg )

virtual

Get/Set macro to get/set the thumbnail's size

◆ SetThumbSizeFromSpacing()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::SetThumbSizeFromSpacing ( bool _arg )

virtual

Get/Set macro to get/set the nodata value

◆ ThreadedGenerateData()

template<class TInputImage , class TLut , class TOutputImage >

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

overrideprotected

Get/Set macro to get/set the nodata value

Definition at line 100 of file otbApplyGainFilter.hxx.

◆ ThumbSizeFromSpacingOff()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::ThumbSizeFromSpacingOff ( )

virtual

Get/Set macro to get/set the nodata value

◆ ThumbSizeFromSpacingOn()

template<class TInputImage , class TLut , class TOutputImage >

virtual void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::ThumbSizeFromSpacingOn ( )

virtual

Get/Set macro to get/set the ThumbSizeFromSpacing flag value

◆ VerifyInputInformation()

template<class TInputImage , class TLut , class TOutputImage >

void otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::VerifyInputInformation ( )

inlineoverrideprotected

Get/Set macro to get/set the nodata value

Definition at line 122 of file otbApplyGainFilter.h.

Member Data Documentation

◆ m_LutSize

template<class TInputImage , class TLut , class TOutputImage >

LutType::SizeType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::m_LutSize {0,0}

private

Get/Set macro to get/set the nodata value

Definition at line 137 of file otbApplyGainFilter.h.

◆ m_Max

template<class TInputImage , class TLut , class TOutputImage >

InputPixelType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::m_Max

private

Get/Set macro to get/set the nodata value

Definition at line 133 of file otbApplyGainFilter.h.

◆ m_Min

template<class TInputImage , class TLut , class TOutputImage >

InputPixelType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::m_Min

private

Get/Set macro to get/set the nodata value

Definition at line 132 of file otbApplyGainFilter.h.

◆ m_NoData

template<class TInputImage , class TLut , class TOutputImage >

InputPixelType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::m_NoData

private

Get/Set macro to get/set the nodata value

Definition at line 131 of file otbApplyGainFilter.h.

◆ m_NoDataFlag

template<class TInputImage , class TLut , class TOutputImage >

bool otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::m_NoDataFlag

private

Get/Set macro to get/set the nodata value

Definition at line 134 of file otbApplyGainFilter.h.

◆ m_Step

template<class TInputImage , class TLut , class TOutputImage >

double otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::m_Step

private

Get/Set macro to get/set the nodata value

Definition at line 136 of file otbApplyGainFilter.h.

◆ m_ThumbSize

template<class TInputImage , class TLut , class TOutputImage >

InputImageType::SizeType otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::m_ThumbSize {0,0}

private

Get/Set macro to get/set the nodata value

Definition at line 138 of file otbApplyGainFilter.h.

◆ m_ThumbSizeFromSpacing

template<class TInputImage , class TLut , class TOutputImage >

bool otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >::m_ThumbSizeFromSpacing

private

Get/Set macro to get/set the nodata value

Definition at line 135 of file otbApplyGainFilter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

template<class TInputImage, class TLut, class TOutputImage> class otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >

Member Typedef Documentation

◆ ConstPointer

◆ InputImageType

◆ InputPixelType

◆ LutType

◆ OutputImageRegionType

◆ OutputImageType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ApplyGainFilter() [1/2]

◆ ~ApplyGainFilter()

◆ ApplyGainFilter() [2/2]

Member Function Documentation

◆ BeforeThreadedGenerateData()

◆ CreateAnother()

◆ GenerateInputRequestedRegion()

◆ GetInputImage()

◆ GetInputLut()

◆ GetMax()

◆ GetMin()

◆ GetNameOfClass()

◆ GetNoData()

◆ GetNoDataFlag()

◆ GetThumbSize()

◆ GetThumbSizeFromSpacing()

◆ InterpolateGain()

◆ New()

◆ NoDataFlagOff()

◆ NoDataFlagOn()

◆ operator=()

◆ PrintSelf()

◆ SetInputImage()

◆ SetInputLut()

◆ SetMax()

◆ SetMin()

◆ SetNoData()

◆ SetNoDataFlag()

◆ SetThumbSize()

◆ SetThumbSizeFromSpacing()

◆ ThreadedGenerateData()

◆ ThumbSizeFromSpacingOff()

◆ ThumbSizeFromSpacingOn()

◆ VerifyInputInformation()

Member Data Documentation

◆ m_LutSize

◆ m_Max

◆ m_Min

◆ m_NoData

◆ m_NoDataFlag

◆ m_Step

◆ m_ThumbSize

◆ m_ThumbSizeFromSpacing

template<class TInputImage, class TLut, class TOutputImage>
class otb::ApplyGainFilter< TInputImage, TLut, TOutputImage >