Zivid C++ API 2.13.1+18e79e79-1
|
Contrast distortion correction filter. More...
#include <Zivid/Settings.h>
Classes | |
class | Enabled |
Enable or disable contrast distortion correction. More... | |
class | Strength |
Strength of correction. Higher values give more correction. More... | |
Public Types | |
using | Descendants |
Public Member Functions | |
Correction () | |
Default constructor. | |
template<typename... Args> | |
Correction (Args &&...args) | |
Constructor taking variadic number of arguments. | |
template<typename... Args> | |
void | set (Args &&...args) |
Set multiple arguments. | |
template<typename... Args> | |
Correction | copyWith (Args &&...args) const |
Returns a copy of this object with the given argument(s) set to the new value(s) | |
const Enabled & | isEnabled () const |
Get Enabled. | |
Enabled & | isEnabled () |
Get Enabled. | |
Correction & | set (const Enabled &value) |
Set Enabled. | |
const Strength & | strength () const |
Get Strength. | |
Strength & | strength () |
Get Strength. | |
Correction & | set (const Strength &value) |
Set Strength. | |
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<size_t i, typename std::enable_if< i==0, int >::type = 0> | |
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Enabled & | get () const |
template<size_t i, typename std::enable_if< i==1, int >::type = 0> | |
const Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Strength & | 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 Correction &other) const |
Equality operator. | |
bool | operator!= (const Correction &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 |
The full path for this value. | |
static constexpr const char * | name { "Correction" } |
The name of this value. | |
static constexpr const char * | description |
The description for this value. | |
Friends | |
struct | DataModel::Detail::Befriend< Correction > |
std::ostream & | operator<< (std::ostream &stream, const Correction &value) |
Operator to send the value as string to a stream. | |
Contrast distortion correction filter.
using Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Descendants |
Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::Correction | ( | ) |
Default constructor.
|
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 Correction
then invoking set(args)
.
The provided arguments must be descendants of Correction
. These types can be provided:
|
inline |
Returns a copy of this object with the given argument(s) set to the new value(s)
Creates a copy of this Correction 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 Correction
. 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 |
|
inline |
Get Enabled.
|
inline |
Get Enabled.
bool Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::operator!= | ( | const Correction & | other | ) | const |
Inequality operator.
bool Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::operator== | ( | const Correction & | other | ) | const |
Equality operator.
|
inline |
Set multiple arguments.
The method invokes set(arg)
with each of the provided arguments.
The provided arguments must be descendants of Correction
. These types can be provided:
|
inline |
Set Enabled.
|
inline |
Set Strength.
|
inline |
Get Strength.
|
inline |
Get Strength.
std::string Zivid::Settings::Processing::Filters::Experimental::ContrastDistortion::Correction::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.