OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::LocalHistogramImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <otbLocalHistogramImageFunction.h>

+ Inheritance diagram for otb::LocalHistogramImageFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for otb::LocalHistogramImageFunction< TInputImage, TCoordRep >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::ContinuousIndexType ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef HistogramType::Pointer HistogramPointer
 
typedef itk::Statistics::Histogram< typename TInputImage::PixelType > HistogramType
 
typedef Superclass::IndexType IndexType
 
typedef TInputImage InputImageType
 
typedef Superclass::OutputType OutputType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef LocalHistogramImageFunction Self
 
typedef itk::ImageFunction< TInputImage, typename itk::Statistics::Histogram< typename TInputImage::PixelType >::Pointer, TCoordRep > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension
 
unsigned int m_NeighborhoodRadius
 
unsigned long m_NumberOfHistogramBins
 
double m_HistogramMin
 
double m_HistogramMax
 
bool m_GaussianSmoothing
 
OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
virtual void SetNeighborhoodRadius (unsigned int _arg)
 
virtual const unsigned int & GetNeighborhoodRadius () const
 
virtual void SetNumberOfHistogramBins (unsigned long _arg)
 
virtual unsigned long GetNumberOfHistogramBins () const
 
virtual void SetHistogramMin (double _arg)
 
virtual const double & GetHistogramMin () const
 
virtual void SetHistogramMax (double _arg)
 
virtual const double & GetHistogramMax () const
 
virtual void SetGaussianSmoothing (bool _arg)
 
virtual const bool & GetGaussianSmoothing () const
 
virtual void GaussianSmoothingOn ()
 
virtual void GaussianSmoothingOff ()
 
 LocalHistogramImageFunction ()
 
 ~LocalHistogramImageFunction () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 LocalHistogramImageFunction (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage, class TCoordRep = double>
class otb::LocalHistogramImageFunction< TInputImage, TCoordRep >

Calculate a local histogram over a specified circular neighborhood.

This image function computes the local histogram of the pixels lying in a circular neighborhood around the given position.

Pixel count can be optionally weighted by a gaussian kernel with $ \sigma = 0.5 radius $ so that pixel far from the center position account less in the histogram than pixel near the center position. This option can be deactivated using the GaussianSmoothing flag.

Histogram mininimum value, maximum value and number of bins can be set using the Setters/Getters.

This class is templated over the input image type and the coordinate representation type (e.g. float or double).

Definition at line 55 of file otbLocalHistogramImageFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TCoordRep = double>
typedef itk::SmartPointer<const Self> otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 63 of file otbLocalHistogramImageFunction.h.

◆ ContinuousIndexType

template<class TInputImage , class TCoordRep = double>
typedef Superclass::ContinuousIndexType otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

Definition at line 74 of file otbLocalHistogramImageFunction.h.

◆ CoordRepType

template<class TInputImage , class TCoordRep = double>
typedef TCoordRep otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::CoordRepType

Definition at line 81 of file otbLocalHistogramImageFunction.h.

◆ HistogramPointer

template<class TInputImage , class TCoordRep = double>
typedef HistogramType::Pointer otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::HistogramPointer

Definition at line 79 of file otbLocalHistogramImageFunction.h.

◆ HistogramType

template<class TInputImage , class TCoordRep = double>
typedef itk::Statistics::Histogram<typename TInputImage::PixelType> otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::HistogramType

Definition at line 78 of file otbLocalHistogramImageFunction.h.

◆ IndexType

template<class TInputImage , class TCoordRep = double>
typedef Superclass::IndexType otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::IndexType

Definition at line 73 of file otbLocalHistogramImageFunction.h.

◆ InputImageType

template<class TInputImage , class TCoordRep = double>
typedef TInputImage otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 69 of file otbLocalHistogramImageFunction.h.

◆ OutputType

template<class TInputImage , class TCoordRep = double>
typedef Superclass::OutputType otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::OutputType

Definition at line 77 of file otbLocalHistogramImageFunction.h.

◆ Pointer

template<class TInputImage , class TCoordRep = double>
typedef itk::SmartPointer<Self> otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 62 of file otbLocalHistogramImageFunction.h.

◆ PointType

template<class TInputImage , class TCoordRep = double>
typedef Superclass::PointType otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::PointType

Definition at line 75 of file otbLocalHistogramImageFunction.h.

◆ Self

template<class TInputImage , class TCoordRep = double>
typedef LocalHistogramImageFunction otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 60 of file otbLocalHistogramImageFunction.h.

◆ Superclass

template<class TInputImage , class TCoordRep = double>
typedef itk::ImageFunction<TInputImage, typename itk::Statistics::Histogram<typename TInputImage::PixelType>::Pointer, TCoordRep> otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::Superclass

Definition at line 61 of file otbLocalHistogramImageFunction.h.

Constructor & Destructor Documentation

◆ LocalHistogramImageFunction() [1/2]

template<class TInputImage , class TCoordRep >
otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::LocalHistogramImageFunction
protected

Constructor

Definition at line 36 of file otbLocalHistogramImageFunction.hxx.

◆ ~LocalHistogramImageFunction()

template<class TInputImage , class TCoordRep = double>
otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::~LocalHistogramImageFunction ( )
inlineoverrideprotected

Evaluate the function at non-integer positions

Definition at line 128 of file otbLocalHistogramImageFunction.h.

◆ LocalHistogramImageFunction() [2/2]

template<class TInputImage , class TCoordRep = double>
otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::LocalHistogramImageFunction ( const Self )
privatedelete

Evaluate the function at non-integer positions

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TCoordRep = double>
virtual::itk::LightObject::Pointer otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::CreateAnother ( void  ) const

◆ Evaluate()

template<class TInputImage , class TCoordRep = double>
OutputType otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
inlineoverride

Evaluate the function at non-integer positions

Definition at line 90 of file otbLocalHistogramImageFunction.h.

◆ EvaluateAtContinuousIndex()

template<class TInputImage , class TCoordRep = double>
OutputType otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType cindex) const
inlineoverride

