Skip to content

FaceRecognizerSF documentation typos #25700

@ghost

Description

Describe the doc issue

There are a few typos in the FaceRecognizerSF class documentation which make the underlying APIs difficult to interpret.

For example,

  • For the alignCrop method the description reads:

    • @brief Aligning image to put face on the standard position.
    • It is unclear what is meant by standard position.
  • For the match method the description for the dis_type parameter has a typo:

    • defining the similarity with optional values "FR_OSINE" or "FR_NORM_L2"
    • FR_OSINE --> FR_COSINE

Fix suggestion

For the alignCrop method:

/** @brief Aligns detected face with the source input image

For the match method

* @param dis_type defines how to calculate the distance between two face features with optional values "FR_COSINE" or "FR_NORM_L2"

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions