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

Used to store the scratch detection parameters. See EParticleDetectionParameters for the particle detection parameters. More...

#include <eVision/EasySpotDetector/EScratchDetectionParameters.h>

Public Member Functions

 EScratchDetectionParameters ()
 Constructs a EScratchDetectionParameters.
 EScratchDetectionParameters (eVision::ESpotPolarity polarity, uint32_t threshold, uint32_t width, uint32_t length)
 Constructs a EScratchDetectionParameters.
bool operator== (const eVision::EScratchDetectionParameters &other) const
 Comparison operator.
bool operator!= (const eVision::EScratchDetectionParameters &other) const
 Comparison operator.

Public Attributes

eVision::ESpotPolarity Polarity
 The scratch polarity (black, white or any) in ESpotPolarity. Default polarity is ESpotPolarity::ESpotPolarity_Any.
uint32_t Threshold
 The threshold on the pixel intensity difference with the background. A low threshold (5-10) implies a sensitive detection, with possibly a lot of detected spots. A high threshold (30-40) implies a conservative detection, with possible a few or no spot detected. Default threshold is 20.
uint32_t NominalWidth
 The nominal scratch width. The width of the scratch must be roughtly equal to the nominal width. Default nominal width is 10.
uint32_t MinLength
 The minimum scratch length. The length of the scratch must be equal or larger than the minimum length. Default minimum size is 100.

Detailed Description

Used to store the scratch detection parameters. See EParticleDetectionParameters for the particle detection parameters.

License(s): EasySpotDetector

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

Constructor & Destructor Documentation

◆ EScratchDetectionParameters() [1/2]

eVision::EScratchDetectionParameters::EScratchDetectionParameters ( )

◆ EScratchDetectionParameters() [2/2]

eVision::EScratchDetectionParameters::EScratchDetectionParameters ( eVision::ESpotPolarity polarity,
uint32_t threshold,
uint32_t width,
uint32_t length )

Constructs a EScratchDetectionParameters.

Parameters
polarityThe particle polarity (black, white or any) in ESpotPolarity.
thresholdThe threshold on the pixel intensity difference with the background.
widthThe nominal scratch width.
lengthThe minimum scratch length.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

Parameters
otherThe other object.

◆ operator==()

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

Comparison operator.

Parameters
otherThe other object.

Member Data Documentation

◆ MinLength

uint32_t eVision::EScratchDetectionParameters::MinLength

The minimum scratch length. The length of the scratch must be equal or larger than the minimum length. Default minimum size is 100.

◆ NominalWidth

uint32_t eVision::EScratchDetectionParameters::NominalWidth

The nominal scratch width. The width of the scratch must be roughtly equal to the nominal width. Default nominal width is 10.

◆ Polarity

eVision::ESpotPolarity eVision::EScratchDetectionParameters::Polarity

The scratch polarity (black, white or any) in ESpotPolarity. Default polarity is ESpotPolarity::ESpotPolarity_Any.

◆ Threshold

uint32_t eVision::EScratchDetectionParameters::Threshold

The threshold on the pixel intensity difference with the background. A low threshold (5-10) implies a sensitive detection, with possibly a lot of detected spots. A high threshold (30-40) implies a conservative detection, with possible a few or no spot detected. Default threshold is 20.