Zivid C++ API 2.18.0+1b44dbef-1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings2D Class Reference

Settings used when capturing 2D images with a Zivid camera. More...

#include <Zivid/Settings2D.h>

Classes

class  Acquisition
 Settings for one 2D acquisition. More...
class  Acquisitions
 List of acquisitions used for 2D capture. More...
class  Diagnostics
 When Diagnostics is enabled, additional diagnostic data is recorded during capture and included when saving the frame to a .zdf file. This enables Zivid's Customer Success team to provide better assistance and more thorough troubleshooting. More...
class  Processing
 2D processing settings. More...
class  Sampling
 Sampling settings. More...

Public Types

using Descendants

Public Member Functions

 Settings2D ()
 Default constructor.
 Settings2D (const std::string &fileName)
 Construct Settings2D by loading from file.
std::string serialize () const
 Serialize to a string.
template<typename... Args>
 Settings2D (Args &&...args)
 Constructor taking variadic number of arguments.
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
template<typename... Args>
Settings2D copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
const Acquisitions & acquisitions () const
 Get Acquisitions.
Acquisitions & acquisitions ()
 Get Acquisitions.
Settings2D & set (const Acquisitions &value)
 Set Acquisitions.
const Diagnostics & diagnostics () const
 Get Diagnostics.
Diagnostics & diagnostics ()
 Get Diagnostics.
Settings2D & set (const Diagnostics &value)
 Set Diagnostics.
Settings2D & set (const Diagnostics::Enabled &value)
 Set Diagnostics::Enabled.
const Processing & processing () const
 Get Processing.
Processing & processing ()
 Get Processing.
Settings2D & set (const Processing &value)
 Set Processing.
Settings2D & set (const Processing::Color &value)
 Set Processing::Color.
Settings2D & set (const Processing::Color::Balance &value)
 Set Processing::Color::Balance.
Settings2D & set (const Processing::Color::Balance::Blue &value)
 Set Processing::Color::Balance::Blue.
Settings2D & set (const Processing::Color::Balance::Green &value)
 Set Processing::Color::Balance::Green.
Settings2D & set (const Processing::Color::Balance::Red &value)
 Set Processing::Color::Balance::Red.
Settings2D & set (const Processing::Color::Experimental &value)
 Set Processing::Color::Experimental.
Settings2D & set (const Processing::Color::Experimental::Mode &value)
 Set Processing::Color::Experimental::Mode.
Settings2D & set (const Processing::Color::Gamma &value)
 Set Processing::Color::Gamma.
const Sampling & sampling () const
 Get Sampling.
Sampling & sampling ()
 Get Sampling.
Settings2D & set (const Sampling &value)
 Set Sampling.
Settings2D & set (const Sampling::Color &value)
 Set Sampling::Color.
Settings2D & set (const Sampling::Interval &value)
 Set Sampling::Interval.
Settings2D & set (const Sampling::Interval::Duration &value)
 Set Sampling::Interval::Duration.
Settings2D & set (const Sampling::Interval::Enabled &value)
 Set Sampling::Interval::Enabled.
Settings2D & set (const Sampling::Pixel &value)
 Set Sampling::Pixel.
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Acquisitions >::value, int >::type = 0>
const Settings2D::Acquisitions & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Diagnostics >::value, int >::type = 0>
const Settings2D::Diagnostics & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Diagnostics::Enabled >::value, int >::type = 0>
const Settings2D::Diagnostics::Enabled & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing >::value, int >::type = 0>
const Settings2D::Processing & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing::Color >::value, int >::type = 0>
const Settings2D::Processing::Color & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Blue >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Blue & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Green >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Green & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Red >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Red & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Experimental >::value, int >::type = 0>
const Settings2D::Processing::Color::Experimental & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Experimental::Mode >::value, int >::type = 0>
const Settings2D::Processing::Color::Experimental::Mode & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Gamma >::value, int >::type = 0>
const Settings2D::Processing::Color::Gamma & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling >::value, int >::type = 0>
const Settings2D::Sampling & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Color >::value, int >::type = 0>
const Settings2D::Sampling::Color & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Interval >::value, int >::type = 0>
const Settings2D::Sampling::Interval & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Interval::Duration >::value, int >::type = 0>
const Settings2D::Sampling::Interval::Duration & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Interval::Enabled >::value, int >::type = 0>
const Settings2D::Sampling::Interval::Enabled & get () const
template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Pixel >::value, int >::type = 0>
const Settings2D::Sampling::Pixel & get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings2D::Acquisitions & get () const
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings2D::Diagnostics & get () const
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings2D::Processing & get () const
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings2D::Sampling & 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.
template<typename F>
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter.
bool operator== (const Settings2D &other) const
 Equality operator.
