#include <otbComputeHistoFilter.h>

Inheritance diagram for otb::ComputeHistoFilter< TInputImage, TOutputImage >:

Collaboration diagram for otb::ComputeHistoFilter< TInputImage, TOutputImage >:

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

typedef InputImageType::IndexType	IndexType

typedef TInputImage	InputImageType

typedef InputImageType::InternalPixelType	InputPixelType

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef itk::SmartPointer< Self >	Pointer

typedef ComputeHistoFilter	Self

typedef InputImageType::SizeType	SizeType

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

std::vector< typename OutputImageType::PixelType >	m_HistoThread

InputPixelType	m_Min

InputPixelType	m_Max

InputPixelType	m_NoData

SizeType	m_ThumbSize {0,0}

bool	m_NoDataFlag

double	m_Step

float	m_Threshold

unsigned int	m_NbBin

unsigned int	m_ValidThreads

virtual void	SetNbBin (unsigned int _arg)

virtual unsigned int	GetNbBin ()

virtual void	SetMin (InputPixelType _arg)

virtual InputPixelType	GetMin ()

virtual void	SetMax (InputPixelType _arg)

virtual InputPixelType	GetMax ()

virtual void	SetNoData (InputPixelType _arg)

virtual InputPixelType	GetNoData ()

virtual void	NoDataFlagOn ()

virtual void	NoDataFlagOff ()

virtual bool	GetNoDataFlag ()

virtual void	SetNoDataFlag (bool _arg)

virtual void	SetThumbSize (SizeType _arg)

virtual SizeType	GetThumbSize ()

virtual void	SetThreshold (float _arg)

virtual float	GetThreshold ()

OutputImageType::Pointer	GetHistoOutput ()

virtual itk::ProcessObject::DataObjectPointer	MakeOutput (itk::ProcessObject::DataObjectPointerArraySizeType idx) override

virtual itk::ProcessObject::DataObjectPointer	MakeOutput (const itk::ProcessObject::DataObjectIdentifierType &) override

	ComputeHistoFilter ()

	~ComputeHistoFilter () override

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

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

void	GenerateData () override

void	BeforeThreadedGenerateData () override

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

void	AfterThreadedGenerateData () override

void	GenerateOutputRequestedRegion (itk::DataObject *output) override

	ComputeHistoFilter (const Self &)=delete

void	operator= (const Self &)=delete

void	SetRequestedRegion (itk::ImageBase< 2 > *image)

void	ApplyThreshold (typename itk::ImageRegionIterator< OutputImageType > oit, unsigned int total)

Detailed Description

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

Compute local histogram with several parameters.

This class implements the first part of the CLAHE algorithm. It aims to compute local histogram with several input parameters such as nodata value, threshold, thumbnail size and number of bin. Mandatory parameters are min and max value as it will be used in the histogram computation.

Definition at line 43 of file otbComputeHistoFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage >

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

Definition at line 54 of file otbComputeHistoFilter.h.

◆ IndexType

template<class TInputImage , class TOutputImage >

typedef InputImageType::IndexType otb::ComputeHistoFilter< TInputImage, TOutputImage >::IndexType

Definition at line 57 of file otbComputeHistoFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage >

typedef TInputImage otb::ComputeHistoFilter< TInputImage, TOutputImage >::InputImageType

typedef for standard classes.

Definition at line 48 of file otbComputeHistoFilter.h.

◆ InputPixelType

template<class TInputImage , class TOutputImage >

typedef InputImageType::InternalPixelType otb::ComputeHistoFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 56 of file otbComputeHistoFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType otb::ComputeHistoFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 59 of file otbComputeHistoFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage >

typedef TOutputImage otb::ComputeHistoFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 49 of file otbComputeHistoFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage >

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

Definition at line 53 of file otbComputeHistoFilter.h.

◆ Self

template<class TInputImage , class TOutputImage >

typedef ComputeHistoFilter otb::ComputeHistoFilter< TInputImage, TOutputImage >::Self

Definition at line 51 of file otbComputeHistoFilter.h.

◆ SizeType

template<class TInputImage , class TOutputImage >

typedef InputImageType::SizeType otb::ComputeHistoFilter< TInputImage, TOutputImage >::SizeType

Definition at line 58 of file otbComputeHistoFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >

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

Definition at line 52 of file otbComputeHistoFilter.h.

Constructor & Destructor Documentation

◆ ComputeHistoFilter() [1/2]

template<class TInputImage , class TOutputImage >

