Basic Image AlgorithmS Library  2.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
BIAS::Binomial< InputStorageType, OutputStorageType > Class Template Reference

binomial low pass filter class More...

#include <Filter/Binomial.hh>

+ Inheritance diagram for BIAS::Binomial< InputStorageType, OutputStorageType >:
+ Collaboration diagram for BIAS::Binomial< InputStorageType, OutputStorageType >:

Public Types

enum  TBorderHandling { TBH_full, TBH_same, TBH_valid }
 enum for border calculation, same meanings as in matlab: More...
 

Public Member Functions

void AddDebugLevel (const long int lv)
 
void AddDebugLevel (const std::string &name)
 
 Binomial ()
 
 Binomial (const Binomial< InputStorageType, OutputStorageType > &other)
 
bool CalculationInFloat () const
 decides if calculation is done in integer or floating point More...
 
virtual FilterNToN
< InputStorageType,
OutputStorageType > * 
Clone () const
 
void CopyNonROIFromSource (const Image< InputStorageType > &src, Image< OutputStorageType > &dst) const
 run over all pixel which do not belong to the roi and set them to the value in the source image regardless of the roi of the source. More...
 
bool DebugLevelIsSet (const long int lv) const
 
bool DebugLevelIsSet (const std::string &name) const
 
virtual int Filter (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 sets kernel if params changed and calls convolution More...
 
int Filter3x3 (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 
int Filter3x3SameGreyFloat (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 specialized function for convolution with 3x3 binomial filter. More...
 
int Filter3x3ValidGreyFloat (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 specialized function for convolution with 3x3 binomial filter. More...
 
int Filter5x5 (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 
int Filter5x5ValidGreyFloat (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 specialized function for convolution with 5x5 binomial filter. More...
 
virtual int FilterFloat (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 no implementation, calls Filter More...
 
virtual int FilterInt (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 no implementation, calls Filter More...
 
int GetBorderHandling () const
 
void GetBorders (int &border_x, int &border_y) const
 
int GetDebugLevel () const
 
std::ostream & GetDebugStream () const
 
void GetDebugStream (std::ostream &os) const
 
int GetHalfWinSize () const
 
void GetKernel (FilterMask &fm) const
 get the current filter mask More...
 
long int Name2DebugLevel (const std::string &name) const
 looks up a debuglevel in the internal map, returns 0 if not found More...
 
long int NewDebugLevel (const std::string &name)
 creates a new debuglevel More...
 
void PrintDebugLevel (std::ostream &os=std::cout) const
 
void PrintKernel () const
 prints the used filter mask, for debugging More...
 
void RemoveDebugLevel (const long int lv)
 
void RemoveDebugLevel (const std::string &name)
 
void SetBorderHandling (const int bh)
 
void SetDebugLevel (const long int lv)
 
void SetDebugLevel (const std::string &name)
 
void SetDebugStream (const std::ostream &os)
 
void SetHalfWinSize (int hws)
 
void SetKernel (FilterMask &fm)
 set a new filter mask More...
 
void SetNonROIToValue (Image< OutputStorageType > &dst, const std::vector< OutputStorageType > &t) const
 run over all pixel which do not belong to the roi and set them to some value (typically black) More...
 
void ShowDebugLevel (std::ostream &os=std::cout) const
 prints all internally known debuglevels More...
 
 ~Binomial ()
 

Static Public Member Functions

static long int GetGlobalDebugLevel ()
 
static void SetGlobalDebugLevel (long int lev)
 

Protected Member Functions

void _CalculateKernel (int HalfWinSize)
 calculates the kernel More...
 
long ConsumeNextFreeDebuglevel_ ()
 returns the next available debuglevel More...
 
int ConvFloatHori_ (const Image< InputStorageType > &src, Image< CONV_FLOAT > &dst)
 worker function for float separated (horizontal) convolution More...
 
int ConvFloatMat_ (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 worker function for float matrix convolution More...
 
int ConvFloatVert_ (const Image< CONV_FLOAT > &src, Image< OutputStorageType > &dst)
 worker function for float separated (vertical) convolution More...
 
int ConvIntHori_ (const Image< InputStorageType > &src, Image< CONV_INT > &dst)
 worker function for int separated (horizontal) convolution More...
 
int ConvIntMat_ (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 worker function for int matrix convolution More...
 
int ConvIntVert_ (const Image< CONV_INT > &src, Image< OutputStorageType > &dst)
 worker function for int separated (vertical) convolution More...
 
virtual void GetBordersValid_ (int &border_x, int &border_y) const
 

Protected Attributes

int _FilterBorderHandling
 
FilterMask _fm
 the kernel data used for convolution More...
 
int _HalfWinSize
 the parameter More...
 
int _LastHalfWinSize
 
long int _liDebugLevel
 
long int _liNextDebugLevel
 new concept, debuglevel are managed here in the debug class More...
 
std::map< std::string, long int > _String2Debuglevel
 
Image< CONV_FLOAT > _tmpFloat
 temporary memory, needed for separable filters when float filtering More...
 
Image< CONV_INT > _tmpInt
 temporary memory, needed for separable filters when integer filtering More...
 

Static Protected Attributes

static std::ostream _zDebugStream
 
static long int GlobalDebugLevel = 0
 

Detailed Description

template<class InputStorageType, class OutputStorageType>
class BIAS::Binomial< InputStorageType, OutputStorageType >

binomial low pass filter class

Test:
TestFilterBinomial.cpp
Author
woelk 12/2004
Examples:
ExampleBinomial.cpp, and ExampleTrackerBase.cpp.

Definition at line 42 of file Binomial.hh.

Member Enumeration Documentation

template<class InputStorageType, class OutputStorageType>
enum BIAS::FilterBase::TBorderHandling
inherited

enum for border calculation, same meanings as in matlab:

  • TBH_valid: returns only the pixels whose values can be computed without using zero padding of the input image. The resulting output image is smaller than the input image. The ROI of the output image is set accordingly.
  • TBH_same: returns the set of pixels that can be computed by applying the filter to all pixels that are actually part of the input image. Border pixels are computed using zero padding, but the center pixel of the computational kernel is applied only to pixels in the image. This results in an output image that is the same size as the input image.
  • TBH_full: returns the full convolution. This means conv2 returns all pixels for which any of the pixels in the computational molecule overlap pixels in the image, even when the center pixel is outside the input image. The resulting output image is larger than the input image. This is not implemented at the moment.
Enumerator
TBH_full 
TBH_same 
TBH_valid 

Definition at line 98 of file FilterBase.hh.

Constructor & Destructor Documentation

template<class InputStorageType , class OutputStorageType >
Binomial::Binomial ( )
template<class InputStorageType , class OutputStorageType >
Binomial::Binomial ( const Binomial< InputStorageType, OutputStorageType > &  other)

Definition at line 54 of file Binomial.cpp.

template<class StorageType , class KernelType >
Binomial::~Binomial ( )

Definition at line 61 of file Binomial.cpp.

Member Function Documentation

template<class StorageType , class KernelType >
void Binomial::_CalculateKernel ( int  HalfWinSize)
protected

calculates the kernel

Definition at line 475 of file Binomial.cpp.

References TNT::Vector< T >::newsize().

Referenced by BIAS::Binomial< InputStorageType, OutputStorageType >::Binomial().

void BIAS::Debug::AddDebugLevel ( const long int  lv)
inlineinherited
void BIAS::Debug::AddDebugLevel ( const std::string &  name)
inlineinherited

Definition at line 362 of file Debug.hh.

template<class InputStorageType, class OutputStorageType>
bool BIAS::Convolution< InputStorageType, OutputStorageType >::CalculationInFloat ( ) const
inlineinherited

decides if calculation is done in integer or floating point

Definition at line 103 of file Convolution.hh.

template<class InputStorageType, class OutputStorageType>
virtual FilterNToN<InputStorageType, OutputStorageType>* BIAS::Binomial< InputStorageType, OutputStorageType >::Clone ( ) const
inlinevirtual

Reimplemented from BIAS::Convolution< InputStorageType, OutputStorageType >.

Definition at line 63 of file Binomial.hh.

long BIAS::Debug::ConsumeNextFreeDebuglevel_ ( )
inlineprotectedinherited

returns the next available debuglevel

Author
woelk 09/2006

Definition at line 521 of file Debug.hh.

template<class InputStorageType, class OutputStorageType >
int Convolution::ConvFloatHori_ ( const Image< InputStorageType > &  src,
Image< CONV_FLOAT > &  dst 
)
protectedinherited
template<class InputStorageType, class OutputStorageType>
int Convolution::ConvFloatMat_ ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
protectedinherited
template<class InputStorageType , class OutputStorageType>
int Convolution::ConvFloatVert_ ( const Image< CONV_FLOAT > &  src,
Image< OutputStorageType > &  dst 
)
protectedinherited
template<class InputStorageType, class OutputStorageType >
int Convolution::ConvIntHori_ ( const Image< InputStorageType > &  src,
Image< CONV_INT > &  dst 
)
protectedinherited
template<class InputStorageType, class OutputStorageType>
int Convolution::ConvIntMat_ ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
protectedinherited
template<class InputStorageType , class OutputStorageType>
int Convolution::ConvIntVert_ ( const Image< CONV_INT > &  src,
Image< OutputStorageType > &  dst 
)
protectedinherited
template<class InputStorageType, class OutputStorageType>
void FilterBase::CopyNonROIFromSource ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
) const
inherited

run over all pixel which do not belong to the roi and set them to the value in the source image regardless of the roi of the source.

Both images must have same size.

Author
koeser 12/2008

Definition at line 135 of file FilterBase.cpp.

References BIAS::ImageBase::GetChannelCount(), BIAS::ROI::GetCorners(), BIAS::ImageBase::GetHeight(), BIAS::Image< StorageType >::GetImageDataArray(), BIAS::ImageBase::GetROI(), BIAS::ImageBase::GetWidth(), and BIAS::ROI_Corners.

bool BIAS::Debug::DebugLevelIsSet ( const long int  lv) const
inlineinherited
bool BIAS::Debug::DebugLevelIsSet ( const std::string &  name) const
inlineinherited

Definition at line 350 of file Debug.hh.

template<class InputStorageType , class OutputStorageType >
int Binomial::Filter ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
virtual

sets kernel if params changed and calls convolution

Reimplemented from BIAS::Convolution< InputStorageType, OutputStorageType >.

Definition at line 69 of file Binomial.cpp.

References BIAS::Convolution< InputStorageType, OutputStorageType >::Filter().

Referenced by BIAS::CalibratedPyramid< StorageType >::Downsample_().

template<class InputStorageType , class OutputStorageType >
int Binomial::Filter3x3 ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
template<class InputStorageType , class OutputStorageType >
int Binomial::Filter3x3SameGreyFloat ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)

specialized function for convolution with 3x3 binomial filter.

dst must be initialized with the right image size. Internal calculation is done using floating point numbers. Uses "zero padding" of the image to achieve destination image ROIs of same size as source image ROIs. Untested !!

Author
woelk 07/2005

Definition at line 265 of file Binomial.cpp.

References BIAS::ROI::GetCorners(), BIAS::Image< StorageType >::GetImageDataArray(), BIAS::ImageBase::GetROI(), and BIAS::ROI::SetCorners().

template<class InputStorageType , class OutputStorageType >
int Binomial::Filter3x3ValidGreyFloat ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)

specialized function for convolution with 3x3 binomial filter.

dst must be initialized with the right image size. Internal calculation is done using floating point numbers.

Author
woelk 12/2004

Definition at line 178 of file Binomial.cpp.

References BIAS::ImageBase::GetChannelCount(), BIAS::ROI::GetCorners(), BIAS::ImageBase::GetHeight(), BIAS::Image< StorageType >::GetImageData(), BIAS::ImageBase::GetROI(), BIAS::ImageBase::GetWidth(), BIAS::ImageBase::SamePixelAndChannelCount(), BIAS::ImageIO::Save(), and BIAS::ROI::SetCorners().

template<class InputStorageType , class OutputStorageType >
int Binomial::Filter5x5 ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
template<class InputStorageType , class OutputStorageType >
int Binomial::Filter5x5ValidGreyFloat ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)

specialized function for convolution with 5x5 binomial filter.

dst must be initialized with the right image size. Internal calculation is done using floating point numbers.

Author
woelk 12/2004

Definition at line 383 of file Binomial.cpp.

References BIAS::ImageBase::GetChannelCount(), BIAS::ROI::GetCorners(), BIAS::ImageBase::GetHeight(), BIAS::Image< StorageType >::GetImageData(), BIAS::ImageBase::GetROI(), BIAS::ImageBase::GetWidth(), BIAS::ImageBase::SamePixelAndChannelCount(), BIAS::ImageIO::Save(), and BIAS::ROI::SetCorners().

template<class InputStorageType , class OutputStorageType >
int Binomial::FilterFloat ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
virtual

no implementation, calls Filter

Reimplemented from BIAS::Convolution< InputStorageType, OutputStorageType >.

Definition at line 101 of file Binomial.cpp.

template<class InputStorageType , class OutputStorageType >
int Binomial::FilterInt ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
virtual

no implementation, calls Filter

Reimplemented from BIAS::Convolution< InputStorageType, OutputStorageType >.

Definition at line 94 of file Binomial.cpp.

template<class InputStorageType, class OutputStorageType>
int BIAS::FilterBase< InputStorageType, OutputStorageType >::GetBorderHandling ( ) const
inlineinherited

Definition at line 129 of file FilterBase.hh.

template<class InputStorageType , class OutputStorageType >
void FilterBase::GetBorders ( int &  border_x,
int &  border_y 
) const
inherited
template<class StorageType , class KernelType >
void Binomial::GetBordersValid_ ( int &  border_x,
int &  border_y 
) const
protectedvirtual
int BIAS::Debug::GetDebugLevel ( ) const
inlineinherited
std::ostream& BIAS::Debug::GetDebugStream ( ) const
inlineinherited

Definition at line 405 of file Debug.hh.

void BIAS::Debug::GetDebugStream ( std::ostream &  os) const
inlineinherited

Definition at line 414 of file Debug.hh.

static long int BIAS::Debug::GetGlobalDebugLevel ( )
inlinestaticinherited

Definition at line 431 of file Debug.hh.

template<class InputStorageType, class OutputStorageType>
int BIAS::Binomial< InputStorageType, OutputStorageType >::GetHalfWinSize ( ) const
inline

Definition at line 100 of file Binomial.hh.

template<class InputStorageType, class OutputStorageType>
void BIAS::Convolution< InputStorageType, OutputStorageType >::GetKernel ( FilterMask fm) const
inlineinherited

get the current filter mask

Definition at line 92 of file Convolution.hh.

long int BIAS::Debug::Name2DebugLevel ( const std::string &  name) const
inlineinherited

looks up a debuglevel in the internal map, returns 0 if not found

Author
woelk 09/2006

Definition at line 454 of file Debug.hh.

long int BIAS::Debug::NewDebugLevel ( const std::string &  name)
inlineinherited
void BIAS::Debug::PrintDebugLevel ( std::ostream &  os = std::cout) const
inlineinherited

Definition at line 383 of file Debug.hh.

template<class InputStorageType , class OutputStorageType >
void Convolution::PrintKernel ( ) const
inherited

prints the used filter mask, for debugging

Definition at line 583 of file Convolution.cpp.

void BIAS::Debug::RemoveDebugLevel ( const long int  lv)
inlineinherited

Definition at line 369 of file Debug.hh.

void BIAS::Debug::RemoveDebugLevel ( const std::string &  name)
inlineinherited

Definition at line 376 of file Debug.hh.

template<class InputStorageType, class OutputStorageType>
void BIAS::FilterBase< InputStorageType, OutputStorageType >::SetBorderHandling ( const int  bh)
inlineinherited
void BIAS::Debug::SetDebugLevel ( const long int  lv)
inlineinherited
void BIAS::Debug::SetDebugLevel ( const std::string &  name)
inlineinherited

Definition at line 325 of file Debug.hh.

void BIAS::Debug::SetDebugStream ( const std::ostream &  os)
inlineinherited

Definition at line 398 of file Debug.hh.

static void BIAS::Debug::SetGlobalDebugLevel ( long int  lev)
inlinestaticinherited

Definition at line 424 of file Debug.hh.

template<class InputStorageType, class OutputStorageType>
void BIAS::Binomial< InputStorageType, OutputStorageType >::SetHalfWinSize ( int  hws)
inline
template<class InputStorageType, class OutputStorageType>
void BIAS::Convolution< InputStorageType, OutputStorageType >::SetKernel ( FilterMask fm)
inlineinherited

set a new filter mask

Definition at line 96 of file Convolution.hh.

template<class InputStorageType , class OutputStorageType>
void FilterBase::SetNonROIToValue ( Image< OutputStorageType > &  dst,
const std::vector< OutputStorageType > &  t 
) const
inherited

run over all pixel which do not belong to the roi and set them to some value (typically black)

Author
koeser 12/2008

Definition at line 84 of file FilterBase.cpp.

References BIAS::ImageBase::GetChannelCount(), BIAS::ROI::GetCorners(), BIAS::ImageBase::GetHeight(), BIAS::Image< StorageType >::GetImageDataArray(), BIAS::ImageBase::GetROI(), BIAS::ImageBase::GetWidth(), and BIAS::ROI_Corners.

void BIAS::Debug::ShowDebugLevel ( std::ostream &  os = std::cout) const
inlineinherited

prints all internally known debuglevels

Author
woelk 09/2006

Definition at line 496 of file Debug.hh.

Member Data Documentation

template<class InputStorageType, class OutputStorageType>
int BIAS::FilterBase< InputStorageType, OutputStorageType >::_FilterBorderHandling
protectedinherited
template<class InputStorageType, class OutputStorageType>
FilterMask BIAS::Convolution< InputStorageType, OutputStorageType >::_fm
protectedinherited

the kernel data used for convolution

Definition at line 107 of file Convolution.hh.

Referenced by BIAS::Convolution< InputStorageType, OutputStorageType >::Convolution().

template<class InputStorageType, class OutputStorageType>
int BIAS::Binomial< InputStorageType, OutputStorageType >::_HalfWinSize
protected

the parameter

Definition at line 108 of file Binomial.hh.

Referenced by BIAS::Binomial< InputStorageType, OutputStorageType >::Binomial().

template<class InputStorageType, class OutputStorageType>
int BIAS::Binomial< InputStorageType, OutputStorageType >::_LastHalfWinSize
protected

Definition at line 109 of file Binomial.hh.

long int BIAS::Debug::_liDebugLevel
protectedinherited

Definition at line 510 of file Debug.hh.

Referenced by BIAS::Debug::operator=(), and BIAS::ImageBase::operator=().

long int BIAS::Debug::_liNextDebugLevel
protectedinherited

new concept, debuglevel are managed here in the debug class

Definition at line 516 of file Debug.hh.

Referenced by BIAS::Debug::operator=().

std::map<std::string, long int> BIAS::Debug::_String2Debuglevel
protectedinherited

Definition at line 517 of file Debug.hh.

Referenced by BIAS::Debug::operator=().

template<class InputStorageType, class OutputStorageType>
Image<CONV_FLOAT> BIAS::Convolution< InputStorageType, OutputStorageType >::_tmpFloat
protectedinherited

temporary memory, needed for separable filters when float filtering

Definition at line 114 of file Convolution.hh.

template<class InputStorageType, class OutputStorageType>
Image<CONV_INT> BIAS::Convolution< InputStorageType, OutputStorageType >::_tmpInt
protectedinherited

temporary memory, needed for separable filters when integer filtering

Definition at line 117 of file Convolution.hh.

std::ostream BIAS::Debug::_zDebugStream
staticprotectedinherited

Definition at line 511 of file Debug.hh.

Referenced by BIAS::Debug::operator=().

long int BIAS::Debug::GlobalDebugLevel = 0
staticprotectedinherited

Definition at line 513 of file Debug.hh.


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