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

Removes areas from an image that have a low density (fill rate). More...

#include <Filter/DensityFilter.hh>

+ Inheritance diagram for BIAS::DensityFilter< InputStorageType, OutputStorageType >:
+ Collaboration diagram for BIAS::DensityFilter< 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)
 
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
 
 DensityFilter (unsigned int halfWinSize=10, float requiredDensity=0.5, InputStorageType undefinedPixel=0)
 Constructor. More...
 
virtual int Filter (const Image< InputStorageType > &srcImage, Image< OutputStorageType > &dstImage)
 Performs the filter operation. More...
 
int GetBorderHandling () const
 
void GetBorders (int &border_x, int &border_y) const
 
virtual void GetBordersValid_ (int &border_x, int &border_y) const
 Returns the size of the borders. More...
 
int GetDebugLevel () const
 
std::ostream & GetDebugStream () const
 
void GetDebugStream (std::ostream &os) 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 SetBorderHandling (const int bh)
 
void SetDebugLevel (const long int lv)
 
void SetDebugLevel (const std::string &name)
 
void SetDebugStream (const std::ostream &os)
 
void SetHalfWinSize (unsigned int halfWinSize)
 Sets the half size of the filter window. 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 SetRequiredDensity (float requiredDensity)
 Sets the required density for a pixel to be accepted. More...
 
void SetUndefinedPixelValue (InputStorageType undefinedPixel)
 Sets the value that represents empty pixels. More...
 
void ShowDebugLevel (std::ostream &os=std::cout) const
 prints all internally known debuglevels More...
 

Static Public Member Functions

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

Protected Member Functions

long ConsumeNextFreeDebuglevel_ ()
 returns the next available debuglevel More...
 

Protected Attributes

int _FilterBorderHandling
 
long int _liDebugLevel
 
long int _liNextDebugLevel
 new concept, debuglevel are managed here in the debug class 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::DensityFilter< InputStorageType, OutputStorageType >

Removes areas from an image that have a low density (fill rate).

The primary focus for this class is filtering depth maps. For each pixel, it is determined how many valid neighbours it has. If this number is below a certain threshold, it is removed. Borders are completely ignored.

Author
rwulff
Date
10/2011

Definition at line 44 of file DensityFilter.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>
BIAS::DensityFilter< InputStorageType, OutputStorageType >::DensityFilter ( unsigned int  halfWinSize = 10,
float  requiredDensity = 0.5,
InputStorageType  undefinedPixel = 0 
)
inline

Constructor.

Parameters
halfWinSizedetermines size of window
requiredDensityareas with a density less or equal to this will be removed, must be in [0, 1]
undefinedPixelpixel value that means empty

Definition at line 62 of file DensityFilter.hh.

Member Function Documentation

void BIAS::Debug::AddDebugLevel ( const long int  lv)
inlineinherited
Examples:
EvaluateAlignment.cpp, ExampleAlignment.cpp, ExampleMinMax.cpp, ExampleRANSAC_double.cpp, ExampleRANSACPlane.cpp, and ExampleTriangulateOptimal.cpp.

Definition at line 355 of file Debug.hh.

Referenced by BIAS::GLProjectionParametersBase::AddDebugLevel(), BIAS::Triangulation::CorrectCorrespondences(), BIAS::FilterBase< InputStorageType, OutputStorageType >::FilterBase(), BIAS::ShowCamWxVideoSourceFactory::OpenDevice(), and BIAS::SceneOpenSceneGraph::SceneOpenSceneGraph().

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

Definition at line 362 of file Debug.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>
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
Examples:
ExampleTriangulateOptimal.cpp.

Definition at line 341 of file Debug.hh.

Referenced by BIAS::GenSynthMatches::_AddUniformDistributedOutliers(), BIAS::GenSynthMatches::_CreateCamMovement(), BIAS::GenSynthMatches::_CreateStatic2DPoints(), BIAS::UnscentedTransform::ComputeSigmaPoints_(), BIAS::Triangulation::CorrectCorrespondences(), BIAS::GenSynthMatches::GetGTNormalizedF(), BIAS::MonteCarloTransform::GetSamples_(), and BIAS::MonteCarloTransform::Transform().

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

Definition at line 350 of file Debug.hh.

template<class InputStorageType , class OutputStorageType >
int DensityFilter::Filter ( const Image< InputStorageType > &  srcImage,
Image< OutputStorageType > &  dstImage 
)
virtual

Performs the filter operation.

Parameters
srcsource image
dstdestination image
Returns
0 on success or < 0 on error

Implements BIAS::FilterBase< InputStorageType, OutputStorageType >.

Definition at line 31 of file DensityFilter.cpp.

References BIAS::ImageBase::GetChannelCount(), BIAS::ImageBase::GetHeight(), BIAS::Image< StorageType >::GetImageData(), BIAS::ImageBase::GetWidth(), BIAS::Image< StorageType >::Init(), and BIAS::ImageBase::SetZero().

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