Evaluate the function at non-integer positions

Definition at line 96 of file otbLocalHistogramImageFunction.h.

◆ EvaluateAtIndex()

template<class TInputImage , class TCoordRep >
LocalHistogramImageFunction< TInputImage, TCoordRep >::OutputType otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
override

Evalulate the function at specified index

Definition at line 53 of file otbLocalHistogramImageFunction.hxx.

References otb::CONST_2PI.

◆ GaussianSmoothingOff()

template<class TInputImage , class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GaussianSmoothingOff ( )
virtual

Evaluate the function at non-integer positions

◆ GaussianSmoothingOn()

template<class TInputImage , class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GaussianSmoothingOn ( )
virtual

Evaluate the function at non-integer positions

◆ GetGaussianSmoothing()

template<class TInputImage , class TCoordRep = double>
virtual const bool& otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetGaussianSmoothing ( ) const
virtual

Evaluate the function at non-integer positions

◆ GetHistogramMax()

template<class TInputImage , class TCoordRep = double>
virtual const double& otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetHistogramMax ( ) const
virtual

Evaluate the function at non-integer positions

◆ GetHistogramMin()

template<class TInputImage , class TCoordRep = double>
virtual const double& otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetHistogramMin ( ) const
virtual

Evaluate the function at non-integer positions

◆ GetNameOfClass()

template<class TInputImage , class TCoordRep = double>
virtual const char* otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetNeighborhoodRadius()

template<class TInputImage , class TCoordRep = double>
virtual const unsigned int& otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetNeighborhoodRadius ( ) const
virtual

Evaluate the function at non-integer positions

◆ GetNumberOfHistogramBins()

template<class TInputImage , class TCoordRep = double>
virtual unsigned long otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetNumberOfHistogramBins ( ) const
virtual

Evaluate the function at non-integer positions

◆ New()

template<class TInputImage , class TCoordRep = double>
static Pointer otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TCoordRep = double>
void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::operator= ( const Self )
privatedelete

Evaluate the function at non-integer positions

◆ PrintSelf()

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

Evaluate the function at non-integer positions

Definition at line 42 of file otbLocalHistogramImageFunction.hxx.

◆ SetGaussianSmoothing()

template<class TInputImage , class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::SetGaussianSmoothing ( bool  _arg)
virtual

Evaluate the function at non-integer positions

◆ SetHistogramMax()

template<class TInputImage , class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::SetHistogramMax ( double  _arg)
virtual

Evaluate the function at non-integer positions

◆ SetHistogramMin()

template<class TInputImage , class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::SetHistogramMin ( double  _arg)
virtual

Evaluate the function at non-integer positions

◆ SetNeighborhoodRadius()

template<class TInputImage , class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::SetNeighborhoodRadius ( unsigned int  _arg)
virtual

Get/Set the radius of the neighborhood over which the statistics are evaluated

◆ SetNumberOfHistogramBins()

template<class TInputImage , class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::SetNumberOfHistogramBins ( unsigned long  _arg)
virtual

Set/Get the number of histogram bins. Default is 128.

Member Data Documentation

◆ ImageDimension

template<class TInputImage , class TCoordRep = double>
const unsigned int otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::ImageDimension = InputImageType::ImageDimension
static

Dimension of the underlying image.

Definition at line 84 of file otbLocalHistogramImageFunction.h.

◆ m_GaussianSmoothing

template<class TInputImage , class TCoordRep = double>
bool otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::m_GaussianSmoothing
private

Evaluate the function at non-integer positions

Definition at line 141 of file otbLocalHistogramImageFunction.h.

◆ m_HistogramMax

template<class TInputImage , class TCoordRep = double>
double otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::m_HistogramMax
private

Evaluate the function at non-integer positions

Definition at line 140 of file otbLocalHistogramImageFunction.h.

◆ m_HistogramMin

template<class TInputImage , class TCoordRep = double>
double otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::m_HistogramMin
private

Evaluate the function at non-integer positions

Definition at line 139 of file otbLocalHistogramImageFunction.h.

◆ m_NeighborhoodRadius

template<class TInputImage , class TCoordRep = double>
unsigned int otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::m_NeighborhoodRadius
private

Evaluate the function at non-integer positions

Definition at line 137 of file otbLocalHistogramImageFunction.h.

◆ m_NumberOfHistogramBins

template<class TInputImage , class TCoordRep = double>
unsigned long otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::m_NumberOfHistogramBins
private

Evaluate the function at non-integer positions

Definition at line 138 of file otbLocalHistogramImageFunction.h.


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