eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::EGuardBand Struct Reference

Used to define a guard band around the processed ROI. A guard band is a border, in pixels, to exclude perturbed image data and avoid misdetections near the edges of the ROI. The default value is 0. More...

#include <eVision/EasySpotDetector/EGuardBand.h>

Public Member Functions

 EGuardBand ()
 Constructs a EGuardBand.
 EGuardBand (uint32_t l, uint32_t r, uint32_t t, uint32_t b)
 Constructs a EGuardBand.
bool operator== (const eVision::EGuardBand &other) const
 Comparison operator.
bool operator!= (const eVision::EGuardBand &other) const
 Comparison operator.
bool IsEnabled () const
 Returns true if at least one border is not null.

Public Attributes

uint32_t Left
 The left border.
uint32_t Right
 The right border.
uint32_t Top
 The top border.
uint32_t Bottom
 The bottom border.

Detailed Description

Used to define a guard band around the processed ROI. A guard band is a border, in pixels, to exclude perturbed image data and avoid misdetections near the edges of the ROI. The default value is 0.

License(s): EasySpotDetector

Deprecated
Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Constructor & Destructor Documentation

◆ EGuardBand() [1/2]

eVision::EGuardBand::EGuardBand ( )

Constructs a EGuardBand.

◆ EGuardBand() [2/2]

eVision::EGuardBand::EGuardBand ( uint32_t l,
uint32_t r,
uint32_t t,
uint32_t b )

Constructs a EGuardBand.

Parameters
lSize in pixel of the left border (default is 0).
rSize in pixel of the right border (default is 0).
tSize in pixel of the top border (default is 0).
bSize in pixel of the bottom border (default is 0).

Member Function Documentation

◆ IsEnabled()

bool eVision::EGuardBand::IsEnabled ( ) const

Returns true if at least one border is not null.

◆ operator!=()

bool eVision::EGuardBand::operator!= ( const eVision::EGuardBand & other) const

Comparison operator.

Parameters
otherThe other object.

◆ operator==()

bool eVision::EGuardBand::operator== ( const eVision::EGuardBand & other) const

Comparison operator.

Parameters
otherThe other object.

Member Data Documentation

◆ Bottom

uint32_t eVision::EGuardBand::Bottom

The bottom border.

◆ Left

uint32_t eVision::EGuardBand::Left

The left border.

◆ Right

uint32_t eVision::EGuardBand::Right

The right border.

◆ Top

uint32_t eVision::EGuardBand::Top

The top border.