Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
Public Member Functions | List of all members
Zivid::CaptureAssistant::SuggestSettingsParameters Class Reference

SuggestSettingsParameters class is used to specify time constraint on total capture time for settings suggested by Capture Assistant functionality. A PC with recommended compute power or better is assumed. It is also used to optionally set ambient light frequency adaptation. More...

#include <Zivid/CaptureAssistant.h>

Public Member Functions

ZIVID_API_EXPORT SuggestSettingsParameters (std::chrono::milliseconds maxCaptureTime)
 Constructor that reads ambient light conditions from system configuration More...
 
ZIVID_API_EXPORT SuggestSettingsParameters (std::chrono::milliseconds maxCaptureTime, AmbientLightFrequency ambientLightFrequency)
 Constructor More...
 
ZIVID_API_EXPORT std::chrono::milliseconds maxCaptureTime () const
 Get capture-time budget More...
 
ZIVID_API_EXPORT AmbientLightFrequency ambientLightFrequency () const
 Get ambient light frequency More...
 
ZIVID_API_EXPORT std::string toString () const
 Get string representation of this SuggestSettingsParameters More...
 

Detailed Description

SuggestSettingsParameters class is used to specify time constraint on total capture time for settings suggested by Capture Assistant functionality. A PC with recommended compute power or better is assumed. It is also used to optionally set ambient light frequency adaptation.

Constructor & Destructor Documentation

◆ SuggestSettingsParameters() [1/2]

ZIVID_API_EXPORT Zivid::CaptureAssistant::SuggestSettingsParameters::SuggestSettingsParameters ( std::chrono::milliseconds  maxCaptureTime)

Constructor that reads ambient light conditions from system configuration

◆ SuggestSettingsParameters() [2/2]

ZIVID_API_EXPORT Zivid::CaptureAssistant::SuggestSettingsParameters::SuggestSettingsParameters ( std::chrono::milliseconds  maxCaptureTime,
AmbientLightFrequency  ambientLightFrequency 
)

Constructor

Member Function Documentation

◆ ambientLightFrequency()

ZIVID_API_EXPORT AmbientLightFrequency Zivid::CaptureAssistant::SuggestSettingsParameters::ambientLightFrequency ( ) const

Get ambient light frequency

◆ maxCaptureTime()

ZIVID_API_EXPORT std::chrono::milliseconds Zivid::CaptureAssistant::SuggestSettingsParameters::maxCaptureTime ( ) const

Get capture-time budget

◆ toString()

ZIVID_API_EXPORT std::string Zivid::CaptureAssistant::SuggestSettingsParameters::toString ( ) const

Get string representation of this SuggestSettingsParameters


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