hyperion.ng
Public Member Functions | List of all members
hyperion::BlackBorderProcessor Class Reference

The BlackBorder processor is a wrapper around the black-border detector for keeping track of detected borders and count of the type and size of detected borders. More...

#include <BlackBorderProcessor.h>

Inheritance diagram for hyperion::BlackBorderProcessor:

Public Member Functions

 BlackBorderProcessor (Hyperion *hyperion, QObject *parent)
 
BlackBorder getCurrentBorder () const
 Return the current (detected) border. More...
 
bool enabled () const
 Return activation state of black border detector. More...
 
void setEnabled (bool enable)
 Set activation state of black border detector. More...
 
void setHardDisable (const bool &disable)
 Sets the _hardDisabled state, if True prevents the enable from COMP_BLACKBORDER state emit (mimiks wrong state to external!) It's not possible to enable bb from this method, if the user requsted a disable! More...
 
template<typename Pixel_T >
bool process (const Image< Pixel_T > &image)
 Processes the image. More...
 

Detailed Description

The BlackBorder processor is a wrapper around the black-border detector for keeping track of detected borders and count of the type and size of detected borders.

Member Function Documentation

§ enabled()

bool BlackBorderProcessor::enabled ( ) const

Return activation state of black border detector.

Returns
The current border

§ getCurrentBorder()

BlackBorder BlackBorderProcessor::getCurrentBorder ( ) const

Return the current (detected) border.

Returns
The current border

§ process()

template<typename Pixel_T >
bool hyperion::BlackBorderProcessor::process ( const Image< Pixel_T > &  image)
inline

Processes the image.

This performs detecion of black-border on the given image and updates the current border accordingly. If the current border is updated the method call will return true else false

Parameters
imageThe image to process
Returns
True if a different border was detected than the current else false

§ setEnabled()

void BlackBorderProcessor::setEnabled ( bool  enable)

Set activation state of black border detector.

Parameters
enablecurrent state

§ setHardDisable()

void BlackBorderProcessor::setHardDisable ( const bool &  disable)

Sets the _hardDisabled state, if True prevents the enable from COMP_BLACKBORDER state emit (mimiks wrong state to external!) It's not possible to enable bb from this method, if the user requsted a disable!

Parameters
disableThe new state

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