Settings used when capturing with a Zivid camera More...

#include <Zivid/Settings.h>

Classes
class	Acquisition
	Settings for a single acquisition More...

class	Acquisitions
	List of Acquisition objects More...

class	Diagnostics
	When Diagnostics is enabled, extra diagnostic information is recorded during capture. This extra information is included when saving the frame to a .zdf file, and will help Zivid's support team to provide better assistance. More...

class	Experimental
	Experimental features. These settings may be changed, renamed, moved or deleted in the future. More...

class	Processing
	Settings related to processing of a capture, including filters and color balance More...

Public Types
using	Descendants = std::tuple< Settings::Acquisitions, Settings::Diagnostics, Settings::Diagnostics::Enabled, Settings::Experimental, Settings::Experimental::Engine, Settings::Processing, Settings::Processing::Color, Settings::Processing::Color::Balance, Settings::Processing::Color::Balance::Blue, Settings::Processing::Color::Balance::Green, Settings::Processing::Color::Balance::Red, Settings::Processing::Color::Experimental, Settings::Processing::Color::Experimental::Mode, Settings::Processing::Color::Gamma, Settings::Processing::Filters, Settings::Processing::Filters::Experimental, Settings::Processing::Filters::Experimental::ContrastDistortion, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold, Settings::Processing::Filters::Noise, Settings::Processing::Filters::Noise::Removal, Settings::Processing::Filters::Noise::Removal::Enabled, Settings::Processing::Filters::Noise::Removal::Threshold, Settings::Processing::Filters::Outlier, Settings::Processing::Filters::Outlier::Removal, Settings::Processing::Filters::Outlier::Removal::Enabled, Settings::Processing::Filters::Outlier::Removal::Threshold, Settings::Processing::Filters::Reflection, Settings::Processing::Filters::Reflection::Removal, Settings::Processing::Filters::Reflection::Removal::Enabled, Settings::Processing::Filters::Reflection::Removal::Experimental, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode, Settings::Processing::Filters::Smoothing, Settings::Processing::Filters::Smoothing::Gaussian, Settings::Processing::Filters::Smoothing::Gaussian::Enabled, Settings::Processing::Filters::Smoothing::Gaussian::Sigma >

Public Member Functions
	Settings ()
	Default constructor More...

	Settings (const std::string &fileName)
	Construct Settings by loading from file More...

template<typename... Args>
	Settings (Args &&...args)
	Constructor taking variadic number of arguments More...

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments More...

template<typename... Args>
Settings	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s) More...

const Acquisitions &	acquisitions () const
	Get Acquisitions More...

Acquisitions &	acquisitions ()
	Get Acquisitions More...

Settings &	set (const Acquisitions &value)
	Set Acquisitions More...

const Diagnostics &	diagnostics () const
	Get Diagnostics More...

Diagnostics &	diagnostics ()
	Get Diagnostics More...

Settings &	set (const Diagnostics &value)
	Set Diagnostics More...

Settings &	set (const Diagnostics::Enabled &value)
	Set Diagnostics::Enabled More...

const Experimental &	experimental () const
	Get Experimental More...

Experimental &	experimental ()
	Get Experimental More...

Settings &	set (const Experimental &value)
	Set Experimental More...

Settings &	set (const Experimental::Engine &value)
	Set Experimental::Engine More...

const Processing &	processing () const
	Get Processing More...

Processing &	processing ()
	Get Processing More...

Settings &	set (const Processing &value)
	Set Processing More...

Settings &	set (const Processing::Color &value)
	Set Processing::Color More...

Settings &	set (const Processing::Color::Balance &value)
	Set Processing::Color::Balance More...

Settings &	set (const Processing::Color::Balance::Blue &value)
	Set Processing::Color::Balance::Blue More...

Settings &	set (const Processing::Color::Balance::Green &value)
	Set Processing::Color::Balance::Green More...

Settings &	set (const Processing::Color::Balance::Red &value)
	Set Processing::Color::Balance::Red More...

Settings &	set (const Processing::Color::Experimental &value)
	Set Processing::Color::Experimental More...

Settings &	set (const Processing::Color::Experimental::Mode &value)
	Set Processing::Color::Experimental::Mode More...

Settings &	set (const Processing::Color::Gamma &value)
	Set Processing::Color::Gamma More...