otb::ComputeHistoFilter< TInputImage, TOutputImage >::ComputeHistoFilter

protected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 32 of file otbComputeHistoFilter.hxx.

◆ ~ComputeHistoFilter()

template<class TInputImage , class TOutputImage >

otb::ComputeHistoFilter< TInputImage, TOutputImage >::~ComputeHistoFilter ( )

inlineoverrideprotected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 112 of file otbComputeHistoFilter.h.

◆ ComputeHistoFilter() [2/2]

template<class TInputImage , class TOutputImage >

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

privatedelete

Get/Set macro to get/set the number of bin. Default value is 256

Member Function Documentation

◆ AfterThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::ComputeHistoFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData

overrideprotected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 227 of file otbComputeHistoFilter.hxx.

◆ ApplyThreshold()

template<class TInputImage , class TOutputImage >

void otb::ComputeHistoFilter< TInputImage, TOutputImage >::ApplyThreshold	(	typename itk::ImageRegionIterator< OutputImageType >	oit,
		unsigned int	total
	)

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 258 of file otbComputeHistoFilter.hxx.

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage >

void otb::ComputeHistoFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData

overrideprotected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 165 of file otbComputeHistoFilter.hxx.

◆ CreateAnother()

template<class TInputImage , class TOutputImage >

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

◆ GenerateData()

template<class TInputImage , class TOutputImage >

void otb::ComputeHistoFilter< TInputImage, TOutputImage >::GenerateData

overrideprotected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 141 of file otbComputeHistoFilter.hxx.

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage >

void otb::ComputeHistoFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion

overrideprotected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 76 of file otbComputeHistoFilter.hxx.

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage >

void otb::ComputeHistoFilter< TInputImage, TOutputImage >::GenerateOutputInformation

overrideprotected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 87 of file otbComputeHistoFilter.hxx.

◆ GenerateOutputRequestedRegion()

template<class TInputImage , class TOutputImage >

void otb::ComputeHistoFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion ( itk::DataObject * output )

overrideprotected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 130 of file otbComputeHistoFilter.hxx.

◆ GetHistoOutput()

template<class TInputImage , class TOutputImage >

TOutputImage::Pointer otb::ComputeHistoFilter< TInputImage, TOutputImage >::GetHistoOutput

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 286 of file otbComputeHistoFilter.hxx.

◆ GetMax()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ GetMin()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage >

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

virtual

Run-time type information (and related methods).

◆ GetNbBin()

template<class TInputImage , class TOutputImage >

virtual unsigned int otb::ComputeHistoFilter< TInputImage, TOutputImage >::GetNbBin ( )

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ GetNoData()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ GetNoDataFlag()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ GetThreshold()

template<class TInputImage , class TOutputImage >

virtual float otb::ComputeHistoFilter< TInputImage, TOutputImage >::GetThreshold ( )

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ GetThumbSize()

template<class TInputImage , class TOutputImage >

virtual SizeType otb::ComputeHistoFilter< TInputImage, TOutputImage >::GetThumbSize ( )

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ MakeOutput() [1/2]

template<class TInputImage , class TOutputImage >

itk::ProcessObject::DataObjectPointer otb::ComputeHistoFilter< TInputImage, TOutputImage >::MakeOutput ( const itk::ProcessObject::DataObjectIdentifierType & name )

overridevirtual

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 70 of file otbComputeHistoFilter.hxx.

◆ MakeOutput() [2/2]

template<class TInputImage , class TOutputImage >

itk::ProcessObject::DataObjectPointer otb::ComputeHistoFilter< TInputImage, TOutputImage >::MakeOutput ( itk::ProcessObject::DataObjectPointerArraySizeType idx )

overridevirtual

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 49 of file otbComputeHistoFilter.hxx.

◆ New()

template<class TInputImage , class TOutputImage >

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

static

Method for creation through the object factory.

◆ NoDataFlagOff()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ NoDataFlagOn()

template<class TInputImage , class TOutputImage >

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

virtual

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

◆ operator=()

template<class TInputImage , class TOutputImage >

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

privatedelete

Get/Set macro to get/set the number of bin. Default value is 256

◆ PrintSelf()

template<class TInputImage , class TOutputImage >

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

overrideprotected

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 315 of file otbComputeHistoFilter.hxx.

◆ SetMax()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the maximum value

◆ SetMin()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the minimum value

◆ SetNbBin()

template<class TInputImage , class TOutputImage >

