Zivid::Settings::Sampling::Pixel Class Reference

Set whether the full image sensor should be used with white projector light or only specific color channels with corresponding projector light. Using only a specific color channel will subsample pixels and give a smaller resolution. More...

#include <Zivid/Settings.h>

Public Types
enum class	ValueType {   all , blueSubsample2x2 , redSubsample2x2 , blueSubsample4x4 ,   redSubsample4x4 }
	The type of the underlying value. More...

Public Member Functions
	Pixel ()=default
	Default constructor.
constexpr	Pixel (ValueType value)
	Constructor.
ValueType	value () const
	Get the value.
bool	hasValue () const
	Check if the value is set.
void	reset ()
	Reset the node to unset state.
std::string	toString () const
	Get the value as string.
bool	operator== (const Pixel &other) const
	Comparison operator.
bool	operator!= (const Pixel &other) const
	Comparison operator.

Static Public Member Functions
static std::set< ValueType >	validValues ()
	All valid values of Pixel.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Sampling/Pixel" }
	The full path for this value.
static constexpr const char *	name { "Pixel" }
	The name of this value.
static constexpr const char *	description
	The description for this value.
static const Pixel	all
	all
static const Pixel	blueSubsample2x2
	blueSubsample2x2
static const Pixel	redSubsample2x2
	redSubsample2x2
static const Pixel	blueSubsample4x4
	blueSubsample4x4
static const Pixel	redSubsample4x4
	redSubsample4x4

Friends
struct	DataModel::Detail::Befriend< Pixel >
std::ostream &	operator<< (std::ostream &stream, const Pixel::ValueType &value)
	Operator to serialize ValueType to a stream.
std::ostream &	operator<< (std::ostream &stream, const Pixel &value)
	Operator to serialize the value to a stream.

Detailed Description

Set whether the full image sensor should be used with white projector light or only specific color channels with corresponding projector light. Using only a specific color channel will subsample pixels and give a smaller resolution.

Subsampling decreases the capture time, as less data will be captured and processed. Picking a specific color channel can also help reduce noise and effects of ambient light. Projecting blue light will in most cases give better data than red light.

Member Enumeration Documentation

ValueType

enum class Zivid::Settings::Sampling::Pixel::ValueType

strong

The type of the underlying value.

Enumerator
all
blueSubsample2x2
redSubsample2x2
blueSubsample4x4
redSubsample4x4

Constructor & Destructor Documentation

Pixel() [1/2]

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

default

Default constructor.

Pixel() [2/2]

Zivid::Settings::Sampling::Pixel::Pixel ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::Settings::Sampling::Pixel::hasValue

(

)

const

Check if the value is set.

operator!=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

reset()

void Zivid::Settings::Sampling::Pixel::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::Settings::Sampling::Pixel::toString

(

)

const

Get the value as string.

validValues()

static std::set< ValueType > Zivid::Settings::Sampling::Pixel::validValues ( )

inlinestatic

All valid values of Pixel.

value()

ValueType Zivid::Settings::Sampling::Pixel::value

(

)

const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Pixel >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream.

operator<< [2/2]

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

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

all

const Pixel Zivid::Settings::Sampling::Pixel::all

static

all

blueSubsample2x2

const Pixel Zivid::Settings::Sampling::Pixel::blueSubsample2x2

static

blueSubsample2x2

blueSubsample4x4

const Pixel Zivid::Settings::Sampling::Pixel::blueSubsample4x4

static

blueSubsample4x4

description

const char* Zivid::Settings::Sampling::Pixel::description

staticconstexpr

Initial value:

{
                    R"description(Set whether the full image sensor should be used with white projector light or
only specific color channels with corresponding projector light.
Using only a specific color channel will subsample pixels and give a
smaller resolution.
 
Subsampling decreases the capture time, as less data will be captured and processed.
Picking a specific color channel can also help reduce noise and effects of ambient light.
Projecting blue light will in most cases give better data than red light.
)description"
                }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::Settings::Sampling::Pixel::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::Settings::Sampling::Pixel::path { "Sampling/Pixel" }

staticconstexpr

The full path for this value.

redSubsample2x2

const Pixel Zivid::Settings::Sampling::Pixel::redSubsample2x2

static

redSubsample2x2

redSubsample4x4

const Pixel Zivid::Settings::Sampling::Pixel::redSubsample4x4

static

redSubsample4x4

---

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

• Zivid/Settings.h