Zivid C++ API 2.14.0+e4a0c4a9-1
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Sampling Class Reference

Sampling settings. More...

#include <Zivid/Settings.h>

Classes

class  Color
 Choose how to sample colors for the point cloud. The rgb option gives a 2D image with full colors. The grayscale option gives a grayscale (r=g=b) 2D image, which can be acquired faster than full colors. The disabled option gives no colors and can allow for even faster captures. More...
 
class  Pixel
 For Zivid 2/2+, this setting controls whether to read out the full image sensor and use white projector light or to subsample pixels for specific color channels with corresponding projector light. Picking a specific color channel can help reduce noise and effects of ambient light - projecting blue light is recommended. More...
 

Public Types

using Descendants = std::tuple<Settings::Sampling::Color, Settings::Sampling::Pixel>
 

Public Member Functions

 Sampling ()
 Default constructor.
 
template<typename... Args>
 Sampling (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
Sampling copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
 
const Color & color () const
 Get Color.
 
Color & color ()
 Get Color.
 
Sampling & set (const Color &value)
 Set Color.
 
const Pixel & pixel () const
 Get Pixel.
 
Pixel & pixel ()
 Get Pixel.
 
Sampling & set (const Pixel &value)
 Set Pixel.
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Sampling::Color >::value, int >::type = 0>
const Settings::Sampling::Color & get () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Sampling::Pixel >::value, int >::type = 0>
const Settings::Sampling::Pixel & get () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Sampling::Color & get () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Sampling::Pixel & 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 Sampling &other) const
 Equality operator.
 
bool operator!= (const Sampling &other) const
 Inequality operator.
 
std::string toString () const
 Get the value as string.
 

Static Public Attributes

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

Friends

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

Detailed Description

Sampling settings.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings::Sampling::Descendants = std::tuple<Settings::Sampling::Color, Settings::Sampling::Pixel>

Constructor & Destructor Documentation

◆ Sampling() [1/2]

Zivid::Settings::Sampling::Sampling ( )

Default constructor.

◆ Sampling() [2/2]

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

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

Member Function Documentation

◆ color() [1/2]

Color & Zivid::Settings::Sampling::color ( )
inline

Get Color.

◆ color() [2/2]

const Color & Zivid::Settings::Sampling::color ( ) const
inline

Get Color.

◆ copyWith()

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

◆ forEach() [1/2]

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

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

◆ get() [1/4]

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

◆ get() [2/4]

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

◆ get() [3/4]

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

◆ get() [4/4]

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

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ pixel() [1/2]

Pixel & Zivid::Settings::Sampling::pixel ( )
inline

Get Pixel.

◆ pixel() [2/2]

const Pixel & Zivid::Settings::Sampling::pixel ( ) const
inline

Get Pixel.

◆ set() [1/3]

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

◆ set() [2/3]

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

Set Color.

◆ set() [3/3]

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

Set Pixel.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Sampling >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::Settings::Sampling::description
staticconstexpr
Initial value:
{ R"description(Sampling settings.
)description" }

The description for this value.

◆ name

const char* Zivid::Settings::Sampling::name { "Sampling" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Settings::Sampling::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

const char* Zivid::Settings::Sampling::path { "Sampling" }
staticconstexpr

The full path for this value.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0