Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
|
Used to specify a constraint on the total capture time for the settings suggested by the Capture Assistant, and optionally specify the ambient light frequency. More...
#include <Zivid/CaptureAssistant/SuggestSettingsParameters.h>
Classes | |
class | AmbientLightFrequency |
Adapt suggested settings to the ambient light frequency. This can be used to avoid artifacts in the point cloud due to AC powered ambient light being mixed in with the camera's projector light. More... | |
class | MaxCaptureTime |
Capture time budget. This budget assumes a high-end computer meeting Zivid's recommendations. The actual capture time may differ, based on your computer's performance and (for Zivid Two) your network connection speed. More... | |
Public Types | |
using | Descendants = std::tuple< SuggestSettingsParameters::AmbientLightFrequency, SuggestSettingsParameters::MaxCaptureTime > |
Public Member Functions | |
SuggestSettingsParameters () | |
Default constructor More... | |
SuggestSettingsParameters (const std::string &fileName) | |
Construct SuggestSettingsParameters by loading from file More... | |
template<typename... Args> | |
SuggestSettingsParameters (Args &&...args) | |
Constructor taking variadic number of arguments More... | |
template<typename... Args> | |
void | set (Args &&...args) |
Set multiple arguments More... | |
template<typename... Args> | |
SuggestSettingsParameters | copyWith (Args &&...args) const |
Returns a copy of this object with the given argument(s) set to the new value(s) More... | |
const AmbientLightFrequency & | ambientLightFrequency () const |
Get AmbientLightFrequency More... | |
AmbientLightFrequency & | ambientLightFrequency () |
Get AmbientLightFrequency More... | |
SuggestSettingsParameters & | set (const AmbientLightFrequency &value) |
Set AmbientLightFrequency More... | |
const MaxCaptureTime & | maxCaptureTime () const |
Get MaxCaptureTime More... | |
MaxCaptureTime & | maxCaptureTime () |
Get MaxCaptureTime More... | |
SuggestSettingsParameters & | set (const MaxCaptureTime &value) |
Set MaxCaptureTime More... | |
template<typename T , typename std::enable_if< std::is_same< T, SuggestSettingsParameters::AmbientLightFrequency >::value, int >::type = 0> | |
const SuggestSettingsParameters::AmbientLightFrequency & | get () const |
template<typename T , typename std::enable_if< std::is_same< T, SuggestSettingsParameters::MaxCaptureTime >::value, int >::type = 0> | |
const SuggestSettingsParameters::MaxCaptureTime & | get () const |
template<size_t i, typename std::enable_if< i==0, int >::type = 0> | |
const SuggestSettingsParameters::AmbientLightFrequency & | get () const |
template<size_t i, typename std::enable_if< i==1, int >::type = 0> | |
const SuggestSettingsParameters::MaxCaptureTime & | get () const |
template<typename F > | |
void | forEach (const F &f) const |
Run the given function on each direct member with the value of the member as parameter More... | |
template<typename F > | |
void | forEach (const F &f) |
Run the given function on each direct member with the value of the member as parameter More... | |
bool | operator== (const SuggestSettingsParameters &other) const |
Equality operator More... | |
bool | operator!= (const SuggestSettingsParameters &other) const |
Inequality operator More... | |
std::string | toString () const |
Get the value as string More... | |
void | save (const std::string &fileName) const |
Save to the given file More... | |
void | load (const std::string &fileName) |
Load from the given file More... | |
Static Public Attributes | |
static constexpr DataModel::NodeType | nodeType = DataModel::NodeType::group |
The type of this node More... | |
static constexpr const char * | path { "" } |
The full path for this value More... | |
static constexpr const char * | name { "SuggestSettingsParameters" } |
The name of this value More... | |
static constexpr const char * | description |
The description for this value More... | |
static constexpr size_t | version { 1 } |
Friends | |
struct | DataModel::Detail::Befriend< SuggestSettingsParameters > |
std::ostream & | operator<< (std::ostream &stream, const SuggestSettingsParameters &value) |
Operator to send the value as string to a stream More... | |
Used to specify a constraint on the total capture time for the settings suggested by the Capture Assistant, and optionally specify the ambient light frequency.
using Zivid::CaptureAssistant::SuggestSettingsParameters::Descendants = std::tuple<SuggestSettingsParameters::AmbientLightFrequency, SuggestSettingsParameters::MaxCaptureTime> |
Zivid::CaptureAssistant::SuggestSettingsParameters::SuggestSettingsParameters | ( | ) |
Default constructor
|
explicit |
Construct SuggestSettingsParameters by loading from file
|
inlineexplicit |
Constructor taking variadic number of arguments
One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing SuggestSettingsParameters
then invoking set(args)
.
The provided arguments must be descendants of SuggestSettingsParameters
. These types can be provided:
|
inline |
|
inline |
|
inline |
Returns a copy of this object with the given argument(s) set to the new value(s)
Creates a copy of this SuggestSettingsParameters object, then invokes set(args)
on the copy, and finally returns the copy. This method does not modify the original object.
The provided arguments must be descendants of SuggestSettingsParameters
. These types can be provided:
|
inline |
Run the given function on each direct member with the value of the member as parameter
|
inline |
Run the given function on each direct member with the value of the member as parameter
|
inline |
|
inline |
|
inline |
|
inline |
void Zivid::CaptureAssistant::SuggestSettingsParameters::load | ( | const std::string & | fileName | ) |
Load from the given file
|
inline |
Get MaxCaptureTime
|
inline |
Get MaxCaptureTime
bool Zivid::CaptureAssistant::SuggestSettingsParameters::operator!= | ( | const SuggestSettingsParameters & | other | ) | const |
Inequality operator
bool Zivid::CaptureAssistant::SuggestSettingsParameters::operator== | ( | const SuggestSettingsParameters & | other | ) | const |
Equality operator
void Zivid::CaptureAssistant::SuggestSettingsParameters::save | ( | const std::string & | fileName | ) | const |
Save to the given file
|
inline |
Set multiple arguments
The method invokes set(arg)
with each of the provided arguments.
The provided arguments must be descendants of SuggestSettingsParameters
. These types can be provided:
|
inline |
|
inline |
Set MaxCaptureTime
std::string Zivid::CaptureAssistant::SuggestSettingsParameters::toString | ( | ) | const |
Get the value as string
|
friend |
|
friend |
Operator to send the value as string to a stream
|
staticconstexpr |
The description for this value
|
staticconstexpr |
The name of this value
|
staticconstexpr |
The type of this node
|
staticconstexpr |
The full path for this value
|
staticconstexpr |