OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private 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 Self
ConstPointer
 
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 Types inherited from itk::ImageFunction< TInputImage, itk::Statistics::Histogram< TInputImage::PixelType >::Pointer, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef
itk::Statistics::Histogram
< TInputImage::PixelType >
::Pointer 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, itk::Statistics::Histogram
< TInputImage::PixelType >
::Pointer
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::Statistics::Histogram< TInputImage::PixelType >::Pointer >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef
itk::Statistics::Histogram
< TInputImage::PixelType >
::Pointer 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
virtual void GaussianSmoothingOff ()
 
virtual void GaussianSmoothingOn ()
 
virtual const bool & GetGaussianSmoothing () const
 
virtual const double & GetHistogramMax () const
 
virtual const double & GetHistogramMin () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetGaussianSmoothing (bool _arg)
 
virtual void SetHistogramMax (double _arg)
 
virtual void SetHistogramMin (double _arg)
 
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
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, itk::Statistics::Histogram< TInputImage::PixelType >::Pointer, TCoordRep >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual
itk::Statistics::Histogram
< TInputImage::PixelType >
::Pointer 
Evaluate (const PointType &point) const override=0
 
virtual
itk::Statistics::Histogram
< TInputImage::PixelType >
::Pointer 
EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual
itk::Statistics::Histogram
< TInputImage::PixelType >
::Pointer 
EvaluateAtIndex (const IndexType &index) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual void SetInputImage (const InputImageType *ptr)
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::Statistics::Histogram< TInputImage::PixelType >::Pointer >
virtual OutputType Evaluate (const InputType &input) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, itk::Statistics::Histogram< TInputImage::PixelType >::Pointer, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

 LocalHistogramImageFunction ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~LocalHistogramImageFunction () override
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, itk::Statistics::Histogram< TInputImage::PixelType >::Pointer, TCoordRep >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::Statistics::Histogram< TInputImage::PixelType >::Pointer >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Private Attributes

bool m_GaussianSmoothing
 
double m_HistogramMax
 
double m_HistogramMin
 
unsigned int m_NeighborhoodRadius
 
unsigned long m_NumberOfHistogramBins
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, itk::Statistics::Histogram< TInputImage::PixelType >::Pointer, TCoordRep >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

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

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

Definition at line 67 of file otbLocalHistogramImageFunction.h.

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

Definition at line 78 of file otbLocalHistogramImageFunction.h.

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

Definition at line 85 of file otbLocalHistogramImageFunction.h.

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

Definition at line 83 of file otbLocalHistogramImageFunction.h.

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

Definition at line 82 of file otbLocalHistogramImageFunction.h.

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

Definition at line 77 of file otbLocalHistogramImageFunction.h.

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

InputImageType typedef support.

Definition at line 73 of file otbLocalHistogramImageFunction.h.

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

Definition at line 81 of file otbLocalHistogramImageFunction.h.

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

Definition at line 66 of file otbLocalHistogramImageFunction.h.

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

Definition at line 79 of file otbLocalHistogramImageFunction.h.

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

Standard class typedefs.

Definition at line 62 of file otbLocalHistogramImageFunction.h.

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 65 of file otbLocalHistogramImageFunction.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 37 of file otbLocalHistogramImageFunction.hxx.

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

Definition at line 134 of file otbLocalHistogramImageFunction.h.

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

Member Function Documentation

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

Reimplemented from itk::Object.

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 95 of file otbLocalHistogramImageFunction.h.

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 101 of file otbLocalHistogramImageFunction.h.

template<class TInputImage , class TCoordRep >
LocalHistogramImageFunction< TInputImage, TCoordRep >::OutputType otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
override
template<class TInputImage, class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GaussianSmoothingOff ( )
virtual
template<class TInputImage, class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GaussianSmoothingOn ( )
virtual
template<class TInputImage, class TCoordRep = double>
virtual const bool& otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetGaussianSmoothing ( ) const
virtual
template<class TInputImage, class TCoordRep = double>
virtual const double& otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetHistogramMax ( ) const
virtual
template<class TInputImage, class TCoordRep = double>
virtual const double& otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetHistogramMin ( ) const
virtual
template<class TInputImage, class TCoordRep = double>
virtual const char* otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual
template<class TInputImage, class TCoordRep = double>
virtual const unsigned int& otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::GetNeighborhoodRadius ( ) const
virtual

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

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

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

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

Method for creation through the object factory.

template<class TInputImage, class TCoordRep = double>
void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::operator= ( const Self )
privatedelete
template<class TInputImage , class TCoordRep >
void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::Object.

Definition at line 45 of file otbLocalHistogramImageFunction.hxx.

template<class TInputImage, class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::SetGaussianSmoothing ( bool  _arg)
virtual
template<class TInputImage, class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::SetHistogramMax ( double  _arg)
virtual
template<class TInputImage, class TCoordRep = double>
virtual void otb::LocalHistogramImageFunction< TInputImage, TCoordRep >::SetHistogramMin ( double  _arg)
virtual
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

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

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 89 of file otbLocalHistogramImageFunction.h.

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

Definition at line 145 of file otbLocalHistogramImageFunction.h.

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

Definition at line 144 of file otbLocalHistogramImageFunction.h.

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

Definition at line 143 of file otbLocalHistogramImageFunction.h.

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

Definition at line 141 of file otbLocalHistogramImageFunction.h.

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

Definition at line 142 of file otbLocalHistogramImageFunction.h.


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