bool operator!= (const Settings2D &other) const
 Inequality operator.
std::string toString () const
 Get the value as string.
void save (const std::string &fileName) const
 Save to the given file.
void load (const std::string &fileName)
 Load from the given file.

Static Public Member Functions

static Settings2D fromSerialized (const std::string &value)
 Construct a new Settings2D instance from a previously serialized string.

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node.
static constexpr const char * path { "" }
 The full path for this value.
static constexpr const char * name { "Settings2D" }
 The name of this value.
static constexpr const char * description
 The description for this value.
static constexpr size_t version { 9 }

Friends

struct DataModel::Detail::Befriend< Settings2D >
std::ostream & operator<< (std::ostream &stream, const Settings2D &value)
 Operator to send the value as string to a stream.

Detailed Description

Settings used when capturing 2D images with a Zivid camera.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings2D::Descendants
Initial value:
std::tuple<
Settings2D::Acquisitions,
Settings2D::Diagnostics,
Settings2D::Diagnostics::Enabled,
Settings2D::Processing,
Settings2D::Processing::Color,
Settings2D::Processing::Color::Balance,
Settings2D::Processing::Color::Balance::Blue,
Settings2D::Processing::Color::Balance::Green,
Settings2D::Processing::Color::Balance::Red,
Settings2D::Processing::Color::Experimental,
Settings2D::Processing::Color::Experimental::Mode,
Settings2D::Processing::Color::Gamma,
Settings2D::Sampling,
Settings2D::Sampling::Color,
Settings2D::Sampling::Interval,
Settings2D::Sampling::Interval::Duration,
Settings2D::Sampling::Interval::Enabled,
Settings2D::Sampling::Pixel>
Zivid::Settings2D::Acquisitions
List of acquisitions used for 2D capture.
Definition Settings2D.h:910
Zivid::Settings2D::Diagnostics::Enabled
Enable or disable diagnostics.
Definition Settings2D.h:1105
Zivid::Settings2D::Diagnostics
When Diagnostics is enabled, additional diagnostic data is recorded during capture and included when ...
Definition Settings2D.h:1079
Zivid::Settings2D::Processing::Color::Balance::Blue
Digital gain applied to blue channel.
Definition Settings2D.h:1416
Zivid::Settings2D::Processing::Color::Balance::Green
Digital gain applied to green channel.
Definition Settings2D.h:1528
Zivid::Settings2D::Processing::Color::Balance::Red
Digital gain applied to red channel.
Definition Settings2D.h:1640
Zivid::Settings2D::Processing::Color::Balance
Color balance settings.
Definition Settings2D.h:1398
Zivid::Settings2D::Processing::Color::Experimental::Mode
This setting controls how the color image is computed.
Definition Settings2D.h:2055
Zivid::Settings2D::Processing::Color::Experimental
Experimental color settings. These may be renamed, moved or deleted in the future.
Definition Settings2D.h:2021
Zivid::Settings2D::Processing::Color::Gamma
Gamma applied to the color values. Gamma less than 1 makes the colors brighter, while gamma greater t...
Definition Settings2D.h:2356
Zivid::Settings2D::Processing::Color
Color settings.
Definition Settings2D.h:1380
Zivid::Settings2D::Processing
2D processing settings.
Definition Settings2D.h:1362
Zivid::Settings2D::Sampling::Color
Choose how to sample colors for the 2D image.
Definition Settings2D.h:3169
Zivid::Settings2D::Sampling::Interval::Duration
Duration between successive sensor operations, in microseconds. The effective interval might be round...
Definition Settings2D.h:3329
Zivid::Settings2D::Sampling::Interval::Enabled
Enable or disable sampling interval.
Definition Settings2D.h:3444
Zivid::Settings2D::Sampling::Interval
Sampling interval controls the interval between successive sensor operations (e.g....
Definition Settings2D.h:3299
Zivid::Settings2D::Sampling::Pixel
Set the pixel sampling to use for the 2D capture. This setting defines how the camera sensor is sampl...
Definition Settings2D.h:3749
Zivid::Settings2D::Sampling
Sampling settings.
Definition Settings2D.h:3134

Constructor & Destructor Documentation

◆ Settings2D() [1/3]

Zivid::Settings2D::Settings2D ( )

Default constructor.

◆ Settings2D() [2/3]

Zivid::Settings2D::Settings2D ( const std::string & fileName)
explicit

Construct Settings2D by loading from file.

◆ Settings2D() [3/3]

template<typename... Args>
Zivid::Settings2D::Settings2D ( 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 Settings2D then invoking set(args).

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

Member Function Documentation

◆ acquisitions() [1/2]

Acquisitions & Zivid::Settings2D::acquisitions ( )
inline

Get Acquisitions.

◆ acquisitions() [2/2]

const Acquisitions & Zivid::Settings2D::acquisitions ( ) const
inline

Get Acquisitions.

◆ copyWith()

template<typename... Args>
Settings2D Zivid::Settings2D::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 Settings2D 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 Settings2D. These types can be provided:

◆ diagnostics() [1/2]

Diagnostics & Zivid::Settings2D::diagnostics ( )
inline

Get Diagnostics.

◆ diagnostics() [2/2]

const Diagnostics & Zivid::Settings2D::diagnostics ( ) const
inline

Get Diagnostics.

◆ forEach() [1/2]

template<typename F>
void Zivid::Settings2D::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::Settings2D::forEach ( const F & f) const
inline

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

◆ fromSerialized()

Settings2D Zivid::Settings2D::fromSerialized ( const std::string & value)
staticnodiscard

Construct a new Settings2D instance from a previously serialized string.

See also serialize.

◆ get() [1/22]

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

◆ get() [2/22]

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

◆ get() [3/22]

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

◆ get() [4/22]

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

◆ get() [5/22]

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

◆ get() [6/22]

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

◆ get() [7/22]

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

◆ get() [8/22]

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

◆ get() [9/22]

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

◆ get() [10/22]

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

◆ get() [11/22]

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

◆ get() [12/22]

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

◆ get() [13/22]

template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling >::value, int >::type = 0>
const Settings2D::Sampling & Zivid::Settings2D::get ( ) const
inline

◆ get() [14/22]

template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Color >::value, int >::type = 0>
const Settings2D::Sampling::Color & Zivid::Settings2D::get ( ) const
inline

◆ get() [15/22]

template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Interval >::value, int >::type = 0>
const Settings2D::Sampling::Interval & Zivid::Settings2D::get ( ) const
inline

◆ get() [16/22]

template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Interval::Duration >::value, int >::type = 0>
const Settings2D::Sampling::Interval::Duration & Zivid::Settings2D::get ( ) const
inline

◆ get() [17/22]

template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Interval::Enabled >::value, int >::type = 0>
const Settings2D::Sampling::Interval::Enabled & Zivid::Settings2D::get ( ) const
inline

◆ get() [18/22]

template<typename T, typename std::enable_if< std::is_same< T, Settings2D::Sampling::Pixel >::value, int >::type = 0>
const Settings2D::Sampling::Pixel & Zivid::Settings2D::get ( ) const
inline

◆ get() [19/22]

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

◆ get() [20/22]

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

◆ get() [21/22]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings2D::Processing & Zivid::Settings2D::get ( ) const
inline

◆ get() [22/22]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings2D::Sampling & Zivid::Settings2D::get ( ) const
inline

◆ load()

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

Load from the given file.

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ processing() [1/2]

Processing & Zivid::Settings2D::processing ( )
inline

Get Processing.

◆ processing() [2/2]

const Processing & Zivid::Settings2D::processing ( ) const
inline

Get Processing.

◆ sampling() [1/2]

Sampling & Zivid::Settings2D::sampling ( )
inline

Get Sampling.

◆ sampling() [2/2]

const Sampling & Zivid::Settings2D::sampling ( ) const
inline

Get Sampling.

◆ save()

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

Save to the given file.

◆ serialize()

std::string Zivid::Settings2D::serialize ( ) const

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

◆ set() [1/19]

template<typename... Args>
void Zivid::Settings2D::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 Settings2D. These types can be provided:

◆ set() [2/19]

Settings2D & Zivid::Settings2D::set ( const Acquisitions & value)
inline

Set Acquisitions.

◆ set() [3/19]

Settings2D & Zivid::Settings2D::set ( const Diagnostics & value)
inline

Set Diagnostics.

◆ set() [4/19]

Settings2D & Zivid::Settings2D::set ( const Diagnostics::Enabled & value)
inline

Set Diagnostics::Enabled.

◆ set() [5/19]

Settings2D & Zivid::Settings2D::set ( const Processing & value)
inline

Set Processing.

◆ set() [6/19]

Settings2D & Zivid::Settings2D::set ( const Processing::Color & value)
inline

Set Processing::Color.

◆ set() [7/19]

Settings2D & Zivid::Settings2D::set ( const Processing::Color::Balance & value)
inline

Set Processing::Color::Balance.

◆ set() [8/19]

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

Set Processing::Color::Balance::Blue.

◆ set() [9/19]

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

Set Processing::Color::Balance::Green.

◆ set() [10/19]

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

Set Processing::Color::Balance::Red.

◆ set() [11/19]

Settings2D & Zivid::Settings2D::set ( const Processing::Color::Experimental & value)
inline

Set Processing::Color::Experimental.

◆ set() [12/19]

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

Set Processing::Color::Experimental::Mode.

◆ set() [13/19]

Settings2D & Zivid::Settings2D::set ( const Processing::Color::Gamma & value)
inline

Set Processing::Color::Gamma.

◆ set() [14/19]

Settings2D & Zivid::Settings2D::set ( const Sampling & value)
inline

Set Sampling.

◆ set() [15/19]

Settings2D & Zivid::Settings2D::set ( const Sampling::Color & value)
inline

Set Sampling::Color.

◆ set() [16/19]

Settings2D & Zivid::Settings2D::set ( const Sampling::Interval & value)
inline

Set Sampling::Interval.

◆ set() [17/19]

Settings2D & Zivid::Settings2D::set ( const Sampling::Interval::Duration & value)
inline

Set Sampling::Interval::Duration.

◆ set() [18/19]

Settings2D & Zivid::Settings2D::set ( const Sampling::Interval::Enabled & value)
inline

Set Sampling::Interval::Enabled.

◆ set() [19/19]

Settings2D & Zivid::Settings2D::set ( const Sampling::Pixel & value)
inline

Set Sampling::Pixel.

◆ toString()

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

Get the value as string.

◆ DataModel::Detail::Befriend< Settings2D >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::Settings2D::description
staticconstexpr
Initial value:
{
R"description(Settings used when capturing 2D images with a Zivid camera.)description"
}

The description for this value.

◆ name

const char* Zivid::Settings2D::name { "Settings2D" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Settings2D::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

const char* Zivid::Settings2D::path { "" }
staticconstexpr

The full path for this value.

◆ version

size_t Zivid::Settings2D::version { 9 }
staticconstexpr
The documentation for this class was generated from the following file:
Generated by doxygen 1.14.0