Settings &	set (const Processing::Filters &value)
	Set Processing::Filters More...

Settings &	set (const Processing::Filters::Experimental &value)
	Set Processing::Filters::Experimental More...

Settings &	set (const Processing::Filters::Experimental::ContrastDistortion &value)
	Set Processing::Filters::Experimental::ContrastDistortion More...

Settings &	set (const Processing::Filters::Experimental::ContrastDistortion::Correction &value)
	Set Processing::Filters::Experimental::ContrastDistortion::Correction More...

Settings &	set (const Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled &value)
	Set Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled More...

Settings &	set (const Processing::Filters::Experimental::ContrastDistortion::Correction::Strength &value)
	Set Processing::Filters::Experimental::ContrastDistortion::Correction::Strength More...

Settings &	set (const Processing::Filters::Experimental::ContrastDistortion::Removal &value)
	Set Processing::Filters::Experimental::ContrastDistortion::Removal More...

Settings &	set (const Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled &value)
	Set Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled More...

Settings &	set (const Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold &value)
	Set Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold More...

Settings &	set (const Processing::Filters::Noise &value)
	Set Processing::Filters::Noise More...

Settings &	set (const Processing::Filters::Noise::Removal &value)
	Set Processing::Filters::Noise::Removal More...

Settings &	set (const Processing::Filters::Noise::Removal::Enabled &value)
	Set Processing::Filters::Noise::Removal::Enabled More...

Settings &	set (const Processing::Filters::Noise::Removal::Threshold &value)
	Set Processing::Filters::Noise::Removal::Threshold More...

Settings &	set (const Processing::Filters::Outlier &value)
	Set Processing::Filters::Outlier More...

Settings &	set (const Processing::Filters::Outlier::Removal &value)
	Set Processing::Filters::Outlier::Removal More...

Settings &	set (const Processing::Filters::Outlier::Removal::Enabled &value)
	Set Processing::Filters::Outlier::Removal::Enabled More...

Settings &	set (const Processing::Filters::Outlier::Removal::Threshold &value)
	Set Processing::Filters::Outlier::Removal::Threshold More...

Settings &	set (const Processing::Filters::Reflection &value)
	Set Processing::Filters::Reflection More...

Settings &	set (const Processing::Filters::Reflection::Removal &value)
	Set Processing::Filters::Reflection::Removal More...

Settings &	set (const Processing::Filters::Reflection::Removal::Enabled &value)
	Set Processing::Filters::Reflection::Removal::Enabled More...

Settings &	set (const Processing::Filters::Reflection::Removal::Experimental &value)
	Set Processing::Filters::Reflection::Removal::Experimental More...

Settings &	set (const Processing::Filters::Reflection::Removal::Experimental::Mode &value)
	Set Processing::Filters::Reflection::Removal::Experimental::Mode More...

Settings &	set (const Processing::Filters::Smoothing &value)
	Set Processing::Filters::Smoothing More...

Settings &	set (const Processing::Filters::Smoothing::Gaussian &value)
	Set Processing::Filters::Smoothing::Gaussian More...

Settings &	set (const Processing::Filters::Smoothing::Gaussian::Enabled &value)
	Set Processing::Filters::Smoothing::Gaussian::Enabled More...

Settings &	set (const Processing::Filters::Smoothing::Gaussian::Sigma &value)
	Set Processing::Filters::Smoothing::Gaussian::Sigma More...

template<typename T , typename std::enable_if< std::is_same< T, Settings::Acquisitions >::value, int >::type = 0>
const Settings::Acquisitions &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics >::value, int >::type = 0>
const Settings::Diagnostics &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics::Enabled >::value, int >::type = 0>
const Settings::Diagnostics::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental >::value, int >::type = 0>
const Settings::Experimental &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental::Engine >::value, int >::type = 0>
const Settings::Experimental::Engine &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing >::value, int >::type = 0>
const Settings::Processing &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color >::value, int >::type = 0>
const Settings::Processing::Color &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance >::value, int >::type = 0>
const Settings::Processing::Color::Balance &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Blue >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Blue &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Green >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Green &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Red >::value, int >::type = 0>
const Settings::Processing::Color::Balance::Red &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental >::value, int >::type = 0>
const Settings::Processing::Color::Experimental &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental::Mode >::value, int >::type = 0>
const Settings::Processing::Color::Experimental::Mode &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Gamma >::value, int >::type = 0>
const Settings::Processing::Color::Gamma &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters >::value, int >::type = 0>
const Settings::Processing::Filters &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise >::value, int >::type = 0>
const Settings::Processing::Filters::Noise &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Noise::Removal::Threshold &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Threshold >::value, int >::type = 0>
const Settings::Processing::Filters::Outlier::Removal::Threshold &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Experimental &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode >::value, int >::type = 0>
const Settings::Processing::Filters::Reflection::Removal::Experimental::Mode &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Sigma >::value, int >::type = 0>
const Settings::Processing::Filters::Smoothing::Gaussian::Sigma &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Acquisitions &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Diagnostics &	get () const

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Experimental &	get () const

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings::Processing &	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 Settings &other) const
	Equality operator More...