virtual void otb::ComputeHistoFilter< TInputImage, TOutputImage >::SetNbBin ( unsigned int _arg )

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ SetNoData()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the nodata value

◆ SetNoDataFlag()

template<class TInputImage , class TOutputImage >

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

virtual

Get/Set macro to get/set the number of bin. Default value is 256

◆ SetRequestedRegion()

template<class TInputImage , class TOutputImage >

void otb::ComputeHistoFilter< TInputImage, TOutputImage >::SetRequestedRegion ( itk::ImageBase< 2 > * image )

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 294 of file otbComputeHistoFilter.hxx.

◆ SetThreshold()

template<class TInputImage , class TOutputImage >

virtual void otb::ComputeHistoFilter< TInputImage, TOutputImage >::SetThreshold ( float _arg )

virtual

Get/Set macro to get/set the threshold parameter

◆ SetThumbSize()

template<class TInputImage , class TOutputImage >

virtual void otb::ComputeHistoFilter< TInputImage, TOutputImage >::SetThumbSize ( SizeType _arg )

virtual

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

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage >

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

overrideprotectedvirtual

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 183 of file otbComputeHistoFilter.hxx.

Member Data Documentation

◆ m_HistoThread

template<class TInputImage , class TOutputImage >

std::vector<typename OutputImageType::PixelType> otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_HistoThread

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 141 of file otbComputeHistoFilter.h.

◆ m_Max

template<class TInputImage , class TOutputImage >

InputPixelType otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_Max

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 143 of file otbComputeHistoFilter.h.

◆ m_Min

template<class TInputImage , class TOutputImage >

InputPixelType otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_Min

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 142 of file otbComputeHistoFilter.h.

◆ m_NbBin

template<class TInputImage , class TOutputImage >

unsigned int otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_NbBin

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 149 of file otbComputeHistoFilter.h.

◆ m_NoData

template<class TInputImage , class TOutputImage >

InputPixelType otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_NoData

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 144 of file otbComputeHistoFilter.h.

◆ m_NoDataFlag

template<class TInputImage , class TOutputImage >

bool otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_NoDataFlag

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 146 of file otbComputeHistoFilter.h.

◆ m_Step

template<class TInputImage , class TOutputImage >

double otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_Step

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 147 of file otbComputeHistoFilter.h.

◆ m_Threshold

template<class TInputImage , class TOutputImage >

float otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_Threshold

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 148 of file otbComputeHistoFilter.h.

◆ m_ThumbSize

template<class TInputImage , class TOutputImage >

SizeType otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_ThumbSize {0,0}

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 145 of file otbComputeHistoFilter.h.

◆ m_ValidThreads

template<class TInputImage , class TOutputImage >

unsigned int otb::ComputeHistoFilter< TInputImage, TOutputImage >::m_ValidThreads

private

Get/Set macro to get/set the number of bin. Default value is 256

Definition at line 150 of file otbComputeHistoFilter.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 TOutputImage> class otb::ComputeHistoFilter< TInputImage, TOutputImage >

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ InputImageType

◆ InputPixelType

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ ComputeHistoFilter() [1/2]

◆ ~ComputeHistoFilter()

◆ ComputeHistoFilter() [2/2]

Member Function Documentation

◆ AfterThreadedGenerateData()

◆ ApplyThreshold()

◆ BeforeThreadedGenerateData()

◆ CreateAnother()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GenerateOutputRequestedRegion()

◆ GetHistoOutput()

◆ GetMax()

◆ GetMin()

◆ GetNameOfClass()

◆ GetNbBin()

◆ GetNoData()

◆ GetNoDataFlag()

◆ GetThreshold()

◆ GetThumbSize()

◆ MakeOutput() [1/2]

◆ MakeOutput() [2/2]

◆ New()

◆ NoDataFlagOff()

◆ NoDataFlagOn()

◆ operator=()

◆ PrintSelf()

◆ SetMax()

◆ SetMin()

◆ SetNbBin()

◆ SetNoData()

◆ SetNoDataFlag()

◆ SetRequestedRegion()

◆ SetThreshold()

◆ SetThumbSize()

◆ ThreadedGenerateData()

Member Data Documentation

◆ m_HistoThread

◆ m_Max

◆ m_Min

◆ m_NbBin

◆ m_NoData

◆ m_NoDataFlag

◆ m_Step

◆ m_Threshold

◆ m_ThumbSize

◆ m_ValidThreads

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