example_palm_liveness.cpp

Example of use of sfe_palm library

 
#include "sfe_toolkit/sfe_core.h"
#include "sfe_toolkit/sfe_palm.h"
#include <iomanip>
#include <regex>
#include <sstream>
#include <vector>
 
#include "annotate.hpp"
#include "solvers.h"
#include "utils.hpp"
#include <unordered_map>
 
std::string image_probe = "assets/palm/palm_id1_r1.jpg";
 
std::string solver_palm_detect = SOLVER_PALM_DETECT;
#ifdef SOLVER_PALM_LIVENESS
std::string solver_palm_liveness = SOLVER_PALM_LIVENESS;
#endif // SOLVER_PALM_LIVENESS
 
const auto SOLVER_PARAMETERS = std::vector<SFESolverParameter>{};
 
float detection_threshold = 0.1f;
 
inline void printPalmDetectionInfo(SFEDetection &detected_palm) {
  std::cout << "SFEDetection{ " << std::endl;
  std::cout << "  confidence: " << detected_palm.confidence << std::endl;
  std::cout << "  SFEBoundingBox{ " << std::endl;
  std::cout << "    x: " << detected_palm.bounding_box.x << std::endl;
  std::cout << "    y: " << detected_palm.bounding_box.y << std::endl;
  std::cout << "    width: " << detected_palm.bounding_box.width << std::endl;
  std::cout << "    height: " << detected_palm.bounding_box.height << std::endl;
  std::cout << "    }" << std::endl;
  std::cout << "  }" << std::endl;
  std::cout << std::endl;
}
 
void printHelp() {
  std::cout << "Help: Usage of the program." << std::endl;
  std::cout << "Options:" << std::endl;
  std::cout << "-h: Display help." << std::endl;
  std::cout << "-p: Probe image file." << std::endl;
  std::cout << "-d: Path to detector solver." << std::endl;
  std::cout << "-i: Path to liveness solver." << std::endl;
  std::cout << "-t: Palm detection threshold. <0,1>" << std::endl;
}
 
int main(int argc, char *argv[]) {
 
  { // STAGE: 0 Parse command line arguments
    // Map to store argument values
    std::unordered_map<std::string, std::string> args;
 
    // Parse command line arguments
    for (int i = 1; i < argc; ++i) {
      std::string arg = argv[i];
      if (arg[0] == '-') {
        if (arg == "-h") {
          printHelp();
          return 0;
        }
        // Check if there's a next argument and it isn't another option
        if (i + 1 < argc && argv[i + 1][0] != '-') {
          args[arg] = argv[++i];
        } else {
          std::cerr << "Option " << arg << " requires a value." << std::endl;
          return 1;
        }
      } else {
        std::cerr << "Unknown option: " << arg << std::endl;
        return 1;
      }
    }
 
    // Assign values to variables based on parsed arguments
    if (args.count("-p"))
      image_probe = args["-p"];
    if (args.count("-d"))
      solver_palm_detect = args["-d"];
    if (args.count("-i"))
      solver_palm_liveness = args["-i"];
    if (args.count("-t"))
      detection_threshold = std::stof(args["-t"]);
 
    utils::printFormatted("PARAMETERS");
    // Print resource names
    std::cout << "Probe image: " << image_probe << std::endl;
 
    // Print solver names
    std::cout << "Palm detection solver: " << solver_palm_detect << std::endl;
    std::cout << "Palm liveness solver: " << solver_palm_liveness << std::endl;
 
    // Print other options
    std::cout << "Detection threshold: " << detection_threshold << std::endl;
  }
 
  utils::printToolkitInfo();
 
  SFEError error{};
 
  SFESolver detector_solver{};
  DEFER(sfeSolverFree(detector_solver));
  SFESolver liveness_solver{};
  DEFER(sfeSolverFree(liveness_solver));
  { // STAGE 1: loading solvers
    utils::printFormatted("LOADING solvers");
    // Initialize palm detection solver
    error = sfeSolverCreate(
        solver_palm_detect.c_str(), SOLVER_PARAMETERS.data(),
        SOLVER_PARAMETERS.size(), &detector_solver);
    utils::checkError(error);
 
    // Initialize palm liveness solver
    error = sfeSolverCreate(
        solver_palm_liveness.c_str(), SOLVER_PARAMETERS.data(),
        SOLVER_PARAMETERS.size(), &liveness_solver);
    utils::checkError(error);
  }
 
  SFEImage image{};
  DEFER(sfeImageFree(image));
  { // STAGE 2: Load image
 
    utils::printFormatted("PALM DETECTION");
    // Load image data from file
    auto image_data = utils::readFile(image_probe);
 
    // Decode image from data
    error = sfeImageDecode(image_data.data(), image_data.size(), &image);
    utils::checkError(error);
  }
  SFEDetection detected_palm = {};
  { // STAGE 3: Detect palm in the image
    size_t detection_count = 1;
    // Detect palm in the image
    error = sfeDetect(detector_solver, image, detection_threshold,
                          &detected_palm, &detection_count);
    utils::checkError(error);
 
    if (detection_count == 0) {
      std::cout << "No palm detected in the probe image." << std::endl;
      return 0;
    } else {
      std::cout << "Found " << detection_count
                << " palm(s) in the probe image. Using the palm with highest "
                   "confidence."
                << std::endl;
    }
  }
 
  printPalmDetectionInfo(detected_palm);
 
  float liveness_score = 0.0f;
  { // STAGE 4: Liveness check
    utils::printFormatted("LIVENESS CHECK");
    error = sfePalmLivenessPassive(liveness_solver, image, &detected_palm,
                                   &liveness_score);
    utils::checkError(error);
  }
  { // STAGE 5: Print the liveness score
    std::cout << "Liveness score is " << liveness_score;
    // Recommended threshold for liveness score, see EER threshold for palm liveness in the documentation
    static const float LIVENESS_THRESHOLD = 0.8189f;
    if (liveness_score < LIVENESS_THRESHOLD) {
      std::cout << " which is below " << LIVENESS_THRESHOLD
                << " threshold. Palm is spoof." << std::endl;
    } else {
      std::cout << " which is above " << LIVENESS_THRESHOLD
                << " threshold. Palm is genuine." << std::endl;
    }
  }
 
  { // STAGE 6: Annotate the image
    // Render bounding box
    std::stringstream label;
    label << "Palm" << std::fixed << std::setprecision(2)
          << " d:" << detected_palm.confidence << " l:" << liveness_score;
 
    annotate::labelBox(image, label.str(), detected_palm.bounding_box,
                       annotate::WHITE, annotate::GREEN);
 
    // Save annotated image
    size_t size = image.width * image.height * 3;
    auto png_file = std::vector<unsigned char>(size);
    error = sfeImageEncode(image, SFE_IMAGE_FORMAT_PNG, png_file.data(), &size);
    utils::checkError(error);
    png_file.resize(size);
    utils::saveFile("palm_liveness.png", png_file);
 
    std::cout << std::endl;
    std::cout << "Annotated image saved to palm_liveness.png" << std::endl;
  }
  utils::printFormatted("FINISHED");
}