bool	operator!= (const Settings &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 { "Settings" }
	The name of this value More...

static constexpr const char *	description
	The description for this value More...

static constexpr size_t	version { 12 }

Friends
struct	DataModel::Detail::Befriend< Settings >

std::ostream &	operator<< (std::ostream &stream, const Settings &value)
	Operator to send the value as string to a stream More...

Detailed Description

Settings used when capturing with a Zivid camera

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Settings() [1/3]

Zivid::Settings::Settings ( )

Default constructor

◆ Settings() [2/3]

Zivid::Settings::Settings ( const std::string & fileName )

explicit

Construct Settings by loading from file

◆ Settings() [3/3]

template<typename... Args>

Zivid::Settings::Settings ( Args &&... args )

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 Settings then invoking set(args).

The provided arguments must be descendants of Settings. These types can be provided:

Member Function Documentation

◆ acquisitions() [1/2]

Acquisitions & Zivid::Settings::acquisitions ( )

inline

Get Acquisitions

◆ acquisitions() [2/2]

const Acquisitions & Zivid::Settings::acquisitions ( ) const

inline

Get Acquisitions

◆ copyWith()

template<typename... Args>

Settings Zivid::Settings::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Settings 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 Settings. These types can be provided:

◆ diagnostics() [1/2]

Diagnostics & Zivid::Settings::diagnostics ( )

inline

Get Diagnostics

◆ diagnostics() [2/2]

const Diagnostics & Zivid::Settings::diagnostics ( ) const

inline

Get Diagnostics

◆ experimental() [1/2]

Experimental & Zivid::Settings::experimental ( )

inline

Get Experimental

◆ experimental() [2/2]

const Experimental & Zivid::Settings::experimental ( ) const

inline

Get Experimental

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter

◆ forEach() [2/2]

template<typename F >

void Zivid::Settings::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter

◆ get() [1/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Acquisitions >::value, int >::type = 0>

const Settings::Acquisitions & Zivid::Settings::get ( ) const

inline

◆ get() [2/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics >::value, int >::type = 0>

const Settings::Diagnostics & Zivid::Settings::get ( ) const

inline

◆ get() [3/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics::Enabled >::value, int >::type = 0>

const Settings::Diagnostics::Enabled & Zivid::Settings::get ( ) const

inline

◆ get() [4/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental >::value, int >::type = 0>

const Settings::Experimental & Zivid::Settings::get ( ) const

inline

◆ get() [5/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental::Engine >::value, int >::type = 0>

const Settings::Experimental::Engine & Zivid::Settings::get ( ) const

inline

◆ get() [6/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing >::value, int >::type = 0>

const Settings::Processing & Zivid::Settings::get ( ) const

inline

◆ get() [7/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color >::value, int >::type = 0>

const Settings::Processing::Color & Zivid::Settings::get ( ) const

inline

◆ get() [8/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance >::value, int >::type = 0>

const Settings::Processing::Color::Balance & Zivid::Settings::get ( ) const

inline

◆ get() [9/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Blue >::value, int >::type = 0>

const Settings::Processing::Color::Balance::Blue & Zivid::Settings::get ( ) const

inline

◆ get() [10/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Green >::value, int >::type = 0>

const Settings::Processing::Color::Balance::Green & Zivid::Settings::get ( ) const

inline

◆ get() [11/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Red >::value, int >::type = 0>

const Settings::Processing::Color::Balance::Red & Zivid::Settings::get ( ) const

inline

◆ get() [12/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental >::value, int >::type = 0>

const Settings::Processing::Color::Experimental & Zivid::Settings::get ( ) const

inline

◆ get() [13/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental::Mode >::value, int >::type = 0>

const Settings::Processing::Color::Experimental::Mode & Zivid::Settings::get ( ) const

inline

◆ get() [14/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Gamma >::value, int >::type = 0>

const Settings::Processing::Color::Gamma & Zivid::Settings::get ( ) const

inline

◆ get() [15/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters >::value, int >::type = 0>

const Settings::Processing::Filters & Zivid::Settings::get ( ) const

inline

◆ get() [16/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental & Zivid::Settings::get ( ) const

inline

◆ get() [17/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion & Zivid::Settings::get ( ) const

inline

◆ get() [18/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction & Zivid::Settings::get ( ) const

inline

◆ get() [19/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled & Zivid::Settings::get ( ) const

inline

◆ get() [20/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength & Zivid::Settings::get ( ) const

inline

◆ get() [21/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal & Zivid::Settings::get ( ) const

inline

◆ get() [22/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled & Zivid::Settings::get ( ) const

inline

◆ get() [23/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold >::value, int >::type = 0>

const Settings::Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold & Zivid::Settings::get ( ) const

inline

◆ get() [24/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise >::value, int >::type = 0>

const Settings::Processing::Filters::Noise & Zivid::Settings::get ( ) const

inline

◆ get() [25/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal >::value, int >::type = 0>

const Settings::Processing::Filters::Noise::Removal & Zivid::Settings::get ( ) const

inline

◆ get() [26/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Noise::Removal::Enabled & Zivid::Settings::get ( ) const

inline

◆ get() [27/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Noise::Removal::Threshold >::value, int >::type = 0>

const Settings::Processing::Filters::Noise::Removal::Threshold & Zivid::Settings::get ( ) const

inline

◆ get() [28/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier >::value, int >::type = 0>

const Settings::Processing::Filters::Outlier & Zivid::Settings::get ( ) const

inline

◆ get() [29/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal >::value, int >::type = 0>

const Settings::Processing::Filters::Outlier::Removal & Zivid::Settings::get ( ) const

inline

◆ get() [30/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Outlier::Removal::Enabled & Zivid::Settings::get ( ) const

inline

◆ get() [31/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Outlier::Removal::Threshold >::value, int >::type = 0>

const Settings::Processing::Filters::Outlier::Removal::Threshold & Zivid::Settings::get ( ) const

inline

◆ get() [32/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection >::value, int >::type = 0>

const Settings::Processing::Filters::Reflection & Zivid::Settings::get ( ) const

inline

◆ get() [33/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal >::value, int >::type = 0>

const Settings::Processing::Filters::Reflection::Removal & Zivid::Settings::get ( ) const

inline

◆ get() [34/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Reflection::Removal::Enabled & Zivid::Settings::get ( ) const

inline

◆ get() [35/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental >::value, int >::type = 0>

const Settings::Processing::Filters::Reflection::Removal::Experimental & Zivid::Settings::get ( ) const

inline

◆ get() [36/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Reflection::Removal::Experimental::Mode >::value, int >::type = 0>

const Settings::Processing::Filters::Reflection::Removal::Experimental::Mode & Zivid::Settings::get ( ) const

inline

◆ get() [37/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing >::value, int >::type = 0>

const Settings::Processing::Filters::Smoothing & Zivid::Settings::get ( ) const

inline

◆ get() [38/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian >::value, int >::type = 0>

const Settings::Processing::Filters::Smoothing::Gaussian & Zivid::Settings::get ( ) const

inline

◆ get() [39/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Enabled >::value, int >::type = 0>

const Settings::Processing::Filters::Smoothing::Gaussian::Enabled & Zivid::Settings::get ( ) const

inline

◆ get() [40/44]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Smoothing::Gaussian::Sigma >::value, int >::type = 0>

const Settings::Processing::Filters::Smoothing::Gaussian::Sigma & Zivid::Settings::get ( ) const

inline

◆ get() [41/44]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const Settings::Acquisitions & Zivid::Settings::get ( ) const

inline

◆ get() [42/44]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const Settings::Diagnostics & Zivid::Settings::get ( ) const

inline

◆ get() [43/44]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>

const Settings::Experimental & Zivid::Settings::get ( ) const

inline

◆ get() [44/44]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>

const Settings::Processing & Zivid::Settings::get ( ) const

inline

◆ load()

void Zivid::Settings::load ( const std::string & fileName )

Load from the given file

◆ operator!=()

bool Zivid::Settings::operator!= ( const Settings & other ) const

Inequality operator

◆ operator==()

bool Zivid::Settings::operator== ( const Settings & other ) const

Equality operator

◆ processing() [1/2]

Processing & Zivid::Settings::processing ( )

inline

Get Processing

◆ processing() [2/2]

const Processing & Zivid::Settings::processing ( ) const

inline

Get Processing

◆ save()

void Zivid::Settings::save ( const std::string & fileName ) const

Save to the given file

◆ set() [1/41]

template<typename... Args>

void Zivid::Settings::set ( Args &&... args )

inline

Set multiple arguments

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Settings. These types can be provided:

◆ set() [2/41]

Settings & Zivid::Settings::set ( const Acquisitions & value )

inline

Set Acquisitions

◆ set() [3/41]

Settings & Zivid::Settings::set ( const Diagnostics & value )

inline

Set Diagnostics

◆ set() [4/41]

Settings & Zivid::Settings::set ( const Diagnostics::Enabled & value )

inline

Set Diagnostics::Enabled

◆ set() [5/41]

Settings & Zivid::Settings::set ( const Experimental & value )

inline

Set Experimental

◆ set() [6/41]

Settings & Zivid::Settings::set ( const Experimental::Engine & value )

inline

Set Experimental::Engine

◆ set() [7/41]

Settings & Zivid::Settings::set ( const Processing & value )

inline

Set Processing

◆ set() [8/41]

Settings & Zivid::Settings::set ( const Processing::Color & value )

inline

Set Processing::Color

◆ set() [9/41]

Settings & Zivid::Settings::set ( const Processing::Color::Balance & value )

inline

Set Processing::Color::Balance

◆ set() [10/41]

Settings & Zivid::Settings::set ( const Processing::Color::Balance::Blue & value )

inline

Set Processing::Color::Balance::Blue

◆ set() [11/41]

Settings & Zivid::Settings::set ( const Processing::Color::Balance::Green & value )

inline

Set Processing::Color::Balance::Green

◆ set() [12/41]

Settings & Zivid::Settings::set ( const Processing::Color::Balance::Red & value )

inline

Set Processing::Color::Balance::Red

◆ set() [13/41]

Settings & Zivid::Settings::set ( const Processing::Color::Experimental & value )

inline

Set Processing::Color::Experimental

◆ set() [14/41]

Settings & Zivid::Settings::set ( const Processing::Color::Experimental::Mode & value )

inline

Set Processing::Color::Experimental::Mode

◆ set() [15/41]

Settings & Zivid::Settings::set ( const Processing::Color::Gamma & value )

inline

Set Processing::Color::Gamma

◆ set() [16/41]

Settings & Zivid::Settings::set ( const Processing::Filters & value )

inline

Set Processing::Filters

◆ set() [17/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental & value )

inline

Set Processing::Filters::Experimental

◆ set() [18/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion & value )

inline

Set Processing::Filters::Experimental::ContrastDistortion

◆ set() [19/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Correction & value )

inline

Set Processing::Filters::Experimental::ContrastDistortion::Correction

◆ set() [20/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled & value )

inline

Set Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled

◆ set() [21/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Correction::Strength & value )

inline

Set Processing::Filters::Experimental::ContrastDistortion::Correction::Strength

◆ set() [22/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Removal & value )

inline

Set Processing::Filters::Experimental::ContrastDistortion::Removal

◆ set() [23/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled & value )

inline

Set Processing::Filters::Experimental::ContrastDistortion::Removal::Enabled

◆ set() [24/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold & value )

inline

Set Processing::Filters::Experimental::ContrastDistortion::Removal::Threshold

◆ set() [25/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise & value )

inline

Set Processing::Filters::Noise

◆ set() [26/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Removal & value )

inline

Set Processing::Filters::Noise::Removal

◆ set() [27/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Removal::Enabled & value )

inline

Set Processing::Filters::Noise::Removal::Enabled

◆ set() [28/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Noise::Removal::Threshold & value )

inline

Set Processing::Filters::Noise::Removal::Threshold

◆ set() [29/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Outlier & value )

inline

Set Processing::Filters::Outlier

◆ set() [30/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Outlier::Removal & value )

inline

Set Processing::Filters::Outlier::Removal

◆ set() [31/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Outlier::Removal::Enabled & value )

inline

Set Processing::Filters::Outlier::Removal::Enabled

◆ set() [32/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Outlier::Removal::Threshold & value )

inline

Set Processing::Filters::Outlier::Removal::Threshold

◆ set() [33/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection & value )

inline

Set Processing::Filters::Reflection

◆ set() [34/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection::Removal & value )

inline

Set Processing::Filters::Reflection::Removal

◆ set() [35/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection::Removal::Enabled & value )

inline

Set Processing::Filters::Reflection::Removal::Enabled

◆ set() [36/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection::Removal::Experimental & value )

inline

Set Processing::Filters::Reflection::Removal::Experimental

◆ set() [37/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Reflection::Removal::Experimental::Mode & value )

inline

Set Processing::Filters::Reflection::Removal::Experimental::Mode

◆ set() [38/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Smoothing & value )

inline

Set Processing::Filters::Smoothing

◆ set() [39/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Smoothing::Gaussian & value )

inline

Set Processing::Filters::Smoothing::Gaussian

◆ set() [40/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Smoothing::Gaussian::Enabled & value )

inline

Set Processing::Filters::Smoothing::Gaussian::Enabled

◆ set() [41/41]

Settings & Zivid::Settings::set ( const Processing::Filters::Smoothing::Gaussian::Sigma & value )

inline

Set Processing::Filters::Smoothing::Gaussian::Sigma

◆ toString()

std::string Zivid::Settings::toString ( ) const

Get the value as string

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Settings >

friend struct DataModel::Detail::Befriend< Settings >

friend

◆ operator<<

std::ostream & operator<<	(	std::ostream &	stream,
		const Settings &	value
	)

friend

Operator to send the value as string to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::description

staticconstexpr

Initial value:

{
            R"description(Settings used when capturing with a Zivid camera)description"
        }

The description for this value

◆ name

constexpr const char* Zivid::Settings::name { "Settings" }

staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::Settings::path { "" }

staticconstexpr

The full path for this value

◆ version

constexpr size_t Zivid::Settings::version { 12 }

staticconstexpr

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

Zivid/Settings.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Settings() [1/3]

◆ Settings() [2/3]

◆ Settings() [3/3]

Member Function Documentation

◆ acquisitions() [1/2]

◆ acquisitions() [2/2]

◆ copyWith()

◆ diagnostics() [1/2]

◆ diagnostics() [2/2]

◆ experimental() [1/2]

◆ experimental() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/44]

◆ get() [2/44]

◆ get() [3/44]

◆ get() [4/44]

◆ get() [5/44]

◆ get() [6/44]

◆ get() [7/44]

◆ get() [8/44]

◆ get() [9/44]

◆ get() [10/44]

◆ get() [11/44]

◆ get() [12/44]

◆ get() [13/44]

◆ get() [14/44]

◆ get() [15/44]

◆ get() [16/44]

◆ get() [17/44]

◆ get() [18/44]

◆ get() [19/44]

◆ get() [20/44]

◆ get() [21/44]

◆ get() [22/44]

◆ get() [23/44]

◆ get() [24/44]

◆ get() [25/44]

◆ get() [26/44]

◆ get() [27/44]

◆ get() [28/44]

◆ get() [29/44]

◆ get() [30/44]

◆ get() [31/44]

◆ get() [32/44]

◆ get() [33/44]

◆ get() [34/44]

◆ get() [35/44]

◆ get() [36/44]

◆ get() [37/44]

◆ get() [38/44]

◆ get() [39/44]

◆ get() [40/44]

◆ get() [41/44]

◆ get() [42/44]

◆ get() [43/44]

◆ get() [44/44]

◆ load()

◆ operator!=()

◆ operator==()

◆ processing() [1/2]

◆ processing() [2/2]

◆ save()

◆ set() [1/41]

◆ set() [2/41]

◆ set() [3/41]

◆ set() [4/41]

◆ set() [5/41]

◆ set() [6/41]

◆ set() [7/41]

◆ set() [8/41]