Enrollment 28.2.0
Loading...
Searching...
No Matches
AlgorithmicSegmentation::Config Class Reference

Configuration for AlgorithmicSegmentation. More...

#include <PrintDetector.h>

Collaboration diagram for AlgorithmicSegmentation::Config:

Public Member Functions

void WriteTo (Writer &writer) const final
 Function serializes configuration via provided Writer.
void SetMaxRotation (unsigned int value)
 It sets maximum rotation of fingers in the slap image.
unsigned int GetMaxRotation () const
 It gets maximum rotation of fingers in the slap image.
void EnableNoiseReduction ()
 It enables noise reduction before segmentation.
bool IsNoiseReduction () const
 It returns true when noise reduction before segmentation is enabled.
 Config ()=default
 Constructs default configuration.
void SetNarrowFingerPreference (bool expectNarrow)
 Informs the print detector to anticipate narrow fingers.
bool GetNarrowFingerPreference () const
 Retrieves information about the expected narrowness of detected fingers.

Static Public Member Functions

static Config Default ()
 Provides default config.

Detailed Description

Configuration for AlgorithmicSegmentation.

Constructor & Destructor Documentation

◆ Config()

Config ( )
default

Constructs default configuration.

Default Algorithmic segmentation configuration is

  • maxRotation - 45
  • reduceNoise - false
  • expectNarrowFinger - true

References Config().

Referenced by Config(), and Default().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ Default()

Config Default ( )
inlinestatic

Provides default config.

Default Algorithmic segmentation configuration is

  • maxRotation - 45
  • reduceNoise - false
  • expectNarrowFinger - true
Returns
default config

References Config().

Here is the call graph for this function:

◆ GetMaxRotation()

unsigned int GetMaxRotation ( ) const
inlinenodiscard

It gets maximum rotation of fingers in the slap image.

Returns
maximum rotation of fingers in the slap image

◆ GetNarrowFingerPreference()

bool GetNarrowFingerPreference ( ) const
inlinenodiscardinherited

Retrieves information about the expected narrowness of detected fingers.

Returns
true if narrow detected fingers are expected
false if narrow detected fingers are not expected

◆ IsNoiseReduction()

bool IsNoiseReduction ( ) const
inlinenodiscard

It returns true when noise reduction before segmentation is enabled.

Returns
true when noise reduction is enabled

◆ SetMaxRotation()

void SetMaxRotation ( unsigned int value)
inline

It sets maximum rotation of fingers in the slap image.

Parameters
valueindicating maximum rotation of fingers in the slap image. Value is in degrees. Valid range <0,45>.
Exceptions
EnrollmentInvalidArgumentExceptionwhen value is not in range

◆ SetNarrowFingerPreference()

void SetNarrowFingerPreference ( bool expectNarrow)
inlineinherited

Informs the print detector to anticipate narrow fingers.

It recommends returning a narrow bounding rectangle even if the detected finger is initially identified as wide. This adjustment is particularly relevant in cases where the finger is rotated, causing a misalignment between the top-left rectangle point and the corresponding point from the finger's perspective. The function then adjusts the coordinates to narrow down the representation of the finger, estimating rectangle points (top-left, top-right, bottom-right, bottom-left) based on the fingerprint's viewpoint. Since there is limited information about the orientation of the fingerprint, this estimation involves some guesswork. It's important to note that the detector provides only the rectangle without indicating the direction of the finger within the bounding rectangle. This means that after alignment, some fingerprints may appear upside down. The recommended adjustment of the top-left point from the finger's perspective plays a crucial role in aligning the cropped finger accurately.

Parameters
expectNarrowWhen set to true, the detector will consistently output a narrow bounding rectangle for the detected finger. In contrast, if expectNarrow is false, the detector will refrain from modifying the rectangle and will maintain its original dimensions.

◆ WriteTo()

void WriteTo ( Writer & writer) const
inlinefinalvirtual

Function serializes configuration via provided Writer.

Parameters
writerused to serialize Config.

Implements Serializable.

References PrintDetectorConfig::WriteTo().

Here is the call graph for this function:

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