Skip to content

Latest commit

 

History

History
139 lines (118 loc) · 6.33 KB

README.md

File metadata and controls

139 lines (118 loc) · 6.33 KB

Smart Spectra C++ Examples

This repository holds usage examples for the Smart Spectra C++ SDK, which demonstrate how to use the SDK in various C++ applications to obtain physiological metrics, i.e. pulse an breathing rate, from different forms of visual input.

Table of Contents

Supported Systems & Architectures

We currently provide packages only for Linux Debian, Ubuntu, and Mint distributions running on amd64/x86_64 architecture. However, we plan to support the following in the near future:

Package Type (OS List) CPU Architecture (System Type)
Debian (Debian/Ubuntu/Mint) amd64,arm64 (linux)
RPM (RHEL/Fedora) x86_64,aarch64 (linux)
Bundle (MacOS X) arm64e (darwin)

Windows support is may be added in future versions depending on demand.

Smart Spectra C++ SDK Setup Guide

Debian / Ubuntu/ Linux Mint

Installing Build Tools

  1. CMake 3.22.1 or newer is required. You can typically install cmake via sudo apt install cmake. If your system-default cmake is older (run cmake --version to check this), follow the directions from Kitware (publishers of CMake) to get it set up if your cmake version is below the requirement.
  2. Ninja 1.10 or newer is recommended. Run sudo apt install ninja-build to install it. If you choose not to do so, you can still use make to build. Ensure you have that installed (sudo apt-install build-essential).

Setting up the Presage Personal Package Archive (PPA)

You'll want to set up the Presage PPA to be able to install and update the Smart Spectra C++ SDK. You'll only need to do this once on your system.

Run the following commands in your terminal.

  1. Download the GPG key: 
    curl -s "https://presage-security.github.io/PPA/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/presage-technologies.gpg >/dev/null
  2. Copy the PPA list: 
    sudo curl -s --compressed -o /etc/apt/sources.list.d/presage-technologies.list "https://presage-security.github.io/PPA/presage-technologies.list"

Installing/Upgrading the Smart Spectra C++ SDK

  1. Update the apt database: 
    sudo apt update
  2. Install (or upgrade) the SDK: 
    sudo apt install libsmartspectra-dev

Building and Running Smart Spectra C++ Examples

Building

  1. Clone this repository.
  2. Build the examples using either Ninja or Make.
    • Using Ninja: 
      mkdir build
cd build
cmake -G Ninja ..
ninja
    • Using Make: 
      mkdir build
cd build
cmake -G Ninja ..
ninja

Running

  1. Register and obtain the Presage Technologies Physiology API key from https://physiology.presagetech.com/
  2. Run the C++ rest example (substitute <YOUR_API_KEY> with your Physiology REST API key): 
    rest_spot_example/rest_spot_example --also_log_to_stderr \
  --camera_device_index=0 --auto_lock=false --physiology_key=<YOUR_API_KEY_HERE>

Command Line Interface

To list and read about all available command line options for an example, pass --help=main to terminal command, e.g.:

    rest_spot_example/rest_spot_example --help=main

To read about a specific command line option, pass --help=<OPTION_NAME> to terminal command, e.g.:

    rest_spot_example/rest_spot_example --help=use_gpu

Keyboard Shortcuts

During the run, use the following keyboard shortcuts:

  • q or ESC: exit
  • s: start/stop recording data (webcam input / streaming mode only)
  • e: lock/unlock exposure (webcam input / streaming mode only)
  • - and =: decrease or increase exposure (webcam input / streaming mode only, and only when exposure is locked)

See documentation for the --auto_loc option by passing --help=auto_loc for more details about locking the camera exposure.

Developing Your Own Smart Spectra C++ Application

More examples, tutorials, and reference documentation are coming soon!

In the meantime, please consult the REST spot examples. The gRPC example may become more useful in the future, when we provide access to our Physiology gRPC API. The Image File Folder example shows how you can read images from a folder. However, the continuous API is not currently available to the public.

The following code in the minimal REST spot example demonstrates how you can add your own callback to process / display the data:

container.OnMetricsOutput = [](const nlohmann::json& metrics) {
    LOG(INFO) << "Got metrics from Physiology REST API: " << metrics;
    return absl::OkStatus();
};

For the actual format of metrics (raw JSON object), please consult the Output Format Guide.

The following code in the full REST spot example demonstrates how to convert the json to an easier-to-consume Metrics struct:

container.OnMetricsOutput = [](const nlohmann::json& api_json_metrics) {
    auto metrics_or_status = spectra::formats::MetricsFromRestApiJson(api_json_metrics);
    if (!metrics_or_status.ok()) {
        return metrics_or_status.status();
    }
    spectra::formats::Metrics metrics = metrics_or_status.value();
    nlohmann::json metrics_nice_json{metrics};
    LOG(INFO) << "Got metrics from Physiology REST API: " << metrics_nice_json.dump(2);
    return absl::OkStatus();
};

For the actual format of metrics (formatted Struct), please consult the Output Format Guide.