OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage > Class Template Reference
Group FeaturesExtraction » Module OTBContrast

#include <otbCLHistogramEqualizationFilter.h>

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

Public Types

typedef otb::ApplyGainFilter< InputImageType, LutType, OutputImageType > ApplyGainFilter
 
typedef otb::InPlacePassFilter< InputImageType > BufferFilter
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef otb::ComputeGainLutFilter< HistogramType, LutType > GainLutFilter
 
typedef otb::ComputeHistoFilter< InputImageType, HistogramType > HistoFilter
 
typedef otb::VectorImage< unsigned int, 2 > HistogramType
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef otb::VectorImage< double, 2 > LutType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef CLHistogramEqualizationFilter Self
 
typedef itk::StreamingImageFilter< LutType, LutType > StreamingImageFilter
 
typedef itk::ImageToImageFilter< InputImageType, OutputImageType > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual InputPixelType GetMax ()
 
virtual InputPixelType GetMin ()
 
virtual const char * GetNameOfClass () const
 
virtual unsigned long GetNbBin ()
 
virtual InputPixelType GetNoData ()
 
virtual bool GetNoDataFlag ()
 
virtual double GetThreshold ()
 
virtual InputImageType::SizeType GetThumbSize ()
 
void SetMax (InputPixelType max)
 
void SetMin (InputPixelType min)
 
void SetNbBin (unsigned long bin)
 
void SetNoData (InputPixelType n)
 
void SetNoDataFlag (bool flag)
 
void SetThreshold (double t)
 
void SetThumbSize (typename InputImageType::SizeType size)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 CLHistogramEqualizationFilter ()
 
void GenerateData () override
 
void PropagateRequestedRegion (itk::DataObject *output) override
 
void UpdateOutputInformation () override
 
 ~CLHistogramEqualizationFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Private Member Functions

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

Private Attributes

ApplyGainFilter::Pointer m_ApplyGainFilter
 
BufferFilter::Pointer m_BufferFilter
 
GainLutFilter::Pointer m_GainLutFilter
 
HistoFilter::Pointer m_HistoFilter
 
InputPixelType m_Max
 
InputPixelType m_Min
 
unsigned long m_NbBin
 
InputPixelType m_NoData
 
bool m_NoDataFlag
 
StreamingImageFilter::Pointer m_StreamingImageFilter
 
double m_Threshold
 
InputImageType::SizeType m_ThumbSize {0,0}
 

Detailed Description

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

Implement CLAHE algorithm.

This class implement CLAHE algorithm. It is a composite filter that gathers the 3 filters (ComputeHisto, ComputeGainLut, ApplyGain) and pipes them with additional filters (InPlacePass and StreamingImage) in order to make streaming available.

Definition at line 47 of file otbCLHistogramEqualizationFilter.h.

Member Typedef Documentation

◆ ApplyGainFilter

template<class TInputImage , class TOutputImage >
typedef otb::ApplyGainFilter<InputImageType, LutType, OutputImageType> otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::ApplyGainFilter

Definition at line 71 of file otbCLHistogramEqualizationFilter.h.

◆ BufferFilter

template<class TInputImage , class TOutputImage >
typedef otb::InPlacePassFilter<InputImageType> otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::BufferFilter

Definition at line 65 of file otbCLHistogramEqualizationFilter.h.

◆ ConstPointer

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

Definition at line 58 of file otbCLHistogramEqualizationFilter.h.

◆ GainLutFilter

template<class TInputImage , class TOutputImage >
typedef otb::ComputeGainLutFilter<HistogramType, LutType> otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GainLutFilter

Definition at line 69 of file otbCLHistogramEqualizationFilter.h.

◆ HistoFilter

template<class TInputImage , class TOutputImage >
typedef otb::ComputeHistoFilter<InputImageType, HistogramType> otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::HistoFilter

Definition at line 67 of file otbCLHistogramEqualizationFilter.h.

◆ HistogramType

template<class TInputImage , class TOutputImage >
typedef otb::VectorImage<unsigned int, 2> otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::HistogramType

Definition at line 60 of file otbCLHistogramEqualizationFilter.h.

◆ InputImageType

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

typedef for standard classes.

Definition at line 52 of file otbCLHistogramEqualizationFilter.h.

◆ InputPixelType

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

Definition at line 73 of file otbCLHistogramEqualizationFilter.h.

◆ LutType

template<class TInputImage , class TOutputImage >
typedef otb::VectorImage<double, 2> otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::LutType

Definition at line 61 of file otbCLHistogramEqualizationFilter.h.

◆ OutputImageRegionType

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

Definition at line 74 of file otbCLHistogramEqualizationFilter.h.

◆ OutputImageType

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

Definition at line 53 of file otbCLHistogramEqualizationFilter.h.

◆ Pointer

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

Definition at line 57 of file otbCLHistogramEqualizationFilter.h.

◆ Self

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

Definition at line 55 of file otbCLHistogramEqualizationFilter.h.

◆ StreamingImageFilter

template<class TInputImage , class TOutputImage >
typedef itk::StreamingImageFilter<LutType, LutType> otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::StreamingImageFilter

Definition at line 63 of file otbCLHistogramEqualizationFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage >
typedef itk::ImageToImageFilter<InputImageType, OutputImageType> otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::Superclass

Definition at line 56 of file otbCLHistogramEqualizationFilter.h.

Constructor & Destructor Documentation

◆ CLHistogramEqualizationFilter() [1/2]

template<class TInputImage , class TOutputImage >
otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::CLHistogramEqualizationFilter
protected

Definition at line 32 of file otbCLHistogramEqualizationFilter.hxx.

References otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_ApplyGainFilter, otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_BufferFilter, otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_GainLutFilter, otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_HistoFilter, otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_StreamingImageFilter, and otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_ThumbSize.

◆ ~CLHistogramEqualizationFilter()

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

Definition at line 148 of file otbCLHistogramEqualizationFilter.h.

◆ CLHistogramEqualizationFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateData()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GenerateData
overrideprotected

Definition at line 70 of file otbCLHistogramEqualizationFilter.hxx.

◆ GetMax()

template<class TInputImage , class TOutputImage >
virtual InputPixelType otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GetMax ( )
virtual

◆ GetMin()

template<class TInputImage , class TOutputImage >
virtual InputPixelType otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GetMin ( )
virtual

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GetNbBin()

template<class TInputImage , class TOutputImage >
virtual unsigned long otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GetNbBin ( )
virtual

◆ GetNoData()

template<class TInputImage , class TOutputImage >
virtual InputPixelType otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GetNoData ( )
virtual

◆ GetNoDataFlag()

template<class TInputImage , class TOutputImage >
virtual bool otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GetNoDataFlag ( )
virtual

◆ GetThreshold()

template<class TInputImage , class TOutputImage >
virtual double otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GetThreshold ( )
virtual

◆ GetThumbSize()

template<class TInputImage , class TOutputImage >
virtual InputImageType::SizeType otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::GetThumbSize ( )
virtual

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

◆ PrintSelf()

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

Standard "PrintSelf" method

Definition at line 81 of file otbCLHistogramEqualizationFilter.hxx.

◆ PropagateRequestedRegion()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::PropagateRequestedRegion ( itk::DataObject *  output)
overrideprotected

Definition at line 63 of file otbCLHistogramEqualizationFilter.hxx.

◆ SetMax()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::SetMax ( InputPixelType  max)
inline

Definition at line 93 of file otbCLHistogramEqualizationFilter.h.

◆ SetMin()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::SetMin ( InputPixelType  min)
inline

Definition at line 83 of file otbCLHistogramEqualizationFilter.h.

◆ SetNbBin()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::SetNbBin ( unsigned long  bin)
inline

Definition at line 103 of file otbCLHistogramEqualizationFilter.h.

◆ SetNoData()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::SetNoData ( InputPixelType  n)
inline

Definition at line 129 of file otbCLHistogramEqualizationFilter.h.

◆ SetNoDataFlag()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::SetNoDataFlag ( bool  flag)
inline

Definition at line 139 of file otbCLHistogramEqualizationFilter.h.

◆ SetThreshold()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::SetThreshold ( double  t)
inline

Definition at line 121 of file otbCLHistogramEqualizationFilter.h.

◆ SetThumbSize()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::SetThumbSize ( typename InputImageType::SizeType  size)
inline

Definition at line 111 of file otbCLHistogramEqualizationFilter.h.

◆ UpdateOutputInformation()

template<class TInputImage , class TOutputImage >
void otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::UpdateOutputInformation
overrideprotected

Definition at line 53 of file otbCLHistogramEqualizationFilter.hxx.

Member Data Documentation

◆ m_ApplyGainFilter

template<class TInputImage , class TOutputImage >
ApplyGainFilter::Pointer otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_ApplyGainFilter
private

Definition at line 166 of file otbCLHistogramEqualizationFilter.h.

Referenced by otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::CLHistogramEqualizationFilter().

◆ m_BufferFilter

template<class TInputImage , class TOutputImage >
BufferFilter::Pointer otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_BufferFilter
private

Definition at line 168 of file otbCLHistogramEqualizationFilter.h.

Referenced by otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::CLHistogramEqualizationFilter().

◆ m_GainLutFilter

template<class TInputImage , class TOutputImage >
GainLutFilter::Pointer otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_GainLutFilter
private

Definition at line 165 of file otbCLHistogramEqualizationFilter.h.

Referenced by otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::CLHistogramEqualizationFilter().

◆ m_HistoFilter

template<class TInputImage , class TOutputImage >
HistoFilter::Pointer otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_HistoFilter
private

Definition at line 164 of file otbCLHistogramEqualizationFilter.h.

Referenced by otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::CLHistogramEqualizationFilter().

◆ m_Max

template<class TInputImage , class TOutputImage >
InputPixelType otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_Max
private

Definition at line 169 of file otbCLHistogramEqualizationFilter.h.

◆ m_Min

template<class TInputImage , class TOutputImage >
InputPixelType otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_Min
private

Definition at line 169 of file otbCLHistogramEqualizationFilter.h.

◆ m_NbBin

template<class TInputImage , class TOutputImage >
unsigned long otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_NbBin
private

Definition at line 170 of file otbCLHistogramEqualizationFilter.h.

◆ m_NoData

template<class TInputImage , class TOutputImage >
InputPixelType otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_NoData
private

Definition at line 169 of file otbCLHistogramEqualizationFilter.h.

◆ m_NoDataFlag

template<class TInputImage , class TOutputImage >
bool otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_NoDataFlag
private

Definition at line 173 of file otbCLHistogramEqualizationFilter.h.

◆ m_StreamingImageFilter

template<class TInputImage , class TOutputImage >
StreamingImageFilter::Pointer otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_StreamingImageFilter
private

Definition at line 167 of file otbCLHistogramEqualizationFilter.h.

Referenced by otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::CLHistogramEqualizationFilter().

◆ m_Threshold

template<class TInputImage , class TOutputImage >
double otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_Threshold
private

Definition at line 172 of file otbCLHistogramEqualizationFilter.h.

◆ m_ThumbSize

template<class TInputImage , class TOutputImage >
InputImageType::SizeType otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::m_ThumbSize {0,0}
private

Definition at line 171 of file otbCLHistogramEqualizationFilter.h.

Referenced by otb::CLHistogramEqualizationFilter< TInputImage, TOutputImage >::CLHistogramEqualizationFilter().

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:24:56 for OTB with   doxygen 1.8.17