Definition at line 61 of file FilterBase.cpp.

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

template<class InputStorageType, class OutputStorageType>
virtual void BIAS::DensityFilter< InputStorageType, OutputStorageType >::GetBordersValid_ ( int &  border_x,
int &  border_y 
) const
inlinevirtual

Returns the size of the borders.

This is essentially the half win size.

Parameters
[out]border_xborder in x direction
[out]border_yborder in y direction

Implements BIAS::FilterBase< InputStorageType, OutputStorageType >.

Definition at line 96 of file DensityFilter.hh.

int BIAS::Debug::GetDebugLevel ( ) const
inlineinherited
Examples:
ExampleCamera.cpp, ExampleCamPoseCalib.cpp, ExampleCopy.cpp, and ExampleParabola.cpp.

Definition at line 332 of file Debug.hh.

Referenced by BIAS::listenthread(), BIAS::Image< StorageType >::operator=(), and BIAS::ImageBase::operator=().

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.

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

creates a new debuglevel

Author
woelk 09/2006

Definition at line 474 of file Debug.hh.

Referenced by BIAS::COSAC< SolutionType >::COSAC(), BIAS::ProjectionParametersPerspectiveDepth::Init(), BIAS::MonteCarloTransform::MonteCarloTransform(), BIAS::PMatrixEstimation::PMatrixEstimation(), BIAS::PreemptiveRANSAC< SolutionType >::PreemptiveRANSAC(), BIAS::RANSACPreKnowledge< SolutionType >::RANSACPreKnowledge(), BIAS::ROI::ROI(), BIAS::RotationAveraging::RotationAveraging(), BIAS::SceneOpenSceneGraph::SceneOpenSceneGraph(), BIAS::ThreeDOutOpenSceneGraph::ThreeDOutOpenSceneGraph(), BIAS::Triangulation::Triangulation(), and BIAS::UnscentedTransform::UnscentedTransform().

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::FilterBase< InputStorageType, OutputStorageType >::SetBorderHandling ( const int  bh)
inlineinherited

Definition at line 127 of file FilterBase.hh.

Referenced by BIAS::PMDImageProc::DenoiseDepthImage(), BIAS::CalibratedPyramid< StorageType >::Downsample_(), BIAS::PMDImageProc::FitDepthTo2DImage(), and BIAS::PMDImageProc::FitDepthTo2DImageFree_().

void BIAS::Debug::SetDebugLevel ( const long int  lv)
inlineinherited
Examples:
ExampleCamera.cpp, ExampleCamPoseCalib.cpp, ExampleCopy.cpp, ExampleDcam.cpp, ExampleDcamImageConvert.cpp, ExampleDirectToDisk.cpp, ExampleGrabTrippleFromXB3.cpp, ExampleHarrisColor.cpp, ExampleLDA.cpp, ExampleLineMatcher.cpp, ExampleMDCamToShm.cpp, ExampleParabola.cpp, ExamplePMatrix.cpp, ExamplePtGreyHiresColor.cpp, ExampleVideoSource_Shm.cpp, and Scan1394Bus.cpp.

Definition at line 318 of file Debug.hh.

Referenced by BIAS::ShowCamWxVideoSourceFactory::CreateBumbleBee(), BIAS::ShowCamWxVideoSourceFactory::CreateDCAM(), BIAS::VideoSource_MDcam::ScanBus(), BIAS::GLProjectionParametersBase::SetDebugLevel(), BIAS::VideoSource_Disk::VideoSource_Disk(), BIAS::VideoSource_DV2::VideoSource_DV2(), BIAS::VideoSource_DV::VideoSource_DV_Internal_Init_(), and BIAS::VideoSource_V4L::VideoSource_V4L().

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::DensityFilter< InputStorageType, OutputStorageType >::SetHalfWinSize ( unsigned int  halfWinSize)
inline

Sets the half size of the filter window.

The full size of the window will be 2 * halfWinSize + 1.

Parameters
[in]halfWinSizehalf size of the filter window

Definition at line 110 of file DensityFilter.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::DensityFilter< InputStorageType, OutputStorageType >::SetRequiredDensity ( float  requiredDensity)
inline

Sets the required density for a pixel to be accepted.

Parameters
[in]requiredDensityareas with a density less or equal to this will be removed, must be in [0, 1]

Definition at line 123 of file DensityFilter.hh.

template<class InputStorageType, class OutputStorageType>
void BIAS::DensityFilter< InputStorageType, OutputStorageType >::SetUndefinedPixelValue ( InputStorageType  undefinedPixel)
inline

Sets the value that represents empty pixels.

Parameters
[in]undefinedPixelthe pixel value to interprete as empty

Definition at line 136 of file DensityFilter.hh.

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

Definition at line 132 of file FilterBase.hh.

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

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=().

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:
Generated on Tue Feb 6 2018 02:01:53 for Basic Image AlgorithmS Library by   doxygen 1.8.5