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::Bilateral< InputStorageType, OutputStorageType > Class Template Reference

2D bilateral filter More...

#include <Filter/Bilateral.hh>

+ Inheritance diagram for BIAS::Bilateral< InputStorageType, OutputStorageType >:
+ Collaboration diagram for BIAS::Bilateral< 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)
 
 Bilateral ()
 
 Bilateral (const Bilateral< InputStorageType, OutputStorageType > &other)
 
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)
 Bilateral filtering with given filter size (5x5 as standard) More...
 
virtual int Filter (const Image< InputStorageType > &src, const Image< InputStorageType > &support, Image< OutputStorageType > &dst)
 Bilateral filtering with given filter size (5x5 as standard) uses support image as smoothing restriction, see Petschnigg 2004: DigitalPhotography. More...
 
int FilterColorImg (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 Filter a color image by calling Filter(...) for every channel. More...
 
int FilterColorImg (const Image< InputStorageType > &src, const Image< InputStorageType > &support, Image< OutputStorageType > &dst)
 Filter a color image with support image by calling Filter(...) for every channel. More...
 
virtual int FilterFloat (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 
virtual int FilterInt (const Image< InputStorageType > &src, Image< OutputStorageType > &dst)
 
double GetBilateralSigma () const
 
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
 
InputStorageType GetIgnoreValue ()
 
double GetSigma () const
 
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 RemoveDebugLevel (const long int lv)
 
void RemoveDebugLevel (const std::string &name)
 
void SetBilateralSigma (const double si)
 
void SetBorderHandling (const int bh)
 
void SetDebugLevel (const long int lv)
 
void SetDebugLevel (const std::string &name)
 
void SetDebugStream (const std::ostream &os)
 
void SetIgnoreValue (InputStorageType ignore)
 
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 SetSigma (const double si)
 
void SetSize (int newsize, int secondsize=-1)
 
void ShowDebugLevel (std::ostream &os=std::cout) const
 prints all internally known debuglevels More...
 
virtual ~Bilateral ()
 

Static Public Member Functions

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

Protected Member Functions

void _CalculateKernels (double gaussSigma)
 
long ConsumeNextFreeDebuglevel_ ()
 returns the next available debuglevel More...
 
virtual void GetBordersValid_ (int &border_x, int &border_y) const
 

Protected Attributes

double _BilateralSigma
 
int _BilateralSize
 half win size of filter, 1 means 3x3 More...
 
int _FilterBorderHandling
 
BIAS::Image< float > _gaussFilterMask
 
double _GaussSigma
 sigma of gaussian kernel More...
 
InputStorageType _ignoreValue
 
int _lastBilateralSize
 
int _lastSecondSize
 
long int _liDebugLevel
 
long int _liNextDebugLevel
 new concept, debuglevel are managed here in the debug class More...
 
int _secondSize
 Use this variable for non-quadratic filter sizes e.g. 3x1. More...
 
std::map< std::string, long int > _String2Debuglevel
 

Static Protected Attributes

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

Detailed Description

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

2D bilateral filter

Author
ischiller
Examples:
ExampleBilateral.cpp.

Definition at line 35 of file Bilateral.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 >
Bilateral::Bilateral ( )
template<class InputStorageType , class OutputStorageType >
Bilateral::Bilateral ( const Bilateral< InputStorageType, OutputStorageType > &  other)

Definition at line 51 of file Bilateral.cpp.

template<class InputStorageType , class OutputStorageType >
Bilateral::~Bilateral ( )
virtual

Definition at line 67 of file Bilateral.cpp.

Member Function Documentation

template<class InputStorageType , class OutputStorageType >
void Bilateral::_CalculateKernels ( double  gaussSigma)
protected

Definition at line 91 of file Bilateral.cpp.

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>
virtual FilterNToN<InputStorageType, OutputStorageType>* BIAS::Bilateral< InputStorageType, OutputStorageType >::Clone ( ) const
inlinevirtual
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>
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 Bilateral::Filter ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
virtual
template<class InputStorageType , class OutputStorageType >
int Bilateral::Filter ( const Image< InputStorageType > &  src,
const Image< InputStorageType > &  support,
Image< OutputStorageType > &  dst 
)
virtual
template<class InputStorageType , class OutputStorageType >
int Bilateral::FilterColorImg ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)

Filter a color image by calling Filter(...) for every channel.

use planar image in order to apply median filter seperately to each channel for now

Definition at line 320 of file Bilateral.cpp.

References BIAS::ImageBase::CM_RGB, BIAS::ImageConvert::Convert(), BIAS::ImageBase::GetChannel(), BIAS::ImageBase::GetColorModel(), BIAS::ImageBase::GetHeight(), BIAS::Image< StorageType >::GetImageData(), BIAS::ImageBase::GetWidth(), BIAS::ImageBase::IsPlanar(), and BIAS::ImageBase::SetChannel().

template<class InputStorageType , class OutputStorageType >
int Bilateral::FilterColorImg ( const Image< InputStorageType > &  src,
const Image< InputStorageType > &  support,
Image< OutputStorageType > &  dst 
)

Filter a color image with support image by calling Filter(...) for every channel.

use planar image in order to apply median filter seperately to each channel for now

Definition at line 363 of file Bilateral.cpp.

References BIAS::ImageBase::CM_RGB, BIAS::ImageConvert::Convert(), BIAS::ImageBase::GetChannel(), BIAS::ImageBase::GetColorModel(), BIAS::ImageBase::GetHeight(), BIAS::Image< StorageType >::GetImageData(), BIAS::ImageBase::GetWidth(), BIAS::ImageBase::IsPlanar(), and BIAS::ImageBase::SetChannel().

template<class InputStorageType , class OutputStorageType >
int Bilateral::FilterFloat ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
virtual
template<class InputStorageType , class OutputStorageType >
int Bilateral::FilterInt ( const Image< InputStorageType > &  src,
Image< OutputStorageType > &  dst 
)
virtual
template<class InputStorageType, class OutputStorageType>
double BIAS::Bilateral< InputStorageType, OutputStorageType >::GetBilateralSigma ( ) const
inline

Definition at line 86 of file Bilateral.hh.

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 InputStorageType , class OutputStorageType >
void Bilateral::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>
InputStorageType BIAS::Bilateral< InputStorageType, OutputStorageType >::GetIgnoreValue ( )
inline

Definition at line 88 of file Bilateral.hh.

template<class InputStorageType, class OutputStorageType>
double BIAS::Bilateral< InputStorageType, OutputStorageType >::GetSigma ( ) const
inline

Definition at line 84 of file Bilateral.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.

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::Bilateral< InputStorageType, OutputStorageType >::SetBilateralSigma ( const double  si)
inline

Definition at line 85 of file Bilateral.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::Bilateral< InputStorageType, OutputStorageType >::SetIgnoreValue ( InputStorageType  ignore)
inline

Definition at line 87 of file Bilateral.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.

template<class InputStorageType, class OutputStorageType>
void BIAS::Bilateral< InputStorageType, OutputStorageType >::SetSigma ( const double  si)
inline

Definition at line 83 of file Bilateral.hh.

template<class InputStorageType , class OutputStorageType >
void Bilateral::SetSize ( int  newsize,
int  secondsize = -1 
)
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>
double BIAS::Bilateral< InputStorageType, OutputStorageType >::_BilateralSigma
protected
template<class InputStorageType, class OutputStorageType>
int BIAS::Bilateral< InputStorageType, OutputStorageType >::_BilateralSize
protected

half win size of filter, 1 means 3x3

Definition at line 97 of file Bilateral.hh.

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

template<class InputStorageType, class OutputStorageType>
int BIAS::FilterBase< InputStorageType, OutputStorageType >::_FilterBorderHandling
protectedinherited
template<class InputStorageType, class OutputStorageType>
BIAS::Image<float> BIAS::Bilateral< InputStorageType, OutputStorageType >::_gaussFilterMask
protected

Definition at line 101 of file Bilateral.hh.

template<class InputStorageType, class OutputStorageType>
double BIAS::Bilateral< InputStorageType, OutputStorageType >::_GaussSigma
protected

sigma of gaussian kernel

Definition at line 95 of file Bilateral.hh.

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

template<class InputStorageType, class OutputStorageType>
InputStorageType BIAS::Bilateral< InputStorageType, OutputStorageType >::_ignoreValue
protected
template<class InputStorageType, class OutputStorageType>
int BIAS::Bilateral< InputStorageType, OutputStorageType >::_lastBilateralSize
protected
template<class InputStorageType, class OutputStorageType>
int BIAS::Bilateral< InputStorageType, OutputStorageType >::_lastSecondSize
protected
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=().

template<class InputStorageType, class OutputStorageType>
int BIAS::Bilateral< InputStorageType, OutputStorageType >::_secondSize
protected

Use this variable for non-quadratic filter sizes e.g. 3x1.

Definition at line 99 of file Bilateral.hh.

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

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

Definition at line 517 of file Debug.hh.

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

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: